Skip to content

Commit b54dc75

Browse files
authored
Update Readme badges and instructions (#346)
1 parent edece58 commit b54dc75

File tree

1 file changed

+19
-61
lines changed

1 file changed

+19
-61
lines changed

README.rst

Lines changed: 19 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
SkyPy: A package for modelling the Universe
33
===========================================
44

5-
|Zenodo Badge| |Astropy Badge| |Test Status| |Coverage Status| |PyPI Status| |Anaconda Status| |Documentation Status|
5+
|PyPI| |conda-forge| |Read the Docs| |GitHub| |Codecov| |Zenodo|
66

77
This package contains methods for modelling the Universe, galaxies and the Milky
88
Way. Also included are methods for generating observed data.
@@ -43,35 +43,28 @@ To install using conda_:
4343
4444
$ conda install -c conda-forge skypy
4545
46-
You can test your SkyPy intallation using pytest_:
47-
48-
.. code:: bash
49-
50-
$ pytest --pyargs skypy
51-
5246
The SkyPy library can then be imported from python:
5347

5448
.. code:: python
5549
5650
>>> import skypy
57-
>>> help(skypy)
5851
5952
SkyPy has a number of optional dependencies which can be installed separately.
6053
One of these is `skypy-data`_ which contains data such as photometric bandpasses
6154
required for some calculations in SkyPy. This can be installed with:
6255

6356
.. code:: bash
64-
65-
pip install skypy-data@https://github.com/skypyproject/skypy-data/archive/master.tar.gz
57+
58+
$ pip install skypy-data@https://github.com/skypyproject/skypy-data/archive/master.tar.gz
6659
6760
SkyPy also has a driver script that can run simulation pipelines from the
6861
command line. The `skypyproject/examples`_ repository contains sample
6962
configuration files that you can clone and run:
7063

7164
.. code:: bash
7265
73-
git clone --depth 1 -b v$(skypy --version) https://github.com/skypyproject/examples.git
74-
skypy examples/mccl_galaxies.yml --format fits
66+
$ git clone --depth 1 -b v$(skypy --version) https://github.com/skypyproject/examples.git
67+
$ skypy examples/mccl_galaxies.yml --format fits
7568
7669
.. _PyPI: https://pypi.org/project/skypy/
7770
.. _conda-forge: https://anaconda.org/conda-forge/skypy
@@ -95,56 +88,21 @@ in the `Code of Conduct`_.
9588
.. _Contributor Guidelines: CONTRIBUTING.md
9689
.. _Code of Conduct: CODE_OF_CONDUCT.md
9790

98-
**Imposter syndrome disclaimer**: We want your help. No, really.
99-
100-
There may be a little voice inside your head that is telling you that you're not
101-
ready to be an open source contributor; that your skills aren't nearly good
102-
enough to contribute. What could you possibly offer a project like this one?
103-
104-
We assure you - the little voice in your head is wrong. If you can write code at
105-
all, you can contribute code to open source. Contributing to open source
106-
projects is a fantastic way to advance one's coding skills. Writing perfect code
107-
isn't the measure of a good developer (that would disqualify all of us!); it's
108-
trying to create something, making mistakes, and learning from those
109-
mistakes. That's how we all improve, and we are happy to help others learn.
110-
111-
Being an open source contributor doesn't just mean writing code, either. You can
112-
help out by writing documentation, tests, or even giving feedback about the
113-
project (and yes - that includes giving feedback about the contribution
114-
process). Some of these contributions may be the most valuable to the project as
115-
a whole, because you're coming to the project with fresh eyes, so you can see
116-
the errors and assumptions that seasoned contributors have glossed over.
117-
118-
Note: This disclaimer was originally written by
119-
`Adrienne Lowe <https://github.com/adriennefriend>`_ for a
120-
`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by
121-
SkyPy based on its use in the README file for the
122-
`MetPy project <https://github.com/Unidata/MetPy>`_.
123-
124-
.. |Zenodo Badge| image:: https://zenodo.org/badge/221432358.svg
125-
:target: https://zenodo.org/badge/latestdoi/221432358
126-
:alt: DOI of Latest SkyPy Release
127-
128-
.. |Astropy Badge| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
129-
:target: http://www.astropy.org
130-
:alt: Powered by Astropy Badge
131-
132-
.. |Test Status| image:: https://github.com/skypyproject/skypy/workflows/Tests/badge.svg
133-
:target: https://github.com/skypyproject/skypy/actions
134-
:alt: SkyPy's Test Status
135-
136-
.. |Coverage Status| image:: https://codecov.io/gh/skypyproject/skypy/branch/master/graph/badge.svg
137-
:target: https://codecov.io/gh/skypyproject/skypy
138-
:alt: SkyPy's Coverage Status
139-
140-
.. |PyPI Status| image:: https://img.shields.io/pypi/v/skypy.svg
91+
.. |PyPI| image:: https://img.shields.io/pypi/v/skypy?label=PyPI&logo=pypi
14192
:target: https://pypi.python.org/pypi/skypy
142-
:alt: SkyPy's PyPI Status
14393

144-
.. |Anaconda Status| image:: https://anaconda.org/conda-forge/skypy/badges/version.svg
94+
.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/skypy?logo=conda-forge
14595
:target: https://anaconda.org/conda-forge/skypy
146-
:alt: SkyPy's Anaconda Status
14796

148-
.. |Documentation Status| image:: https://readthedocs.org/projects/githubapps/badge/?version=latest
149-
:target: https://skypy.readthedocs.io/en/latest/?badge=latest
150-
:alt: Documentation Status
97+
.. |Read the Docs| image:: https://img.shields.io/readthedocs/skypy/stable?label=Docs&logo=read%20the%20docs
98+
:target: https://skypy.readthedocs.io/en/stable
99+
100+
.. |GitHub| image:: https://github.com/skypyproject/skypy/workflows/Tests/badge.svg
101+
:target: https://github.com/skypyproject/skypy/actions
102+
103+
.. |Codecov| image:: https://codecov.io/gh/skypyproject/skypy/branch/master/graph/badge.svg
104+
:target: https://codecov.io/gh/skypyproject/skypy
105+
106+
.. |Zenodo| image:: https://zenodo.org/badge/221432358.svg
107+
:target: https://zenodo.org/badge/latestdoi/221432358
108+
:alt: SkyPy Concept DOI

0 commit comments

Comments
 (0)