Skip to content

Commit

Permalink
Move API ref section back down, rephrase a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
teutoburg committed Nov 25, 2024
1 parent 0ae083f commit abcb0f9
Showing 1 changed file with 19 additions and 22 deletions.
41 changes: 19 additions & 22 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,30 +42,12 @@ pip install scopesim_templates

ScopeSim Templates is a python package, and is therefore by nature infinitely extendable.

As it is impossible for us to know all the details about your specific science case, we provide a
small selection of basic objects (star cluster, elliptical galaxy, etc).
As it is impossible for us to know all the details about your specific science case, we provide a small selection of basic objects (star cluster, elliptical galaxy, etc).
A comprehensive list of those can be found below in the API reference (grouped into subpackages).
Feel free to start with these to get started with ScopeSim.

However if your needs outgrow the basic objects, we encourage you to extended the objects to fit your
specific science case. In this case **we strongly encourage you to get in contact with us adding your code
in the form of a subpackage**. You can do this either by opening an issue on Github, or by emailing one of the developers.

## Available subpackages

Documentation for all the helper functions contained in each package can be found in the API documentation for each package.

```{eval-rst}
.. autosummary::
:toctree: _autosummary
:template: custom-module-template.rst
:recursive:
:caption: Package Contents
scopesim_templates.stellar
scopesim_templates.extragalactic
scopesim_templates.calibration.calibration
scopesim_templates.misc.misc
```
However if your needs outgrow the basic objects, we encourage you to extended the objects to fit your specific science case. In this case **we strongly encourage you to get in contact with us adding your code in the form of a subpackage**.
You can do this either by opening an issue on Github, or by emailing one of the developers.

## Contact

Expand All @@ -82,3 +64,18 @@ notebooks/stellar.md
notebooks/extragalactic.md
source_object
```

## API reference

```{eval-rst}
.. autosummary::
:toctree: _autosummary
:template: custom-module-template.rst
:recursive:
:caption: Package Contents
scopesim_templates.stellar
scopesim_templates.extragalactic
scopesim_templates.calibration.calibration
scopesim_templates.misc.misc
```

0 comments on commit abcb0f9

Please sign in to comment.