Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #68

Merged
merged 3 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 54 additions & 9 deletions docs/pages/api.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
API documentation
=================

Noise
-------

.. automodule:: scope.noise
:members:
:undoc-members:
:show-inheritance:

Broadening
-----------
Expand All @@ -24,8 +17,8 @@ Fitting
:undoc-members:
:show-inheritance:

Obs simulator
------------------
Utility functions
-------------------

.. automodule:: scope.utils
:members:
Expand All @@ -46,10 +39,62 @@ 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
------------------

.. automodule:: scope.ccf
: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:
7 changes: 6 additions & 1 deletion docs/pages/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 2 additions & 8 deletions docs/pages/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading