CliMT

A Toolkit for building Earth system models in Python.
https://github.com/climt/climt

Category: Climate Change
Sub Category: Earth and Climate Modeling

Keywords

atmospheric-modelling climate-model python

Keywords from Contributors

atmospheric-science

Last synced: about 17 hours ago
JSON representation

Repository metadata

The official home of climt, a Python based climate modelling toolkit.

• Host: GitHub
• URL: https://github.com/climt/climt
• Owner: CliMT
• License: other
• Created: 2016-11-26T22:32:37.000Z (over 8 years ago)
• Default Branch: develop
• Last Pushed: 2025-03-14T15:55:09.000Z (about 1 month ago)
• Last Synced: 2025-04-17T23:54:02.623Z (9 days ago)
• Topics: atmospheric-modelling, climate-model, python
• Language: Fortran
• Homepage: https://climt.readthedocs.io
• Size: 66.5 MB
• Stars: 170
• Watchers: 13
• Forks: 45
• Open Issues: 38
• Releases: 52
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

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 metadata

• Name: CliMT
• Login: CliMT
• Email:
• Kind: organization
• Description:
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/23116436?v=4
• Repositories: 2
• Last ynced at: 2023-08-04T20:10:27.580Z
• Profile URL: https://github.com/CliMT

---

GitHub Events

Total

• Release event: 4
• Watch event: 7
• Push event: 10
• Pull request event: 5
• Create event: 4

Last Year

• Release event: 4
• Watch event: 7
• Push event: 10
• Pull request event: 5
• Create event: 4

---

Committers metadata

Last synced: 7 days ago

Name	Email	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:

• wlan-su-10-201-19-192.local.su.se: 1
• mpimet.mpg.de: 1
• atmos.washington.edu: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/climt/climt

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 3,731 last-month
• Total dependent packages: 2 (may contain duplicates)
• Total dependent repositories: 2 (may contain duplicates)
• Total versions: 92
• Total maintainers: 2

---

Dependencies

Score: 15.961471781985173