Skip to content

Commit

Permalink
DOC: Expanded landing page documentation (#228)
Browse files Browse the repository at this point in the history
  • Loading branch information
itrharrison authored Jun 22, 2021
1 parent 39f5a2b commit 15e1ded
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@
SkyPy Documentation
###################

This package contains methods for modelling the Universe, galaxies and the Milky Way. Also included are methods for generating observed data.

This package contains methods for modelling the Universe, galaxies and the
Milky Way. SkyPy simulates populations of astronomical objects, generating
random realisations of intrinsic and observed properties, with the
intention the simulations can then be compared to data as part of an inference
pipeline.

.. Important:: If you use SkyPy for work presented in a publication or talk
please help the project via proper `citation or acknowledgement
<https://github.com/skypyproject/skypy/blob/main/CITATION.rst>`_.

.. _getting-started:

Expand Down

0 comments on commit 15e1ded

Please sign in to comment.