Metadata-Version: 2.1
Name: cf-python
Version: 3.14.0b3
Summary: A CF-compliant earth science data analysis library
Home-page: https://ncas-cms.github.io/cf-python
Author: David Hassell
Author-email: david.hassell@ncas.ac.uk
Maintainer: David Hassell
Maintainer-email: david.hassell@ncas.ac.uk
License: MIT
Description: 
        CF Python
        =========
        
        The Python cf package is an Earth science data analysis library that
        is built on a complete implementation of the CF data model
        
        
        Documentation
        =============
        
        http://ncas-cms.github.io/cf-python
        
        Tutorial
        ========
        
        https://ncas-cms.github.io/cf-python/tutorial
        
        Installation
        ============
        
        http://ncas-cms.github.io/cf-python/installation
        
        
        Functionality
        =============
        
        The `cf` package implements the CF data model
        (https://doi.org/10.5194/gmd-10-4619-2017) for its internal data
        structures and so is able to process any CF-compliant dataset. It is
        not strict about CF-compliance, however, so that partially conformant
        datasets may be ingested from existing datasets and written to new
        datasets. This is so that datasets which are partially conformant may
        nonetheless be modified in memory.
        
        The `cf` package can:
        
        * read field constructs and domain constructs from netCDF, CDL, PP and
          UM datasets,
        
        * create new field and domain constructs in memory,
        
        * inspect field and domain constructs,
        
        * test whether two constructs are the same,
        
        * modify field and domain construct metadata and data,
        
        * create subspaces of field and domain constructs,
        
        * write and append field constructs to netCDF datasets on disk,
        
        * incorporate, and create, metadata stored in external files (*new in
          version 3.0.0*),
        
        * read, write, and create data that have been compressed by convention
          (i.e. ragged or gathered arrays), whilst presenting a view of the
          data in its uncompressed form,
        
        * read, write, and create coordinates defined by geometry cells,
        
        * read netCDF and CDL datasets containing hierarchical groups,
        
        * combine field constructs arithmetically,
        
        * manipulate field construct data by arithmetical and trigonometrical
          operations,
        
        * perform statistical collapses on field constructs,
        
        * perform histogram, percentile and binning operations on field
          constructs,
        
        * regrid field constructs with (multi-)linear, nearest neighbour,
          first- and second-order conservative and higher order patch recovery
          methods,
        
        * apply convolution filters to field constructs,
        
        * calculate derivatives of field constructs,
        
        * create field constructs to create derived quantities (such as
          vorticity).
        
        All of the above use LAMA functionality, which allows multiple fields
        larger than the available memory to exist and be manipulated. (Note:
        work is underway to replace this functionality with a `dask`
        implementation.)
        
        
        Visualization
        =============
        
        Powerful, flexible, and very simple to produce visualizations of field
        constructs are available with the `cfplot` package
        (http://ajheaps.github.io/cf-plot), that needs to be installed
        seprately to the `cf` package.
        
        See the `cfplot` gallery (http://ajheaps.github.io/cf-plot/gallery.html)
        for the full range range plotting possibilities with example code.
        
        
        Command line utilities
        ======================
        
        During installation the ``cfa`` command line utility is also
        installed, which
        
        * generates text descriptions of field constructs contained in files,
          and
        
        * creates new datasets aggregated from existing files.
        
        
        Tests
        =====
        
        Tests are run from within the ``cf/test`` directory:
        
            python run_tests.py
        
Keywords: cf,netcdf,UM,data,science,oceanography,meteorology,climate
Platform: Linux
Platform: MacOS
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Utilities
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Provides-Extra: required C libraries
Provides-Extra: regridding
Provides-Extra: convolution filters, derivatives, relative vorticity
Provides-Extra: subspacing with multi-dimensional construct cells
Provides-Extra: parallel processing
Provides-Extra: documentation
Provides-Extra: pre-commit hooks
