Skip to content

Commit 15e1ded

Browse files
authored
DOC: Expanded landing page documentation (#228)
1 parent 39f5a2b commit 15e1ded

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/index.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44
SkyPy Documentation
55
###################
66

7-
This package contains methods for modelling the Universe, galaxies and the Milky Way. Also included are methods for generating observed data.
8-
7+
This package contains methods for modelling the Universe, galaxies and the
8+
Milky Way. SkyPy simulates populations of astronomical objects, generating
9+
random realisations of intrinsic and observed properties, with the
10+
intention the simulations can then be compared to data as part of an inference
11+
pipeline.
12+
13+
.. Important:: If you use SkyPy for work presented in a publication or talk
14+
please help the project via proper `citation or acknowledgement
15+
<https://github.com/skypyproject/skypy/blob/main/CITATION.rst>`_.
916

1017
.. _getting-started:
1118

0 commit comments

Comments
 (0)