diff --git a/docs/pages/api.rst b/docs/pages/api.rst index 75a3dda..291d45a 100644 --- a/docs/pages/api.rst +++ b/docs/pages/api.rst @@ -1,13 +1,6 @@ API documentation ================= -Noise -------- - -.. automodule:: scope.noise - :members: - :undoc-members: - :show-inheritance: Broadening ----------- @@ -24,8 +17,8 @@ Fitting :undoc-members: :show-inheritance: -Obs simulator ------------------- +Utility functions +------------------- .. automodule:: scope.utils :members: @@ -46,6 +39,22 @@ Tellurics :undoc-members: :show-inheritance: +Noise +------------------ + +.. automodule:: scope.noise + :members: + :undoc-members: + :show-inheritance: + +R-M effect +------------------ + +.. automodule:: scope.rm_effect + :members: + :undoc-members: + :show-inheritance: + Cross-correlation ------------------ @@ -53,3 +62,39 @@ Cross-correlation :members: :undoc-members: :show-inheritance: + + +Running simulation +-------------------- + +.. automodule:: scope.run_simulation + :members: + :undoc-members: + :show-inheritance: + + +Calculating quantities +----------------------- + +.. automodule:: scope.calc_quantities + :members: + :undoc-members: + :show-inheritance: + + +Input / output +----------------------- + +.. automodule:: scope.input_output + :members: + :undoc-members: + :show-inheritance: + + +MCMC fitting +----------------------- + +.. automodule:: scope.emcee_fit_hires + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pages/installation.rst b/docs/pages/installation.rst index 87af6bc..b3ed0f6 100644 --- a/docs/pages/installation.rst +++ b/docs/pages/installation.rst @@ -12,10 +12,15 @@ All of the required dependencies will be installed automatically. Our current li (which will be pruned by v1.0.0) is: * https://github.com/numpy/numpy +* https://github.com/astropy/astropy * https://github.com/scipy/scipy +* https://github.com/pandas-dev/pandas * https://github.com/matplotlib/matplotlib +* https://github.com/adrn/schwimmbad * https://github.com/google/jax -* https://github.com/numpy/numpy +* https://github.com/numba/numba +* https://github.com/dfm/emcee +* https://github.com/pymc-devs/pymc * https://github.com/scikit-learn/scikit-learn * https://github.com/exoplanet-dev/exoplanet * https://github.com/tqdm/tqdm diff --git a/docs/pages/versioning.rst b/docs/pages/versioning.rst index 0e3a93c..c88b2a2 100644 --- a/docs/pages/versioning.rst +++ b/docs/pages/versioning.rst @@ -18,11 +18,5 @@ signifying the degree to which developers are confident in production-ready In practice ------------ This only applies to developers with write access to the code base. All that -needs to be done is: - -1. Adjust the version specified in :code:`src/scope/__init__.py`. This will - automatically update docs and :code:`setup.py` configurations. -2. Update the GitHub release version to match the version specified in Step 1. - -Ideally, we'd have a CI/CD pipeline that automatically makes a new release when the init -file is incremented. +needs to be done is make a new release on GitHub---the ``pyproject.toml`` file will automatically +read this information and update the package accordingly.