cf.environment

cf.environment(display=True, paths=True)[source]

Return the names and versions of the cf package and its dependencies.

Parameters:
display: bool, optional

If False then return the description of the environment as a string. By default the description is printed.

paths: bool, optional

If False then do not output the locations of each package.

Added in version 3.0.6.

Returns:
None or str

If display is True then the description of the environment is printed and None is returned. Otherwise the description is returned as a string.

Examples

>>> cf.environment()
Platform: Linux-6.8.0-60-generic-x86_64-with-glibc2.39
Python: 3.12.8 /home/miniconda3/bin/python
packaging: 24.2 /home/miniconda3/lib/python3.12/site-packages/packaging/__init__.py
numpy: 2.2.6 /home/miniconda3/lib/python3.12/site-packages/numpy/__init__.py
cfdm.core: 1.12.2.0 /home/miniconda3/lib/python3.12/site-packages/cfdm/cfdm/core/__init__.py
udunits2 library: libudunits2.so.0
HDF5 library: 1.14.2
netcdf library: 4.9.4-development
netCDF4: 1.7.2 /home/miniconda3/lib/python3.12/site-packages/netCDF4/__init__.py
h5netcdf: 1.3.0 /home/miniconda3/lib/python3.12/site-packages/h5netcdf/__init__.py
h5py: 3.12.1 /home/miniconda3/lib/python3.12/site-packages/h5py/__init__.py
zarr: 3.0.8 /home/miniconda3/lib/python3.12/site-packages/zarr/__init__.py
s3fs: 2024.12.0 /home/miniconda3/lib/python3.12/site-packages/s3fs/__init__.py
scipy: 1.15.1 /home/miniconda3/lib/python3.12/site-packages/scipy/__init__.py
dask: 2025.5.1 /home/miniconda3/lib/python3.12/site-packages/dask/__init__.py
distributed: 2025.5.1 /home/miniconda3/lib/python3.12/site-packages/distributed/__init__.py
cftime: 1.6.4.post1 /home/miniconda3/lib/python3.12/site-packages/cftime/__init__.py
cfunits: 3.3.7 /home/miniconda3/lib/python3.12/site-packages/cfunits/__init__.py
cfdm: 1.12.2.0 /home/miniconda3/lib/python3.12/site-packages/cfdm/__init__.py
esmpy/ESMF: 8.7.0 /home/miniconda3/lib/python3.12/site-packages/esmpy/__init__.py
psutil: 6.1.1 /home/miniconda3/lib/python3.12/site-packages/psutil/__init__.py
matplotlib: 3.10.0 /home/miniconda3/lib/python3.12/site-packages/matplotlib/__init__.py
cfplot: 3.4.0 /home/miniconda3/lib/python3.12/site-packages/cfplot/__init__.py
cf: 3.18.0 /home/miniconda3/lib/python3.12/site-packages/cf/__init__.py

>>> cf.environment(paths=False)
Platform: Linux-6.8.0-60-generic-x86_64-with-glibc2.39
Python: 3.12.8
packaging: 24.2
numpy: 2.2.6
cfdm.core: 1.12.2.0
udunits2 library: libudunits2.so.0
HDF5 library: 1.14.2
netcdf library: 4.9.4-development
netCDF4: 1.7.2
h5netcdf: 1.3.0
h5py: 3.12.1
zarr: 3.0.8
s3fs: 2024.12.0
scipy: 1.15.1
dask: 2025.5.1
distributed: 2025.5.1
cftime: 1.6.4.post1
cfunits: 3.3.7
cfdm: 1.12.2.0
esmpy/ESMF: 8.7.0
psutil: 6.1.1
matplotlib: 3.10.0
cfplot: 3.4.0
cf: 3.18.0