Skip to content

Commit ca329e0

Browse files
committed
update README.rst with a badge table, typo fixes
1 parent 2d807a5 commit ca329e0

File tree

1 file changed

+57
-35
lines changed

1 file changed

+57
-35
lines changed

README.rst

Lines changed: 57 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,15 @@
11
xskillscore: Metrics for verifying forecasts
22
============================================
33

4-
.. image:: https://github.com/xarray-contrib/xskillscore/actions/workflows/xskillscore_testing.yml/badge.svg
5-
:target: https://github.com/xarray-contrib/xskillscore/actions/workflows/xskillscore_testing.yml
6-
7-
.. image:: https://github.com/xarray-contrib/xskillscore/actions/workflows/upstream-dev-ci.yml/badge.svg
8-
:target: https://github.com/xarray-contrib/xskillscore/actions/workflows/upstream-dev-ci.yml
9-
10-
.. image:: https://results.pre-commit.ci/badge/github/xarray-contrib/xskillscore/main.svg
11-
:target: https://results.pre-commit.ci/latest/github/xarray-contrib/xskillscore/main
12-
13-
.. image:: https://img.shields.io/pypi/v/xskillscore.svg
14-
:target: https://pypi.python.org/pypi/xskillscore/
15-
16-
.. image:: https://codecov.io/gh/xarray-contrib/xskillscore/branch/main/graph/badge.svg
17-
:target: https://codecov.io/gh/xarray-contrib/xskillscore
18-
19-
.. image:: https://img.shields.io/readthedocs/xskillscore/stable.svg?style=flat
20-
:target: https://xskillscore.readthedocs.io/en/stable/?badge=stable
21-
22-
.. image:: https://img.shields.io/conda/vn/conda-forge/xskillscore.svg
23-
:target: https://anaconda.org/conda-forge/xskillscore
24-
25-
.. image:: https://mybinder.org/badge_logo.svg
26-
:target: https://mybinder.org/v2/gh/raybellwaves/xskillscore-tutorial/master?urlpath=lab
27-
28-
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5173152.svg
29-
:target: https://doi.org/10.5281/zenodo.5173152
4+
+---------------------------+-------------------------------------------+
5+
| Documentation and Support | |docs| |binder| |
6+
+---------------------------+-------------------------------------------+
7+
| Open Source | |pypi| |conda-forge| |license| |zenodo| |
8+
+---------------------------+-------------------------------------------+
9+
| Coding Standards | |codecov| |pre-commit| |
10+
+---------------------------+-------------------------------------------+
11+
| Development Status | |status| |testing| |upstream| |
12+
+---------------------------+-------------------------------------------+
3013

3114
**xskillscore** is an open source project and Python package that provides verification
3215
metrics of deterministic (and probabilistic from `properscoring`) forecasts with `xarray`.
@@ -51,17 +34,56 @@ Documentation can be found on `readthedocs <https://xskillscore.readthedocs.io/e
5134
See also
5235
--------
5336

54-
- If you are interested in using **xskillscore** for data science where you data is mostly in
55-
``pandas.DataFrames``'s check out the `xskillscore-tutorial <https://github.com/raybellwaves/xskillscore-tutorial>`_
56-
- If you are interested in using **xskillscore** for climate prediction check out
57-
`climpred <https://climpred.readthedocs.io/en/stable/>`_.
37+
- If you are interested in using **xskillscore** for data science where you data is mostly in ``pandas.DataFrames``'s check out the `xskillscore-tutorial <https://github.com/raybellwaves/xskillscore-tutorial>`_.
38+
- If you are interested in using **xskillscore** for climate prediction check out `climpred <https://climpred.readthedocs.io/en/stable/>`_.
5839

5940
History
6041
-------
6142

62-
**xskillscore** was orginally developed to parallelize forecast metrics of the multi-model-multi-ensemble
63-
forecasts associated with the `SubX <https://journals.ametsoc.org/doi/pdf/10.1175/BAMS-D-18-0270.1>`_ project.
43+
**xskillscore** was originally developed to parallelize forecast metrics of the multi-model-multi-ensemble forecasts associated with the `SubX <https://journals.ametsoc.org/doi/pdf/10.1175/BAMS-D-18-0270.1>`_ project.
44+
45+
We are indebted to the **xarray** community for their `advice <https://groups.google.com/forum/#!searchin/xarray/xskillscore%7Csort:date/xarray/z8ue0G-BLc8/Cau-dY_ACAAJ>`_ in getting this package started.
46+
47+
.. |binder| image:: https://mybinder.org/badge_logo.svg
48+
:target: https://mybinder.org/v2/gh/raybellwaves/xskillscore-tutorial/master?urlpath=lab
49+
:alt: Binder
50+
51+
.. |codecov| image:: https://codecov.io/gh/xarray-contrib/xskillscore/branch/main/graph/badge.svg
52+
:target: https://codecov.io/gh/xarray-contrib/xskillscore
53+
:alt: Codecov
54+
55+
.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/xskillscore.svg
56+
:target: https://anaconda.org/conda-forge/xskillscore
57+
:alt: conda-forge
58+
59+
.. |docs| image:: https://img.shields.io/readthedocs/xskillscore/stable.svg?style=flat
60+
:target: https://xskillscore.readthedocs.io/en/stable/?badge=stable
61+
:alt: Documentation Status
62+
63+
.. |license| image:: https://img.shields.io/github/license/xarray-contrib/xncml.svg
64+
:target: https://github.com/xarray-contrib/xncml/blob/main/LICENSE
65+
:alt: License
66+
67+
.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/xarray-contrib/xskillscore/main.svg
68+
:target: https://results.pre-commit.ci/latest/github/xarray-contrib/xskillscore/main
69+
:alt: Pre-Commit
70+
71+
.. |pypi| image:: https://img.shields.io/pypi/v/xskillscore.svg
72+
:target: https://pypi.python.org/pypi/xskillscore/
73+
:alt: PyPI
74+
75+
.. |status| image:: https://www.repostatus.org/badges/latest/active.svg
76+
:target: https://www.repostatus.org/#active
77+
:alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
78+
79+
.. |testing| image:: https://github.com/xarray-contrib/xskillscore/actions/workflows/xskillscore_testing.yml/badge.svg
80+
:target: https://github.com/xarray-contrib/xskillscore/actions/workflows/xskillscore_testing.yml
81+
:alt: Testing
82+
83+
.. |upstream| image:: https://github.com/xarray-contrib/xskillscore/actions/workflows/upstream-dev-ci.yml/badge.svg
84+
:target: https://github.com/xarray-contrib/xskillscore/actions/workflows/upstream-dev-ci.yml
85+
:alt: Upstream Testing
6486

65-
We are indebted to the **xarray** community for their
66-
`advice <https://groups.google.com/forum/#!searchin/xarray/xskillscore%7Csort:date/xarray/z8ue0G-BLc8/Cau-dY_ACAAJ>`_
67-
in getting this package started.
87+
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5173152.svg
88+
:target: https://doi.org/10.5281/zenodo.5173152
89+
:alt: Zenodo DOI

0 commit comments

Comments
 (0)