climt

PyPI Continuous Integration Continuous Integration Coverage Documentation Status Zenodo DOI ./docs/climt_logo.jpg

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.

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.

History

v.0.17.0

  • Removed dycore to move it to independent package

v.0.16.15

  • Move to Github Actions tentatively finished!

v.0.16.11

  • New component BucketHydrology that implements Manabe first generation land model

  • BucketHydrology calculates the sensible and latent heat flux within the component

  • Conservation test for the component also added

  • Moving CI to Github Actions

v.0.16.8

  • Fix timeout for all MAC builds

v.0.16.6

  • Prevent MAC OS builds from timing out

v.0.16.5

  • Fix formatting errors which prevent pypi deployment

v.0.16.4

  • Fix MCICA for the shortwave component of RRTMG

  • Revise random number generation for MCICA

  • Improvement of the user interface to control MCICA

v.0.16.3

  • update numpy requirement to avoid binary incompatibility error

  • Fix error in documentation

v.0.16.2

  • Fix wheel build on Mac

v.0.16.1

  • Fixed issue with Mac build

  • Few changes in the dry convection component. Significantly improves the performance.

  • Changed logo!

  • Fixed failing docs build

v0.16.0

  • Added some documentation for using RRTMG with McICA

  • CI Testing for Mac and py37 added.

  • Refactored initialisation code

  • Enable the McICA version of RRTMG Longwave for consistency with the Shortwave component.

  • Fix bugs in IceSheet

  • Add tests to verify conservation of quantities

  • Fix bugs in initialisation

  • Fix energy conservation in surface flux scheme

  • Enable the McICA version of RRTMG Shortwave, so that partial cloud fractions can be used.

  • Add GMD example scripts to repository.

  • Fix docs to reflect API changes after refactor.

  • Fix wrong initialisation to use sigma values instead of pressure values of optical depth for GrayLongwaveRadiation

Breaking Changes

  • The flux outputs of GrayLongwaveRadiation have been renamed to eliminate on_interface_levels to keep consistency with other components.

  • All arrays are now 3/2d by default based on their expected dimensions.

  • horizontal dimensions are now lon, lat, but inputs used by components remain the same (latitude, longitude).

v.0.14.8

Many of the changes in this version come from changes in Sympl 0.4.0. We recommend reading those changes in the Sympl documentation.

  • Updated component APIs to work with Sympl 0.4.0

  • Many components which previously required horizontal dimensions now use wildcard matches for column dimensions.

  • Switched many print statements to logging calls.

  • Fixed bugs in some components

Breaking Changes

  • get_constant and set_constant have been removed, use the ones in Sympl.

  • Emanuel convection scheme can no longer be set to perform dry adiabatic adjustment to the boundary layer. This has been implemented in a separate component.

  • ClimtPrognostic, ClimtImplicitPrognostic, ClimtDiagnostic, ClimtImplicit have been removed. Use the base types in Sympl.

  • State initialization has been entirely re-worked. get_default_state now takes in an optional grid state instead of options to do with the state grid. A function get_grid is provided which can create a grid state, or one can be created manually. A grid state is a state containing air pressure and sigma on mid and interface levels, as well as surface pressure.

  • Replaced references to “thermal_capacity” with references to “heat_capacity” in component quantity names.

v.0.14.7

  • Fix issue with pip v10 and pandas 0.22 conflicts

v.0.14.3

  • Fix release issue because of pip API change

v.0.14.1

  • Fix appveyor fail due to pip changes

v.0.14.0

  • Fixed broken version numbers

v.0.12.0

  • new release to fix version numbers and create zenodo ID

v.0.9.4

  • Added attributes to inputs/outputs/ etc., to work with ScalingWrapper Added tests as well.

  • Added tests for constants functions

  • Fixed requirements to ensure this version of climt installs the correct versions of sympl and numpy.

v.0.9.3

  • Released because of a labelling issue. See 0.9.2 for details.

v.0.9.2

  • Updated documentation

  • Cleaned up examples

  • Added (*)_properties as a property to all components

  • The gas constant for dry air in the Emanuel scheme is now renamed _Rdair

  • RRTMG LW and SW are now OpenMP parallel

  • Added Instellation component to calculate zenith angle

  • Added tests to increase coverage

  • New constants handling functionality added

  • Travis builds now use stages

  • Appveyor CI up and running

  • Pre-installation of cython and numpy no longer necessary for source builds

  • Added snow-ice component

  • Ozone profiles do not need to be specified externally

  • Now also tested on Python 3.6

Breaking Changes

  • API for constants setting changed to set_constant_from_dict and add_constants_from_dict

  • GfsDynamicalCore renamed to GFSDynamicalCore for consistency

  • get_prognostic_version method of ClimtImplicit renamed to prognostic_version, and no longer accepts timestep as an argument. The current timestep should be set in ClimtImplicit.current_time_step during each iteration.

  • RRTMGShortwave now uses sympl’s solar constant by default instead of from fortran.

v.0.9.1

  • Held-Suarez and moist GCM with grey radiation work!

  • Added DCMIP initial conditions, test 4 tried out.

  • Dynamical core integrated now.

  • BIG change in the build system. Tests pass on Mac as well

  • Arrays can now have arbitrary dtype (to use qualitative, string, quantities)

  • Added Emanuel Convection, surface energy balance model and ice sheet energy balance

  • 2D coordinates are now supported for horizontal coordinates

  • Replaced create_output_arrays() with a more general get_state_dict_for() and get_numpy_arrays_from_state() combination.

  • State arrays now have coordinates

  • Updated documentation

  • RTD finally working, phew!

  • Added RRTMG Longwave, Simple Physics

  • Added helper functions to reduce boilerplate code in components

Breaking Changes

Latest

  • method to obtain piecewise constant prognostic has been renamed to piecewise_constant_version

  • Ozone profile has been modified

  • Heating rate for RRTMG top-of-atmosphere is no longer manually set to zero

  • Components no longer accept constants during initialisation. All constant handling is done internally.

v.0.9

  • SlabSurface no longer uses depth_slab_surface as input

  • changed order of outputs of GfsDynamicalCore and SimplePhysics to conform to TimeStepper order of diagnostics, new_state

  • get_default_state now accepts mid_levels and interface_levels instead of z to specify vertical coordinates.

  • mass_to_volume_mixing_ratio now uses numpy arrays instead of DataArrays.

Project links

Data verified by PyPI on Mar 4, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.31.0)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for joy.merwin from gravatar.com joy.merwin Avatar for Twine from gravatar.com Twine

Credits

Author: Rodrigo Caballero

GitHub Statistics

Data verified by PyPI on Mar 4, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD License (BSD license)

Tags

climt

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

climt-0.18.5-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

climt-0.18.5-cp312-cp312-macosx_15_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.12macOS 15.0+ ARM64

climt-0.18.5-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

climt-0.18.5-cp311-cp311-macosx_15_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.11macOS 15.0+ ARM64

climt-0.18.5-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

climt-0.18.5-cp310-cp310-macosx_15_0_arm64.whl (7.2 MB view details)

Uploaded CPython 3.10macOS 15.0+ ARM64

climt-0.18.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (7.6 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

climt-0.18.5-cp39-cp39-macosx_15_0_arm64.whl (7.2 MB view details)

Uploaded CPython 3.9macOS 15.0+ ARM64

File details

Details for the file climt-0.18.5-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for climt-0.18.5-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 aad3b939c3aa4cd028f8b197b5e18e7654410dc88115f99cd5fb4ad0d840421a
MD5 7506f8f49b67d1983048534a21994f51
BLAKE2b-256 23450c544c725ebbd1a724ca232c486e5b162b651e6a85e324f328306be4693f

See more details on using hashes here.

Provenance

The following attestation bundles were made for climt-0.18.5-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release_climt.yml on CliMT/climt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file climt-0.18.5-cp312-cp312-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for climt-0.18.5-cp312-cp312-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 bd2fe9d7ce514cef656265d8fb85bc5733555e9de21c06af48aa4d251da54c12
MD5 853285c414588e4189fe1c8d430589be
BLAKE2b-256 e3e5f4f468f56ace9665bfbe6517c802ec0859e459bb7e2ba8ce2cf2e6b3a488

See more details on using hashes here.

Provenance

The following attestation bundles were made for climt-0.18.5-cp312-cp312-macosx_15_0_arm64.whl:

Publisher: release_climt.yml on CliMT/climt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file climt-0.18.5-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for climt-0.18.5-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 35515b474bd5fe728b05869a3f450e15307fa315cb9b977eb9a3c62133edcadb
MD5 1c054a91f0f30727fdb67b3d7264dbce
BLAKE2b-256 40c4efc185533e8f36d788270c28d2f8c31ea339ece98affeaff7e7084e7ecd5

See more details on using hashes here.

Provenance

The following attestation bundles were made for climt-0.18.5-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release_climt.yml on CliMT/climt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file climt-0.18.5-cp311-cp311-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for climt-0.18.5-cp311-cp311-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 695c1b42060a9d9263115a50fdb88c40591416587c4e736f40a9ab183ba8f34f
MD5 88571a8b0fa8cbfdba6bea3975de99b1
BLAKE2b-256 c39326bad4ebe139ba895929b7d477fe8b37598a01fa637e7e5391056e3a5190

See more details on using hashes here.

Provenance

The following attestation bundles were made for climt-0.18.5-cp311-cp311-macosx_15_0_arm64.whl:

Publisher: release_climt.yml on CliMT/climt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file climt-0.18.5-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for climt-0.18.5-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 b233073439fde00c5d60cee965c0ecddacc2dec6ea35ebdc6e8d37b9c1276d9f
MD5 2f2fed077560f3ba18ed7ec9312a1d61
BLAKE2b-256 4ad6df8b62859d5bdad1692a25af1eec996674974063c165f211756f6c585c6e

See more details on using hashes here.

Provenance

The following attestation bundles were made for climt-0.18.5-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release_climt.yml on CliMT/climt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file climt-0.18.5-cp310-cp310-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for climt-0.18.5-cp310-cp310-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 308125d9f4578e73fc798c801d8f7ef9c83dfd6eed592208ea7f0d045f2e9f9d
MD5 09214018cc53a7a6da9c3a0211fec4da
BLAKE2b-256 5750fbf2abb3a0f98c5a672b60bed90cc60de58f0ab895bfe911905b5c73d057

See more details on using hashes here.

Provenance

The following attestation bundles were made for climt-0.18.5-cp310-cp310-macosx_15_0_arm64.whl:

Publisher: release_climt.yml on CliMT/climt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file climt-0.18.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for climt-0.18.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 4dd807f7c071633e03caa269eb704d39a37c840cf12450ca6326d9a39967d374
MD5 d396ed039fcefc283f3d18e212ffc59d
BLAKE2b-256 9ff7c30acd62c5e858017b61b957a9a200029745b06bf04a2c19283e2d667710

See more details on using hashes here.

Provenance

The following attestation bundles were made for climt-0.18.5-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release_climt.yml on CliMT/climt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file climt-0.18.5-cp39-cp39-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for climt-0.18.5-cp39-cp39-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 793fa2a72a82ba1754b092252aa4a63664dfc5752cda970f893a24ce6f46469b
MD5 a980b6feb858c80f6164f146d0b7bc8c
BLAKE2b-256 071e901bee0f34ab490059df205fc3b704a9b30803450c2da875e9b82304ece9

See more details on using hashes here.

Provenance

The following attestation bundles were made for climt-0.18.5-cp39-cp39-macosx_15_0_arm64.whl:

Publisher: release_climt.yml on CliMT/climt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.31.0

7 files

0.30.0

7 files

0.20.0

6 files

This release

0.18.5 This release

8 files

0.18.4

8 files

0.18.3

12 files

0.17.13

4 files

0.17.12

6 files

0.17.10

6 files

0.17.6

4 files

0.17.5

7 files

0.16.25

10 files

0.16.24

2 files

0.16.23

4 files

0.16.14

6 files

0.16.13

1 file

0.16.9

10 files

0.16.5

3 files

0.16.3

10 files

0.16.2

10 files

0.16.1

8 files

0.16.0

10 files

0.15.3

7 files

0.15.2

7 files

0.15.1

7 files

0.15.0

1 file

0.14.8

7 files

0.14.7

8 files

0.14.6

1 file

0.14.5

3 files

0.14.4

6 files

0.14.2

3 files

0.14.1

3 files

0.14.0

1 file

0.11.0

8 files

0.10.0

7 files

0.9.4

7 files

0.9.3

8 files

0.9.1

1 file

0.9.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page