Installation


Version 1.8.9.0 for version 1.8 of the CF conventions.

Note

The latest version to be released and the newest versions available from the Python package index (PyPI) and conda are confirmed at the top of the README document.

Python versions

cfdm works for Python versions 3.6 or newer.


pip

To install cfdm and all of its dependencies run, for example:

Install as root, with any missing dependencies.
$ pip install cfdm
Install as a user, with any missing dependencies.
$ pip install cfdm --user

To install cfdm without any of its dependencies then run, for example:

Install as root without installing any of the dependencies.
$ pip install cfdm --no-deps

See the documentation for pip install for further options.


Source

To install from source:

  1. Download the cfdm package from https://pypi.org/project/cfdm

  2. Unpack the library (replacing <version> with the version that you want to install, e.g. 1.8.9.0):

    $ tar zxvf cfdm-<version>.tar.gz
    $ cd cfdm-<version>
    
  3. Install the package:

  • To install the cfdm package to a central location:

    $ python setup.py install
    
  • To install the cfdm package locally to the user in the default location:

    $ python setup.py install --user
    
  • To install the cfdm package in the <directory> of your choice:

    $ python setup.py install --home=<directory>
    

cfdump utility

During installation the cfdump command line utility is also installed, which generates text descriptions of the field constructs contained in a netCDF dataset.


Tests

Tests are run from within the cfdm/test directory:

$ python run_tests.py

Dependencies

The cfdm package requires:

  • Python, version 3.6 or newer, including the latest version Python 3.9,

  • numpy, version 1.15 or newer,

  • netCDF4, version 1.5.4 or newer,

  • cftime, version 1.5.0 or newer,

  • netcdf_flattener, version 1.2.0 or newer.

Note

Some dependencies have dropped support for Python 3.6 for their newer versions, so it may be necessary to use at least Python 3.7 in combination with those.

In particular, this is known to be the case if you are using numpy at version 1.20 or above.


Code repository

The source code is available at https://github.com/NCAS-CMS/cfdm