Installation


Version 1.7.5 for version 1.7 of the CF conventions.

Python versions

cfdm works for Python 2.7 and Python 3.

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.7.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 2.7 or 3 or newer,
  • numpy, version 1.15 or newer,
  • netCDF4, version 1.4.0 or newer, and
  • future, version 0.16.0 or newer.

Code repository


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