Skip to main content

Tool to homogenize netCDF files to CF standard

Project description

Homogenize NetCDF files to CF standard: pyhomogenize

https://github.com/ludwiglierhammer/pyhomogenize/actions/workflows/ci.yml/badge.svg https://codecov.io/gh/ludwiglierhammer/pyhomogenize/branch/main/graph/badge.svg https://img.shields.io/pypi/v/pyhomogenize.svg Documentation Status pre-commit.ci status

Tool to homogenize netCDF to CF standard files using xarray

See https://cfconventions.org

Features

  • some useful functions to read and write large netCDF files

  • basics: This class creates a fixed frequency CFTimeIndex from user-given start and end dates. You can manipulate the CFTimeIndex and crop it to user-specific conditions.

  • netcdf_basics: This class opens one or multiple netCDF files by calling the class. You can manipulate the netCDF attributes and write it to a new file.

  • time_control: This class is a time checker for NetCDF files following CF Metadata Conventions. It is based on pyhomogenize’s netcdf_basics class. Thus it opens the netCDF files by calling the class.

  • time_compare: This class compares the time axes of list entires of multiple xr.datasets, netCDF files and/or time_control objects.

Installation

You can install the package directly with pip:

pip install pyhomogenize

If you want to contribute, I recommend cloning the repository and installing the package in development mode, e.g.

git clone https://github.com/ludwiglierhammer/pyhomogenize.git
cd pyhomogenize
pip install -e .

This will install the package but you can still edit it and you don’t need the package in your PYTHONPATH

Requirements

  • python3.6 or higher

  • cftime

  • dask

  • iteration_utilities

  • xarray

Contact

In cases of any problems, needs or wishes do not hesitate to contact:

ludwig.lierhammer@hereon.de

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2020-11-12)

  • First release on PyPI.

0.1.1 (2022-06-24)

  • Fixed bug in setup.py version number

0.1.2 (2022-06-24)

  • pre-commit.ci bug fixed

0.1.3 (2022-06-24)

  • Read version number from __init__

0.1.4 (2022-06-24)

  • Expand HISTORY.rst

0.2.0 (2022-06-30)

  • Outsource useful functions for reading and writing large netCDF files.

  • Use those functiosn directly from pyhomogenize.

  • Calling pyhomogenize classes is not needed.

0.2.1 (2022-07-01)

  • rename save_to_netcdf to save_xrdataset

  • write input files to ds attributes

0.2.2 (2022-07-05)

  • create chunks if not already existing

0.2.3 (2022-07-11)

  • write CF variables to dataset while calling open_xrdataset

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyhomogenize-0.2.3.tar.gz (28.9 kB view hashes)

Uploaded source

Built Distribution

pyhomogenize-0.2.3-py3-none-any.whl (21.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page