Minor code improvements (#87)

* Shorten docs

* Renames

csiborgtools/read/paths.py

@@ -66,7 +66,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if self._srcdir is None:
             raise ValueError("`srcdir` is not set!")
@@ -86,7 +86,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if self._borg_dir is None:
             raise ValueError("`borg_dir` is not set!")
@@ -106,7 +106,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if self._quijote_dir is None:
             raise ValueError("`quijote_dir` is not set!")
@@ -126,7 +126,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if self._postdir is None:
             raise ValueError("`postdir` is not set!")
@@ -146,7 +146,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         fpath = join(self.postdir, "temp")
         try_create_directory(fpath)
@@ -186,7 +186,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         return join(self.borg_dir, "mcmc", f"mcmc_{nsim}.h5")
 
@@ -231,7 +231,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if simname == "csiborg":
             fdir = join(self.postdir, "FoF_membership", )
@@ -258,7 +258,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         fdir = join(self.postdir, "mmain")
         try_create_directory(fdir)
@@ -281,7 +281,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         assert kind in ["particles", "fit"]
         ftype = "npy" if kind == "fit" else "h5"
@@ -353,7 +353,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if simname == "csiborg":
             fname = "ramses_out_{}"
@@ -411,7 +411,7 @@ class Paths:
 
         Returns
         -------
-        snappath : str
+        snapstr
         """
         simpath = self.snapshots(nsim, simname, tonew=nsnap == 1)
         if simname == "csiborg":
@@ -436,7 +436,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if simname == "csiborg":
             fdir = join(self.postdir, "particles")
@@ -464,7 +464,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if simname == "csiborg":
             fdir = join(self.postdir, "structfit")
@@ -497,7 +497,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         if simname == "csiborg":
             fdir = join(self.postdir, "overlap")
@@ -536,7 +536,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
 
         References
         ----------
@@ -581,7 +581,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         assert kind in ["density", "velocity", "potential", "radvel",
                         "environment"]
@@ -610,7 +610,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         fdir = join(self.postdir, "environment")
         try_create_directory(fdir)
@@ -634,7 +634,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         fdir = join(self.postdir, "HMF")
         try_create_directory(fdir)
@@ -664,7 +664,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         assert simname in ["csiborg", "quijote"]
         assert kind in ["dist", "bin_dist", "tot_counts"]
@@ -700,7 +700,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         assert simname in ["csiborg", "quijote"]
         fdir = join(self.postdir, "knn", "auto")
@@ -733,7 +733,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         fdir = join(self.postdir, "knn", "cross")
         try_create_directory(fdir)
@@ -764,7 +764,7 @@ class Paths:
 
         Returns
         -------
-        path : str
+        str
         """
         fdir = join(self.postdir, "tpcf", "auto")
         try_create_directory(fdir)

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":