climpred

climpred: Verification of weather and climate forecasts - Published in JOSS (2021)

https://github.com/pangeo-data/climpred

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: joss.theoj.org, zenodo.org
✓
Committers with academic emails
5 of 12 committers (41.7%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (10.1%) to scientific vocabulary

Keywords

climate climate-analysis dask forecasting pangeo prediction python s2d s2s xarray

Keywords from Contributors

energy-systems exoplanet hydrology mesh scipy-stack ftp fatiando-a-terra download-manager polygon xclim

Last synced: 6 months ago · JSON representation ·

Repository

:earth_americas: Verification of weather and climate forecasts :earth_africa:

Basic Info

Host: GitHub
Owner: pangeo-data
License: mit
Language: Python
Default Branch: main
Homepage: https://climpred.readthedocs.io
Size: 58.2 MB

Statistics

Stars: 249
Watchers: 9
Forks: 48
Open Issues: 17
Releases: 10

Topics

climate climate-analysis dask forecasting pangeo prediction python s2d s2s xarray

Created over 8 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation

README.rst

.. image:: https://i.imgur.com/HPOdOsR.png

Verification of weather and climate forecasts

..
    Table version of badges inspired by pySTEPS.

.. list-table::
    :stub-columns: 1
    :widths: 10 90

    * - docs
      - |docs| |joss| |doi|
    * - tests
      - |ci| |upstream| |codecov| |precommit|
    * - package
      - |conda| |conda downloads| |pypi| |pypi downloads|
    * - license
      - |license|
    * - community
      - |gitter| |contributors| |forks| |stars| |issues| |PRs|
    * - tutorials
      - |gallery| |workshop| |cloud|

.. |docs| image:: https://img.shields.io/readthedocs/climpred/latest.svg?style=flat
    :target: https://climpred.readthedocs.io/en/stable/?badge=stable
    :alt: Documentation Status

.. |joss| image:: https://joss.theoj.org/papers/246d440e3fcb19025a3b0e56e1af54ef/status.svg
    :target: https://joss.theoj.org/papers/246d440e3fcb19025a3b0e56e1af54ef
    :alt: JOSS paper

.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4556085.svg
    :target: https://doi.org/10.5281/zenodo.4556085
    :alt: DOI

.. |ci| image:: https://github.com/pangeo-data/climpred/actions/workflows/climpred_testing.yml/badge.svg
    :target: https://github.com/pangeo-data/climpred/actions/workflows/climpred_testing.yml
    :alt: CI

.. |upstream| image:: https://github.com/pangeo-data/climpred/actions/workflows/upstream-dev-ci.yml/badge.svg
    :target: https://github.com/pangeo-data/climpred/actions/workflows/upstream-dev-ci.yml
    :alt: CI upstream

.. |codecov| image:: https://codecov.io/gh/pangeo-data/climpred/branch/main/graph/badge.svg
      :target: https://codecov.io/gh/pangeo-data/climpred
      :alt: coverage

.. |precommit| image:: https://results.pre-commit.ci/badge/github/pangeo-data/climpred/main.svg
   :target: https://results.pre-commit.ci/latest/github/pangeo-data/climpred/main
   :alt: pre-commit.ci status

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/climpred.svg
    :target: https://anaconda.org/conda-forge/climpred
    :alt: Conda Version

.. |pypi| image:: https://img.shields.io/pypi/v/climpred.svg
   :target: https://pypi.python.org/pypi/climpred/
   :alt: pypi Version

.. |license| image:: https://img.shields.io/github/license/pangeo-data/climpred.svg
    :alt: license
    :target: LICENSE.txt

.. |gitter| image:: https://badges.gitter.im/Join%20Chat.svg
    :target: https://gitter.im/climpred
    :alt: gitter chat

.. |contributors| image:: https://img.shields.io/github/contributors/pangeo-data/climpred
    :alt: GitHub contributors
    :target: https://github.com/pangeo-data/climpred/graphs/contributors

.. |conda downloads| image:: https://img.shields.io/conda/dn/conda-forge/climpred
    :alt: Conda downloads
    :target: https://anaconda.org/conda-forge/climpred

.. |pypi downloads| image:: https://pepy.tech/badge/climpred
    :alt: pypi downloads
    :target: https://pepy.tech/project/climpred

.. |gallery| image:: https://img.shields.io/badge/climpred-examples-ed7b0e.svg
    :alt: climpred gallery
    :target: https://mybinder.org/v2/gh/pangeo-data/climpred/main?urlpath=lab%2Ftree%2Fdocs%2Fsource%2Fquick-start.ipynb

.. |workshop| image:: https://img.shields.io/badge/climpred-workshop-f5a252
    :alt: climpred workshop
    :target: https://mybinder.org/v2/gh/bradyrx/climpred_workshop/master

.. |cloud| image:: https://img.shields.io/badge/climpred-cloud_demo-f9c99a
    :alt: climpred cloud demo
    :target: https://github.com/aaronspring/climpred-cloud-demo

.. |forks| image:: https://img.shields.io/github/forks/pangeo-data/climpred
    :alt: GitHub forks
    :target: https://github.com/pangeo-data/climpred/network/members

.. |stars| image:: https://img.shields.io/github/stars/pangeo-data/climpred
    :alt: GitHub stars
    :target: https://github.com/pangeo-data/climpred/stargazers

.. |issues| image:: https://img.shields.io/github/issues/pangeo-data/climpred
    :alt: GitHub issues
    :target: https://github.com/pangeo-data/climpred/issues

.. |PRs| image:: https://img.shields.io/github/issues-pr/pangeo-data/climpred
    :alt: GitHub PRs
    :target: https://github.com/pangeo-data/climpred/pulls

..


    We are actively looking for new contributors for climpred!
    `Riley `_ moved to McKinsey's
    Climate Analytics team as a climate software engineer.
    `Aaron `_ moved to XING as a data scientist.
    We especially hope for python enthusiasts from seasonal, subseasonal or weather
    prediction community. In our past coding journey, collaborative coding, feedbacking
    issues and pull requests advanced our code and thinking about forecast verification
    more than we could have ever expected.
    Feel free to implement your own new feature or take a look at the
    `good first issue `_
    tag in the issues. If you are interested in maintaining climpred, please ping us.

Installation
============

You can install the latest release of ``climpred`` using ``pip`` or ``conda``:

.. code-block:: bash

    python -m pip install climpred[complete]

.. code-block:: bash

    conda install -c conda-forge climpred

You can also install the bleeding edge (pre-release versions) by cloning this
repository or installing directly from GitHub:

.. code-block:: bash

    git clone https://github.com/pangeo-data/climpred.git
    cd climpred
    python -m pip install . --upgrade

.. code-block:: bash

    pip install git+https://github.com/pangeo-data/climpred.git


Documentation
=============

Documentation is in development and can be found on readthedocs_.

.. _readthedocs: https://climpred.readthedocs.io/en/latest/

Owner

Name: Pangeo
Login: pangeo-data
Kind: organization
Location: earth

Website: http://pangeo.io
Twitter: pangeo_data
Repositories: 54
Profile: https://github.com/pangeo-data

A community effort for big data geoscience

Citation (CITATION.cff)

# YAML 1.2
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/)
cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
# FIXME title as repository name might not be the best name, please make human readable
title: 'climpred: Verification of weather and climate forecasts'
doi: 10.5281/zenodo.4556085
# FIXME splitting of full names is error prone, please check if given/family name are correct
authors:
- given-names: Riley
  family-names: Brady
  affiliation: McKinsey & Company
  orcid: https://orcid.org/0000-0002-2309-8245
- given-names: Aaron
  family-names: Spring
  affiliation: Max-Planck-Institute for Meteorology
  orcid: https://orcid.org/0000-0003-0216-2241
- given-names: Andrew
  family-names: Huang
- given-names: Anderson
  family-names: Banihirwe
  affiliation: '@NCAR'
- given-names: Ray
  family-names: Bell
  affiliation: DTN
url: https://github.com/pangeo-data/climpred
license: MIT
preferred-citation:
  type: article
  authors:
  - given-names: Riley
    family-names: Brady
    affiliation: McKinsey & Company
    orcid: https://orcid.org/0000-0002-2309-8245
  - given-names: Aaron
    family-names: Spring
    affiliation: Max-Planck-Institute for Meteorology
    orcid: https://orcid.org/0000-0003-0216-2241
  doi: 10.21105/joss.02781
  journal: "Journal of Open Research Software"
  day: 2
  month: 3
  year: 2021
  title: "climpred: Verification of weather and climate forecasts"
  volume: 6
  issue: 59

GitHub Events

Total

Watch event: 15
Delete event: 1
Issue comment event: 8
Push event: 20
Pull request review event: 3
Pull request event: 5
Create event: 6

Last Year

Watch event: 15
Delete event: 1
Issue comment event: 8
Push event: 20
Pull request review event: 3
Pull request event: 5
Create event: 6

Committers

Last synced: 7 months ago

All Time

Total Commits: 950
Total Committers: 12
Avg Commits per committer: 79.167
Development Distribution Score (DDS): 0.497

Past Year

Commits: 70
Committers: 4
Avg Commits per committer: 17.5
Development Distribution Score (DDS): 0.414

Top Committers

Name	Email	Commits
Riley X. Brady	r**y@c**u	478
Aaron Spring	a****g	311
Trevor James Smith	1****e	41
AS	a**g@m**e	33
dependabot[bot]	4****]	31
pre-commit-ci[bot]	6****]	27
ahuang11	a**1@i**u	14
Kathy Pegion	k**n@g**u	4
Anderson Banihirwe	a**e@u**u	4
Ray Bell	r**0@g**m	4
Mathias Hauser	m****e	2
Trevor	c**s@g**m	1

Committer Domains (Top 20 + Academic)

ualr.edu: 1 gmu.edu: 1 illinois.edu: 1 mpimet.mpg.de: 1 colorado.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 354
Total pull requests: 503
Average time to close issues: 4 months
Average time to close pull requests: 8 days
Total issue authors: 24
Total pull request authors: 11
Average comments per issue: 3.4
Average comments per pull request: 3.57
Merged pull requests: 410
Bot issues: 4
Bot pull requests: 64

Past Year

Issues: 0
Pull requests: 9
Average time to close issues: N/A
Average time to close pull requests: about 22 hours
Issue authors: 0
Pull request authors: 4
Average comments per issue: 0
Average comments per pull request: 0.89
Merged pull requests: 3
Bot issues: 0
Bot pull requests: 5

View more stats

Top Authors

Issue Authors

aaronspring (168)
bradyrx (127)
ahuang11 (25)
Zeitsperre (4)
github-actions[bot] (4)
gmacgilchrist (3)
raybellwaves (3)
judithberner (2)
dougiesquire (2)
zmli-666 (2)
lukelbd (1)
brianpm (1)
andersy005 (1)
abkfenris (1)
Hongmei-Li (1)

Pull Request Authors

aaronspring (263)
bradyrx (143)
dependabot[bot] (38)
pre-commit-ci[bot] (32)
Zeitsperre (15)
ahuang11 (9)
raybellwaves (5)
andersy005 (4)
mathause (2)
kpegion (2)
threexc (1)

Top Labels

Issue Labels

feature request (77) bug (58) infrastructure (57) help wanted (46) low priority (45) cleanup (39) documentation (39) high priority (21) question (20) good first issue (18) ASP Projects (12) usability (11) performance (8) CI (5) testing (5) visualization (4) versioning (3) software engineering (3) example (2) dependencies (1)

Pull Request Labels

cleanup (57) feature request (54) dependencies (46) bug (36) infrastructure (32) documentation (32) github_actions (29) versioning (22) testing (18) don't merge (18) high priority (16) CI (11) low priority (11) usability (9) example (5) performance (4) run-benchmark (3) software engineering (2) visualization (2) ASP Projects (1) help wanted (1)

Packages

Total packages: 3
Total downloads:
- pypi 1,217 last-month
Total docker downloads: 11

Total dependent packages: 3
(may contain duplicates)
Total dependent repositories: 16
(may contain duplicates)
Total versions: 49
Total maintainers: 3

proxy.golang.org: github.com/pangeo-data/climpred

Documentation: https://pkg.go.dev/github.com/pangeo-data/climpred#section-documentation
License: mit
Latest release: v2.5.0+incompatible
published over 1 year ago

Versions: 17
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

pypi.org: climpred

"""Verification of weather and climate forecasts and prediction."""

Homepage: https://climpred.readthedocs.io/en/stable/
Documentation: https://climpred.readthedocs.io/
License: Copyright (c) 2018 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Latest release: 2.5.0
published over 1 year ago

Versions: 18
Dependent Packages: 1
Dependent Repositories: 2
Downloads: 1,217 Last month
Docker Downloads: 11

Rankings

Dependent packages count: 3.2%

Docker downloads count: 3.6%

Stargazers count: 4.8%

Forks count: 6.1%

Average: 6.5%

Downloads: 9.3%

Dependent repos count: 11.8%

Maintainers (3)

Zeitsperre aaronspring bradyrx

Last synced: 6 months ago

conda-forge.org: climpred

Homepage: http://github.com/pangeo-data/climpred
License: MIT
Latest release: 2.2.0
published about 4 years ago

Versions: 14
Dependent Packages: 2
Dependent Repositories: 14

Rankings

Dependent repos count: 9.3%

Dependent packages count: 19.6%

Average: 21.0%

Stargazers count: 26.8%

Forks count: 28.4%

Last synced: 6 months ago

Dependencies

.github/workflows/benchmarks.yml actions

actions/checkout v3 composite
actions/upload-artifact v3 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/climpred_installs.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
xarray-contrib/ci-trigger v1.2 composite

.github/workflows/climpred_testing.yml actions

actions/checkout v3 composite
codecov/codecov-action v3 composite
conda-incubator/setup-miniconda v2 composite
xarray-contrib/ci-trigger v1.2 composite

.github/workflows/comment_binder_pr_link.yml actions

mshick/add-pr-comment v1 composite

.github/workflows/python-publish.yml actions

actions/checkout v3 composite
actions/create-release v1 composite
actions/setup-python v4 composite

.github/workflows/upstream-dev-ci.yml actions

actions/checkout v3 composite
actions/download-artifact v3 composite
actions/github-script v6 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
mamba-org/provision-with-micromamba f347426e5745fe3dfc13ec5baf20496990d0281f composite
xarray-contrib/ci-trigger v1.2 composite

requirements.txt pypi

cf_xarray >=0.6.0
cftime >=1.5.0
dask >=2021.10.0
xarray >=0.19.0
xskillscore >=0.0.20

.binder/environment.yml conda

bias_correction >=0.4
cf_xarray >=0.6.0
cftime >=1.5.0
dask-core >=2021.10.0
esmpy
esmtools >=1.1.3
matplotlib-base
nc-time-axis >=1.4.0
netcdf4
pip
pydap
python >=3.9
toolz
xarray >=0.19.0
xclim !=0.30.0
xesmf
xrft
xskillscore >=0.0.20

pyproject.toml pypi

setup.py pypi