Skip to content

Commit

Permalink
package description updates
Browse files Browse the repository at this point in the history
  • Loading branch information
davidhassell committed Jan 31, 2023
1 parent 3fdade4 commit e6c50ee
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 55 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,12 @@ 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
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
See the `cf-plot gallery
<http://ajheaps.github.io/cf-plot/gallery.html>`_ for the full range
range plotting possibilities with example code.

![Example output of cf-plot displaying a `cf` field construct](docs/source/images/cfplot_example.png)
Expand Down
78 changes: 27 additions & 51 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ def compile():
=========
The Python cf package is an Earth science data analysis library that
is built on a complete implementation of the CF data model
is built on a complete implementation of the CF data model.
Documentation
=============
Expand All @@ -126,9 +126,8 @@ def compile():
Dask
====
From version 3.14.0, the `cf` package uses
[Dask](https://ncas-cms.github.io/cf-python/performance.html) for all
of its data manipulations.
From version 3.14.0, the ``cf`` package uses
[Dask](https://docs.dask.org) for all of its data manipulations.
Recipes
=======
Expand All @@ -145,36 +144,41 @@ def compile():
http://ncas-cms.github.io/cf-python/installation
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.
Visualization
=============
Powerful, flexible, and very simple to produce visualizations of field
constructs are available with the
[cfplot](http://ajheaps.github.io/cf-plot) package, 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.
Functionality
=============
The `cf` package implements the [CF data
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:
The ``cf`` package can:
* read field constructs from netCDF, CDL, PP and UM datasets,
Expand Down Expand Up @@ -225,34 +229,6 @@ def compile():
* 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 `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
"""

# Get dependencies
Expand Down

0 comments on commit e6c50ee

Please sign in to comment.