minor doc improvements

ETSInitiative · Nov 9, 2024 · 3c8fe63 · 3c8fe63
1 parent fffdd66
commit 3c8fe63
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ generate an SDK for both C++ and Python to read/write PETSIRD data.
 
 ## To get started as a Python user:
 
-If you don't want to modify the yardl model, clone this repository and follow instructions in the [`python/README.md`](python/README.md).
+If you don't want to modify the yardl model, just `pip install petsird`. More detail is in the [`python/README.md`](python/README.md).
 
 ## To get started quickly as a developer:
 

diff --git a/python/petsird_generator.py b/python/petsird_generator.py
@@ -103,6 +103,7 @@ def get_scanner_geometry() -> petsird.ScannerGeometry:
 
 def get_detection_efficiencies(
     scanner: petsird.ScannerInformation, ) -> petsird.DetectionEfficiencies:
+    """return some (non-physical) detection efficiencies"""
     num_det_els = get_num_det_els(scanner.scanner_geometry)
     det_el_efficiencies = numpy.ones(
         (num_det_els, scanner.number_of_energy_bins()), dtype=numpy.float32)