-
Notifications
You must be signed in to change notification settings - Fork 0
Description
Still needs review:
@CarterDW : check naming of new terms
Done:
"Previously used for scaling relations, no longer required." --> XX
"List of calculations to prepare matrices for. Terms will be calculated as needed even without specifying them here, but pre-computing matrices can save time on the initial run of any function. ‘All’ or ‘everything’ will initialize all terms." --> XX
"The input k array must be strictly increasing, logarithmically spaced with consistent spacing, contain an even number of elements" --> XX
"result management" --> XX
"development installation" or "developer installation" - XX
"Using FAST-PT is straightforward. Here’s a simple example to get started:"
--> you should mention that it can be run with or without the handler, and say a sentence about what the handler is. - XX
Formatting is weird at the start of FASTPT class. Goes from bold to normal within a sentence. Is this expected? - XX
"FASTPT is a numerical algorithm to calculate
1-loop contributions to the matter power spectrum and other integrals of a similar type. The method is presented in papers arXiv:1603.04826 and arXiv:1609.05978 Please cite these papers if you are using FASTPT in your research."
--> shouldn't that be at the start of the docs, rather than in the FASTPT class? - XX (included in both homepage and FAST-PT class docstring
--> Should say more about how caching is done. - XX
P_linear = k**(-1.5) * 1000 # Example power spectrum
--> does this work? - XX (changed to use generate_power_spectra)
--> check that all docstring code works. - XX
Does init need a docstring? - XX, the information that would be included in an init doc string is included directly above in the class definition
stochastic bias --> nonlinear bias (everywhere sig4 appears) - XX
do_cache (bool, optional) – Whether to cache function results for repeated calls. Default is False. --> In most cases, the built-in FASTPT caching is sufficient. - XX, removed handler caching
Now P must be provided in each function call --> subsequent function call - XX
flip (bool, optional) – Whether to run each function at every power spectrum or every power spectrum at each function (Default is False, which runs each function at every power spectrum)
--> should that be there? - XX (removed)
Update Installation to mention dependencies. - XX
varrying each of the parameters --> varying each of the parameters individually - XX
Up to generate power spectra