Skip to main content

CliMT is a Toolkit for building Earth system models in Python.

Project description

CliMT

PyPI Continuous Integration Coverage Documentation Status

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

The documentation has installations to install CliMT.

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.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

Latest

  • Added snow-ice component

v.0.9

  • 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

  • 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 details


Download files

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

Files for climt, version 0.9.1
Filename, size File type Python version Upload date Hashes
Filename, size climt-0.9.1.tar.gz (20.9 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page