Installation

Stable release

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

You can install climt by simply typing

$ pip install climt

This is the preferred method to install climt, as it will always install the most recent stable release. On Ubuntu Linux, you might need to prefix the above command with sudo. On Mac, it is recommended to use the anaconda python distribution to make installation simpler.

Which wheel you get

climt ships two kinds of wheel, and pip picks the more specific one that fits your platform:

Compiled wheels — Linux (x86_64) and macOS (Apple silicon), for CPython 3.10–3.12. These include the Fortran-backed components (RRTMG, Emanuel convection, the GFS-derived dynamics helpers and so on), so everything works.
A pure-Python wheel (py3-none-any) — everywhere else, including Windows, Intel Macs, Linux on ARM, and newer Python versions. It carries no compiled extensions, so components that need Fortran raise a clear error when you try to use them. Everything else works, including the CORK correlated-k radiation scheme.

To check at runtime:

import climt
climt.has_fortran_extensions()   # False on the pure-Python wheel

Windows is not tested

climt no longer builds or tests Windows binaries. Windows users get the pure-Python wheel above, which installs without a compiler but has no Fortran components. Building from source on Windows may still work but is unsupported — if you need the compiled components there, the Windows Subsystem for Linux is the recommended route.

Note

If you are not using Anaconda, please ensure you have the libpython library installed. See the next section for instructions to install libpython.

Since by default pip attempts to install a binary wheel, you won’t need a compiler on your system.

If you don’t have pip installed, this Python installation guide can guide you through the process.

Installing from source

The sources for climt can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/CliMT/climt

Or download the tarball:

$ curl  -OL https://github.com/CliMT/climt/tarball/master

Once you have a copy of the source, you can install it with:

$ pip install -r requirements_dev.txt
$ python setup.py install

Both commands may require the use of sudo.

Dependencies for source installations

climt depends on some easily installable libraries. For an installation from source, it also requires that C and fortran compilers be installed.

On Ubuntu Linux, for example, these dependencies can be installed by:

$ sudo apt-get install gcc
$ sudo apt-get install gfortran
$ sudo apt-get install python-dev
$ sudo pip install -U cython
$ sudo pip install -U numpy

use pip3 and python3-dev if you use Python 3.

On Mac OSX, it is recommended that you use anaconda as your python distribution. This will eliminate the need to install cython, numpy and python-dev. Once you have anaconda installed, you will need to do the following:

$ brew install gcc
$ export CC=gcc-x
$ export FC=gfortran-x

Where gcc-x,gfortran-x are the names of the C,Fortran compilers that Homebrew installs. Exporting the name of the compiler is essential on Mac since the default compiler that ships with Mac (called gcc, but is actually a different compiler) cannot compile OpenMP programs, like the dynamical core in climt.

--- title: "Installation" --- ## Stable release ::: {.callout-note} The GFS dynamical core has been made into a seperate package called [gfs_dynamical_core](https://github.com/Ai33L/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. ``` console $ pip install gfs_dynamical_core ``` You can install climt by simply typing ``` console $ pip install climt ``` This is the preferred method to install climt, as it will always install the most recent stable release. On Ubuntu Linux, you might need to prefix the above command with `sudo`. On Mac, it is recommended to use the [anaconda](https://www.continuum.io/downloads) python distribution to make installation simpler. ### Which wheel you get climt ships two kinds of wheel, and pip picks the more specific one that fits your platform: - **Compiled wheels** — Linux (x86_64) and macOS (Apple silicon), for CPython 3.10–3.12. These include the Fortran-backed components (RRTMG, Emanuel convection, the GFS-derived dynamics helpers and so on), so everything works. - **A pure-Python wheel** (`py3-none-any`) — everywhere else, including **Windows**, Intel Macs, Linux on ARM, and newer Python versions. It carries no compiled extensions, so components that need Fortran raise a clear error when you try to use them. Everything else works, including the CORK correlated-k radiation scheme. To check at runtime: ``` python import climt climt.has_fortran_extensions() # False on the pure-Python wheel ``` ::: {.callout-note} ## Windows is not tested climt no longer builds or tests Windows binaries. Windows users get the pure-Python wheel above, which installs without a compiler but has no Fortran components. Building from source on Windows may still work but is unsupported — if you need the compiled components there, the [Windows Subsystem for Linux](https://learn.microsoft.com/windows/wsl/) is the recommended route. ::: ::: {.callout-note} If you are not using Anaconda, please ensure you have the libpython library installed. See the next section for instructions to install libpython. ::: Since by default pip attempts to install a binary wheel, you won't need a compiler on your system. If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process. ## Installing from source The sources for climt can be downloaded from the [Github repo](https://github.com/climt/climt). You can either clone the public repository: ``` console $ git clone git://github.com/CliMT/climt ``` Or download the [tarball](https://github.com/CliMT/climt/tarball/master): ``` console $ curl -OL https://github.com/CliMT/climt/tarball/master ``` Once you have a copy of the source, you can install it with: ``` console $ pip install -r requirements_dev.txt $ python setup.py install ``` Both commands may require the use of `sudo`. ### Dependencies for source installations climt depends on some easily installable libraries. For an installation from source, it also requires that C and fortran compilers be installed. On Ubuntu Linux, for example, these dependencies can be installed by: ``` console $ sudo apt-get install gcc $ sudo apt-get install gfortran $ sudo apt-get install python-dev $ sudo pip install -U cython $ sudo pip install -U numpy ``` use `pip3` and `python3-dev` if you use Python 3. On Mac OSX, it is recommended that you use [anaconda](https://www.continuum.io/downloads) as your python distribution. This will eliminate the need to install cython, numpy and python-dev. Once you have anaconda installed, you will need to do the following: ``` console $ brew install gcc $ export CC=gcc-x $ export FC=gfortran-x ``` Where `gcc-x,gfortran-x` are the names of the C,Fortran compilers that Homebrew installs. Exporting the name of the compiler is essential on Mac since the default compiler that ships with Mac (called `gcc`, but is actually a different compiler) cannot compile OpenMP programs, like the dynamical core in climt.