Minor code improvements (#87)

* Shorten docs

* Renames
This commit is contained in:
Richard Stiskalek 2023-08-31 09:57:53 +01:00 committed by GitHub
parent ae92fd9b72
commit 0af925e26a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 25 additions and 67 deletions

View file

@ -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 35923601, https://doi.org/10.1093/mnras/stac2407
"""
paths = csiborgtools.read.Paths(**csiborgtools.paths_glamdring)