climt
The official home of climt, a Python based climate modelling toolkit.
Science Score: 46.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
3 of 11 committers (27.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.1%) to scientific vocabulary
Keywords
atmospheric-modelling
climate-model
python
Keywords from Contributors
atmospheric-science
Last synced: 6 months ago
·
JSON representation
Repository
The official home of climt, a Python based climate modelling toolkit.
Basic Info
- Host: GitHub
- Owner: CliMT
- License: other
- Language: Fortran
- Default Branch: develop
- Homepage: https://climt.readthedocs.io
- Size: 66.5 MB
Statistics
- Stars: 178
- Watchers: 13
- Forks: 46
- Open Issues: 38
- Releases: 52
Topics
atmospheric-modelling
climate-model
python
Created over 9 years ago
· Last pushed 12 months ago
Metadata Files
Readme
Changelog
Contributing
License
Authors
README.rst
=====
climt
=====
.. image:: https://img.shields.io/pypi/v/climt.svg
:target: https://pypi.python.org/pypi/climt
:alt: PyPI
.. image:: https://img.shields.io/travis/climt/climt.svg
:target: https://travis-ci.org/climt/climt
:alt: Continuous Integration
.. image:: https://ci.appveyor.com/api/projects/status/h9ayx22cxyfwh5rh?svg=true
:target: https://ci.appveyor.com/project/JoyMonteiro/climt
:alt: Continuous Integration
.. image:: https://img.shields.io/codecov/c/github/climt/climt.svg
:target: https://travis-ci.org/climt/climt
:alt: Coverage
.. image:: https://readthedocs.org/projects/climt/badge/
:target: https://climt.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://zenodo.org/badge/74854230.svg
:target: https://zenodo.org/badge/latestdoi/74854230
:alt: Zenodo DOI
.. image:: ./docs/climt_logo.jpg
:height: 512px
:width: 512px
:align: center
**climt** is a Toolkit for building Earth system models in Python. climt stands for *Climate Modelling
and Diagnostics Toolkit* -- it is meant both for creating models and for generating diagnostics
(radiative fluxes for an atmospheric column, for example). However, since it might eventually
include model components for purposes other than climate modelling (local area models, large-eddy
simulation), we prefer to keep the abbreviation un-expanded!
climt hopes to enable researchers to easily perform online analysis and make
modifications to existing models by increasing the ease with which models
can be understood and modified. It also enables educators to write
accessible models that serve as an entry point for students into Earth
system modeling, while also containing state-of-the-art components.
Initially climt contains only components for the atmosphere, and does not yet
include a coupler. But there are plans to extend climt to a fully coupled Earth
system model in the future. The toolkit is also written in such a way that it
could enable the development of non-climate models (e.g. weather prediction,
large-eddy simulation). To do so requires only that the prognostic and
diagnostic schemes are wrapped into the correct Python-accessible interface.
climt builds on sympl_, which provides the base classes and array and constants handling
functionality. Thanks to sympl_ and Pint_, climt is also a fully units aware model. It is
useful to know how sympl_ works to use climt better. Read more about sympl_ at
https://sympl.readthedocs.io.
* Free software: BSD license
* Documentation: https://climt.readthedocs.io.
Installation
-------------
Note - The GFS dynamical core has been made into a seperate package called
gfs_dynamical_core_ for ease of maintenance. If you need the dynamical core,
please install this package from source or directly using pip. Doing this will
automatically install climt as well.
pip install gfs_dynamical_core
climt can be installed directly from the python package index using pip.
pip install climt
should work on most systems. From version 0.9.2 onwards, this command will
install binary wheels, eliminating the requirement of a compiler on your
system.
Detailed instructions for Mac and Linux systems are available in the `documentation`_.
Features
--------
* climt is fully units-aware!
* Uses the xarray_ `DataArray` abstraction to build self describing model arrays.
* Provides different levels of abstraction towards building a climate model.
* Like sympl_, climt consciously uses descriptive names in the user API to ensure
model scripts are self-documenting.
* Allows for quick prototyping of earth system model components.
* Provides a clean and convenient interface to add new components.
Citing climt
------------
If you use climt in your research, please cite the following paper documenting sympl_ and climt
https://www.geosci-model-dev.net/11/3781/2018/
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _sympl: https://github.com/mcgibbon/sympl
.. _Pint: https://pint.readthedocs.io
.. _xarray: http://xarray.pydata.org
.. _documentation: http://climt.readthedocs.io/en/latest/installation.html
.. _gfs_dynamical_core: https://github.com/Ai33L/gfs_dynamical_core
Owner
- Name: CliMT
- Login: CliMT
- Kind: organization
- Repositories: 2
- Profile: https://github.com/CliMT
GitHub Events
Total
- Release event: 4
- Watch event: 12
- Push event: 10
- Pull request event: 5
- Fork event: 1
- Create event: 4
Last Year
- Release event: 4
- Watch event: 12
- Push event: 10
- Pull request event: 5
- Fork event: 1
- Create event: 4
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Joy M. Monteiro | j****n@g****m | 967 |
| Jeremy McGibbon | m****n@a****u | 164 |
| Ai33L | a****0@g****m | 52 |
| SallyDa | s****e@g****m | 39 |
| monalivadje | 8****e | 34 |
| Jeremy McGibbon | e****2@g****m | 33 |
| Sergey Kosukhin | s****n@m****e | 9 |
| Lukas Kluft | l****t@g****m | 7 |
| suhasdl | s****e@g****m | 2 |
| Joy M M | j****m@w****e | 2 |
| Joy M M | j****m@J****l | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 104
- Total pull requests: 69
- Average time to close issues: 2 months
- Average time to close pull requests: 7 days
- Total issue authors: 29
- Total pull request authors: 11
- Average comments per issue: 4.5
- Average comments per pull request: 1.43
- Merged pull requests: 60
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: less than a minute
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- mcgibbon (43)
- JoyMonteiro (16)
- oculus99 (5)
- lkluft (5)
- HaynesStephens (4)
- edenau (3)
- musdfakoc (2)
- Strong-Curious (2)
- suhasdl (2)
- zylkowski (2)
- adominious (2)
- hankpete (1)
- edmundderby (1)
- SallyDa (1)
- monocongo (1)
Pull Request Authors
- JoyMonteiro (49)
- Ai33L (8)
- monalivadje (5)
- SallyDa (4)
- edeetee (2)
- lkluft (2)
- edmundderby (1)
- pyup-bot (1)
- suhasdl (1)
- diegojco (1)
- tenomoto (1)
Top Labels
Issue Labels
enhancement (15)
bug (3)
needs_documentation (3)
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 730 last-month
-
Total dependent packages: 2
(may contain duplicates) -
Total dependent repositories: 2
(may contain duplicates) - Total versions: 92
- Total maintainers: 2
pypi.org: climt
CliMT is a Toolkit for building Earth system models in Python.
- Homepage: https://github.com/CliMT/climt
- Documentation: https://climt.readthedocs.io/
- License: BSD license
-
Latest release: 0.17.13
published 12 months ago
Rankings
Dependent packages count: 3.2%
Stargazers count: 6.1%
Forks count: 6.4%
Average: 7.1%
Downloads: 8.2%
Dependent repos count: 11.8%
Maintainers (2)
Last synced:
6 months ago
proxy.golang.org: github.com/CliMT/climt
- Documentation: https://pkg.go.dev/github.com/CliMT/climt#section-documentation
- License: other
-
Latest release: v0.17.13
published 12 months ago
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced:
6 months ago
proxy.golang.org: github.com/climt/climt
- Documentation: https://pkg.go.dev/github.com/climt/climt#section-documentation
- License: other
-
Latest release: v0.17.13
published 12 months ago
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced:
6 months ago
Dependencies
requirements_dev.txt
pypi
- PyYAML >=3.11 development
- Sphinx >=1.5.1 development
- bumpversion >=0.5.3 development
- coverage >=4.1 development
- coveralls * development
- cryptography >=1.6 development
- cython >=0.25 development
- flake8 >=2.6.0 development
- ipython >=5.3.0 development
- mock >=2.0.0 development
- numpy >=1.16.0 development
- pip >=8.1.2 development
- pytest >=2.9.2 development
- pytest-cov >=2.4.0 development
- scipy >=0.18.1 development
- sympl ==0.4.0 development
- tox >=2.3.1 development
- watchdog >=0.8.3 development
- wheel >=0.29.0 development
- xarray >=0.8.2 development
.github/workflows/python-package.yml
actions
- actions/checkout v2 composite
- actions/setup-python v2 composite
.github/workflows/release_climt.yml
actions
- actions/checkout v2 composite
- actions/setup-python v2 composite
.github/workflows/release_climt_windows.yml
actions
- actions/checkout v2 composite
- conda-incubator/setup-miniconda v2 composite
.github/workflows/windows-package.yml
actions
- actions/checkout v2 composite
- conda-incubator/setup-miniconda v2 composite
climt/_lib/rrtmg_lw/setup.py
pypi
climt/_lib/rrtmg_sw/setup.py
pypi
setup.py
pypi