Skip to content

Commit 39f5a2b

Browse files
authored
DOC: Readme updates (#460)
1 parent b377ea0 commit 39f5a2b

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.rst

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,27 @@ SkyPy: A package for modelling the Universe
44

55
|Read the Docs| |GitHub| |Codecov|
66

7-
This package contains methods for modelling the Universe, galaxies and the Milky
8-
Way. Also included are methods for generating observed data.
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+
Currently, SkyPy implements the following modules:
914

1015
* Galaxies_: morphology, luminosity and redshift distributions
1116
* Pipelines_ to generate populations of astronomical objects
1217

13-
The full list of features can be found in the `SkyPy Documentation`_.
18+
The `full list of features`_ can be found in the `SkyPy Documentation`_.
19+
20+
For more information on the people involved and how SkyPy is developed, please
21+
visit the SkyPy Collaboration website: `http://skypyproject.org`_
1422

1523
.. _Galaxies: https://skypy.readthedocs.io/en/latest/galaxies.html
1624
.. _Pipelines: https://skypy.readthedocs.io/en/latest/pipeline/index.html
25+
.. _full list of features: https://skypy.readthedocs.io/en/latest/feature_list.html
1726
.. _SkyPy Documentation: https://skypy.readthedocs.io/en/latest/
18-
27+
.. _http://skypyproject.org: http://skypyproject.org
1928

2029
Citation
2130
--------
@@ -52,6 +61,16 @@ Examples_ that demonstrate how to use it.
5261
.. _Examples: https://skypy.readthedocs.io/en/stable/examples/index.html
5362

5463

64+
Get in Touch
65+
------------
66+
67+
You are welcome to talk about the SkyPy package and code using our
68+
`Discussions Page`_. For any other questions about the project in general,
69+
please get in touch with the `SkyPy Co-ordinators`_.
70+
71+
.. _Discussions Page: https://github.com/skypyproject/skypy/discussions
72+
.. _SkyPy Co-ordinators: mailto:skypy-coordinators@googlegroups.com
73+
5574
Contributing
5675
------------
5776

0 commit comments

Comments
 (0)