Updated ChiParam documentation

lamsoa729 · Dec 15, 2023 · 882a112 · 882a112
1 parent d0f7478
commit 882a112
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 10 deletions.
diff --git a/chi_pet/chi_node.py b/chi_pet/chi_node.py
@@ -159,8 +159,8 @@ def make_subnodes(self, overwrite: bool = False) -> None:
             # Set matched param values first
             for ind,  grp_lst in zip(ind_list[:num_grps],
                                      matched_grps.values()):
-                for mcp in grp_lst:
-                    mcp.set_value(ind)
+                for gcp in grp_lst:
+                    gcp.set_value(ind)
 
             # Set scanned params values second
             for ind, scp in zip(ind_list[num_grps:], scanned_params):

diff --git a/chi_pet/chi_param.py b/chi_pet/chi_param.py
@@ -74,24 +74,23 @@ def __init__(self, name: str,
                  param_grp: Optional[str] = None,
                  **kwargs):
         """Initialize a Chi parameter object.
-        TODO NDOCUMENT 
 
         Parameters
         ----------
         name : str
-            _description_
+            Name of the chi parameter used for identifying object in code.
         format_str : Optional[str], optional
-            _description_, by default None
+            String that will be modified and used to identify ChiNode directories, by default None
         exec_str : Optional[str], optional
-            _description_, by default None
+            String to be executed to generate variable values of parameter, by default None
         values : Optional[List], optional
-            _description_, by default None
+            Explicity given list of values to scan over for parameter, by default None
         level : int, optional
-            _description_, by default 0
+            Level in directory structure param will be varied, by default 0
         alg : str, optional
-            _description_, by default 'scan'
+            Algorithm to use in creating directory variations. Options = ['scan', 'match'], by default 'scan'
         param_grp : Optional[str], optional
-            _description_, by default None
+            For 'match' alg, what group of parameters to vary parameters with, by default None
         """
 
         self._name = name