cf-python

A CF-compliant Earth Science data analysis library.
https://github.com/ncas-cms/cf-python

cf cfdm cfunits data-analysis earth-science metadata netcdf pp python um

Last synced: about 11 hours ago
JSON representation

Repository metadata

A CF-compliant Earth Science data analysis library

• Host: GitHub
• URL: https://github.com/ncas-cms/cf-python
• Owner: NCAS-CMS
• License: mit
• Created: 2019-09-13T08:57:37.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T11:13:26.000Z (29 days ago)
• Last Synced: 2024-04-14T07:18:23.828Z (28 days ago)
• Topics: cf, cfdm, cfunits, data-analysis, earth-science, metadata, netcdf, pp, python, um
• Language: Python
• Homepage: http://ncas-cms.github.io/cf-python
• Size: 127 MB
• Stars: 92
• Watchers: 5
• Forks: 18
• Open Issues: 94
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

README

        
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.

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/NCAS-CMS/cf-python?color=000000&label=latest%20version)](https://ncas-cms.github.io/cf-python/Changelog.html)

[![PyPI](https://img.shields.io/pypi/v/cf-python?color=000000)](https://pypi.org/project/cf-python/)

[![Conda](https://img.shields.io/conda/v/conda-forge/cf-python?color=000000)](https://anaconda.org/conda-forge/cf-python)

[![Conda](https://img.shields.io/conda/pn/conda-forge/cf-python?color=2d8659)](https://ncas-cms.github.io/cf-python/installation.html#operating-systems)

[![Website](https://img.shields.io/website?color=2d8659&down_message=online&label=documentation&up_message=online&url=https%3A%2F%2Fncas-cms.github.io%2Fcf-python%2F)](https://ncas-cms.github.io/cf-python/index.html)

[![GitHub](https://img.shields.io/github/license/NCAS-CMS/cf-python?color=2d8659)](https://github.com/NCAS-CMS/cf-python/blob/main/LICENSE)

[![Codecov](https://img.shields.io/codecov/c/github/NCAS-CMS/cfdm?color=006666)](https://codecov.io/gh/NCAS-CMS/cfdm)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/NCAS-CMS/cfdm/run-test-suite.yml?branch=main?color=006666&label=test%20suite%20workflow)](https://github.com/NCAS-CMS/cfdm/actions)

[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu)

#### References

[![Website](https://img.shields.io/website?down_color=264d73&down_message=10.5281%2Fzenodo.3894533&label=DOI&up_color=264d73&up_message=10.5281%2Fzenodo.3894533&url=https%3A%2F%2Fdoi.org%2F10.5281%2Fzenodo.3894533)](https://doi.org/10.5281/zenodo.3894533)

[![Website](https://img.shields.io/website?down_color=264d73&down_message=10.5194%2Fgmd-10-4619-2017&label=GMD&up_color=264d73&up_message=10.5194%2Fgmd-10-4619-2017&url=https%3A%2F%2Fwww.geosci-model-dev.net%2F10%2F4619%2F2017%2F)](https://www.geosci-model-dev.net/10/4619/2017/)

[![Website](https://img.shields.io/website?down_color=264d73&down_message=10.21105%2Fjoss.02717&label=JOSS&up_color=264d73&up_message=10.21105%2Fjoss.02717&url=https:%2F%2Fjoss.theoj.org%2Fpapers%2F10.21105%2Fjoss.02717%2Fstatus.svg)](https://doi.org/10.21105/joss.02717)

Dask

====

From version 3.14.0 the `cf` package uses

[Dask](https://docs.dask.org) for all of its data manipulations.

Documentation

=============

http://ncas-cms.github.io/cf-python

Installation

============

http://ncas-cms.github.io/cf-python/installation.html

Cheat Sheet

===========

https://ncas-cms.github.io/cf-python/cheat_sheet.html

Recipes

=======

https://ncas-cms.github.io/cf-python/recipes

Tutorial

========

https://ncas-cms.github.io/cf-python/tutorial.html

Functionality

=============

The `cf` package implements the [CF data

model](https://cfconventions.org/cf-conventions/cf-conventions.html#appendix-CF-data-model)

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.

A simple example of reading a field construct from a file and

inspecting it:

    >>> import cf

    >>> f = cf.read('file.nc')

    >>> print(f[0])

    Field: air_temperature (ncvar%tas)

    ----------------------------------

    Data            : air_temperature(time(12), latitude(64), longitude(128)) K

    Cell methods    : time(12): mean (interval: 1.0 month)

    Dimension coords: time(12) = [1991-11-16 00:00:00, ..., 1991-10-16 12:00:00] noleap

                    : latitude(64) = [-87.8638, ..., 87.8638] degrees_north

                    : longitude(128) = [0.0, ..., 357.1875] degrees_east

                    : height(1) = [2.0] m

The `cf` package uses

[Dask](https://ncas-cms.github.io/cf-python/performance.html) for all

of its array manipulation and can:

* read field constructs from netCDF, CDL, PP and UM datasets,

* create new field constructs in memory,

* write and append field and domain constructs to netCDF datasets on disk,

* read, create, and manipulate UGRID mesh topologies,

* read, write, and create coordinates defined by geometry cells,

* read netCDF and CDL datasets containing hierarchical groups,

* inspect field constructs,

* test whether two field constructs are the same,

* modify field construct metadata and data,

* create subspaces of field constructs,

* write field constructs to netCDF datasets on disk,

* incorporate, and create, metadata stored in external files,

* read, write, and create data that have been compressed by convention

  (i.e. ragged or gathered arrays, or coordinate arrays compressed by

  subsampling), whilst presenting a view of the data in its

  uncompressed form,

* combine field constructs arithmetically,

* manipulate field construct data by arithmetical and trigonometrical

  operations,

* perform weighted statistical collapses on field constructs,

  including those with geometry cells and UGRID mesh topologies,

* perform histogram, percentile and binning operations on field

  constructs,

* regrid structured grid, mesh and DSG field constructs with

  (multi-)linear, nearest neighbour, first- and second-order

  conservative and higher order patch recovery methods, including 3-d

  regridding,

* apply convolution filters to field constructs,

* create running means from field constructs,

* apply differential operators to field constructs,

* create derived quantities (such as relative vorticity).

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 [cf-plot

gallery](http://ajheaps.github.io/cf-plot/gallery.html) for the full

range of plotting possibilities with example code.

![Example output of cf-plot displaying a `cf` field construct](docs/source/images/cfplot_example.png)

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

      

---

Owner metadata

• Name: NCAS CMS
• Login: NCAS-CMS
• Email:
• Kind: organization
• Description: Useful tools to support NERC weather and climate research
• Website: http://cms.ncas.ac.uk/
• Location: UK
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/31280705?v=4
• Repositories: 10
• Last ynced at: 2023-03-02T02:05:18.504Z
• Profile URL: https://github.com/NCAS-CMS

---

GitHub Events

Total

• Fork event: 19
• Create event: 50
• Commit comment event: 3
• Release event: 13
• Issues event: 440
• Watch event: 88
• Delete event: 17
• Member event: 2
• Issue comment event: 1123
• Push event: 1170
• Pull request review comment event: 897
• Pull request review event: 1021
• Pull request event: 934

Last Year

• Create event: 9
• Delete event: 3
• Fork event: 2
• Issue comment event: 133
• Issues event: 74
• Pull request event: 126
• Pull request review comment event: 292
• Pull request review event: 254
• Push event: 117
• Release event: 5
• Watch event: 18

---

Committers metadata

Last synced: 2 days ago

Name	Email	Commits
David Hassell	d****l@n****k	2163
Sadie Louise Bartholomew	s****w@n****k	969
David Hassell	d****l@r****k	391
Ankit Bhandekar	8****t	219
Thibault Hallouin	t****n@u****e	13
Bruno P. Kinoshita	k****w	11
Charles Roberts	c****s@r****k	10
Matt	m****3@g****m	3
Matt Brown	4****3	2
Alan Iwi	a****i@s****k	1
Alexander James Phillips	a****l@g****m	1
William McGinty	3****S	1

Committer domains:

• reading.ac.uk: 2
• ncas.ac.uk: 2
• stfc.ac.uk: 1
• ucdconnect.ie: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ncas-cms/cf-python

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 649 last-month
• Total dependent packages: 1
• Total dependent repositories: 9
• Total versions: 110
• Total maintainers: 2

---

Dependencies

Score: 14.204407163352888