Minor code improvements (#87)

* Shorten docs

* Renames

scripts/match_singlematch.py

@@ -28,14 +28,12 @@ import csiborgtools
 
 def pair_match_max(nsim0, nsimx, simname, min_logmass, mult, verbose):
     """
-    Match a pair of simulations using the method of [1].
+    Match a pair of simulations using the Max method.
 
     Parameters
     ----------
-    nsim0 : int
-        The reference simulation IC index.
-    nsimx : int
-        The cross simulation IC index.
+    nsim0, nsimx : int
+        The reference and cross simulation IC index.
     simname : str
         Simulation name.
     min_logmass : float
@@ -44,17 +42,6 @@ def pair_match_max(nsim0, nsimx, simname, min_logmass, mult, verbose):
         Multiplicative factor for search radius.
     verbose : bool
         Verbosity flag.
-
-    Returns
-    -------
-    None
-
-    References
-    ----------
-    [1] Maxwell L Hutt, Harry Desmond, Julien Devriendt, Adrianne Slyz; The
-    effect of local Universe constraints on halo abundance and clustering;
-    Monthly Notices of the Royal Astronomical Society, Volume 516, Issue 3,
-    November 2022, Pages 3592–3601, https://doi.org/10.1093/mnras/stac2407
     """
     paths = csiborgtools.read.Paths(**csiborgtools.paths_glamdring)
 

scripts/mv_fofmembership.py

@@ -42,13 +42,6 @@ def copy_membership(nsim, verbose=True):
     """
     Copy the FoF particle halo membership to the CSiBORG directory and write it
     as a NumPy array instead of a text file.
-
-    Parameters
-    ----------
-    nsim : int
-        IC realisation index.
-    verbose : bool, optional
-        Verbosity flag.
     """
     paths = csiborgtools.read.Paths(**csiborgtools.paths_glamdring)
     fpath = join("/mnt/extraspace/jeg/greenwhale/Constrained_Sims",

scripts/pre_dumppart.py

@@ -76,19 +76,6 @@ def main(nsim, simname, verbose):
     into a HDF5 file. Stores the first and last index of each halo in the
     particle array for fast slicing of the array to acces particles of a single
     halo.
-
-    Parameters
-    ----------
-    nsim : int
-        IC realisation index.
-    simname : str
-        Simulation name.
-    verbose : bool
-        Verbosity flag.
-
-    Returns
-    -------
-    None
     """
     paths = csiborgtools.read.Paths(**csiborgtools.paths_glamdring)
     if simname == "csiborg":

scripts/pre_sortinit.py

@@ -44,15 +44,6 @@ def _main(nsim, simname, verbose):
     """
     Sort the initial snapshot particles according to their final snapshot
     ordering and dump them into a HDF5 file.
-
-    Parameters
-    ----------
-    nsim : int
-        IC realisation index.
-    simname : str
-        Simulation name.
-    verbose : bool
-        Verbosity flag.
     """
     paths = csiborgtools.read.Paths(**csiborgtools.paths_glamdring)
     if simname == "csiborg":