pyhomogenize


Namepyhomogenize JSON
Version 0.2.4 PyPI version JSON
download
home_pagehttps://github.com/ludwiglierhammer/pyhomogenize
SummaryTool to homogenize netCDF files to CF standard
upload_time2022-07-12 11:48:58
maintainer
docs_urlNone
authorLudwig Lierhammer
requires_python>=3.5
licenseMIT license
keywords pyhomogenize
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ====================================================
Homogenize NetCDF files to CF standard: pyhomogenize
====================================================

.. image:: https://github.com/ludwiglierhammer/pyhomogenize/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/ludwiglierhammer/pyhomogenize/actions/workflows/ci.yml

.. image:: https://codecov.io/gh/ludwiglierhammer/pyhomogenize/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/ludwiglierhammer/pyhomogenize

.. image:: https://img.shields.io/pypi/v/pyhomogenize.svg
    :target: https://pypi.python.org/pypi/pyhomogenize

.. image:: https://readthedocs.org/projects/pyhomogenize/badge/?version=latest
    :target: https://pyhomogenize.readthedocs.io/en/latest/?version=latest
    :alt: Documentation Status

.. image:: https://results.pre-commit.ci/badge/github/ludwiglierhammer/pyhomogenize/main.svg
   :target: https://results.pre-commit.ci/latest/github/ludwiglierhammer/pyhomogenize/main
   :alt: pre-commit.ci status

Tool to homogenize netCDF to CF standard files using xarray

See https://cfconventions.org

* Free software: MIT license
* Documentation: https://pyhomogenize.readthedocs.io

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:

.. code-block:: console

     pip install pyhomogenize

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

.. code-block:: console

    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 :code:`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.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
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

0.2.4 (2022-07-12)
------------------

* add data via pip install

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ludwiglierhammer/pyhomogenize",
    "name": "pyhomogenize",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "pyhomogenize",
    "author": "Ludwig Lierhammer",
    "author_email": "ludwig.lierhammer@hereon.de",
    "download_url": "https://files.pythonhosted.org/packages/2d/9a/00d4f9b9bbe64fb61c378b03517b7ebe8c3f08c8edc079ba8266273dd80a/pyhomogenize-0.2.4.tar.gz",
    "platform": null,
    "description": "====================================================\nHomogenize NetCDF files to CF standard: pyhomogenize\n====================================================\n\n.. image:: https://github.com/ludwiglierhammer/pyhomogenize/actions/workflows/ci.yml/badge.svg\n    :target: https://github.com/ludwiglierhammer/pyhomogenize/actions/workflows/ci.yml\n\n.. image:: https://codecov.io/gh/ludwiglierhammer/pyhomogenize/branch/main/graph/badge.svg\n    :target: https://codecov.io/gh/ludwiglierhammer/pyhomogenize\n\n.. image:: https://img.shields.io/pypi/v/pyhomogenize.svg\n    :target: https://pypi.python.org/pypi/pyhomogenize\n\n.. image:: https://readthedocs.org/projects/pyhomogenize/badge/?version=latest\n    :target: https://pyhomogenize.readthedocs.io/en/latest/?version=latest\n    :alt: Documentation Status\n\n.. image:: https://results.pre-commit.ci/badge/github/ludwiglierhammer/pyhomogenize/main.svg\n   :target: https://results.pre-commit.ci/latest/github/ludwiglierhammer/pyhomogenize/main\n   :alt: pre-commit.ci status\n\nTool to homogenize netCDF to CF standard files using xarray\n\nSee https://cfconventions.org\n\n* Free software: MIT license\n* Documentation: https://pyhomogenize.readthedocs.io\n\nFeatures\n--------\n\n* some useful functions to read and write large netCDF files\n\n* basics: This class creates a fixed frequency CFTimeIndex from user-given start and end dates.\n  You can manipulate the CFTimeIndex and crop it to user-specific conditions.\n\n* netcdf_basics: This class opens one or multiple netCDF files by calling the class.\n  You can manipulate the netCDF attributes and write it to a new file.\n\n* time_control: This class is a time checker for NetCDF files following CF Metadata Conventions.\n  It is based on pyhomogenize's netcdf_basics class. Thus it opens the netCDF files by calling the class.\n\n* time_compare: This class compares the time axes of list entires of multiple xr.datasets, netCDF files and/or time_control objects.\n\n\nInstallation\n------------\nYou can install the package directly with pip:\n\n.. code-block:: console\n\n     pip install pyhomogenize\n\nIf you want to contribute, I recommend cloning the repository and installing the package in development mode, e.g.\n\n.. code-block:: console\n\n    git clone https://github.com/ludwiglierhammer/pyhomogenize.git\n    cd pyhomogenize\n    pip install -e .\n\nThis will install the package but you can still edit it and you don't need the package in your :code:`PYTHONPATH`\n\nRequirements\n------------\n\n* python3.6 or higher\n\n* cftime\n\n* dask\n\n* iteration_utilities\n\n* xarray\n\nContact\n-------\nIn cases of any problems, needs or wishes do not hesitate to contact:\n\nludwig.lierhammer@hereon.de\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.1.0 (2020-11-12)\n------------------\n\n* First release on PyPI.\n\n0.1.1 (2022-06-24)\n------------------\n\n* Fixed bug in setup.py version number\n\n0.1.2 (2022-06-24)\n------------------\n\n* pre-commit.ci bug fixed\n\n0.1.3 (2022-06-24)\n------------------\n\n* Read version number from __init__\n\n0.1.4 (2022-06-24)\n------------------\n\n* Expand HISTORY.rst\n\n0.2.0 (2022-06-30)\n------------------\n\n* Outsource useful functions for reading and writing large netCDF files.\n* Use those functiosn directly from pyhomogenize.\n* Calling pyhomogenize classes is not needed.\n\n0.2.1 (2022-07-01)\n------------------\n\n* rename save_to_netcdf to save_xrdataset\n* write input files to ds attributes\n\n0.2.2 (2022-07-05)\n------------------\n\n* create chunks if not already existing\n\n0.2.3 (2022-07-11)\n------------------\n\n* write CF variables to dataset while calling open_xrdataset\n\n0.2.4 (2022-07-12)\n------------------\n\n* add data via pip install\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "Tool to homogenize netCDF files to CF standard",
    "version": "0.2.4",
    "split_keywords": [
        "pyhomogenize"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1efc96e322148e0080da93301ce51e5f",
                "sha256": "25997c0318e0483217338fe28966b2b95fa0490ebf5cca9e6a062874e291fc65"
            },
            "downloads": -1,
            "filename": "pyhomogenize-0.2.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1efc96e322148e0080da93301ce51e5f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 34717325,
            "upload_time": "2022-07-12T11:48:52",
            "upload_time_iso_8601": "2022-07-12T11:48:52.477466Z",
            "url": "https://files.pythonhosted.org/packages/eb/8b/34fc110edca5edbc12e431143e2ac5b9dca8caf2b750c05fac3316270aec/pyhomogenize-0.2.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "83ddcbbea3fff1502e90f4effc3d2a34",
                "sha256": "e9c01f80464039064f3a17f7844694695a6bb9b73972dc4b27e30c21b78aee7f"
            },
            "downloads": -1,
            "filename": "pyhomogenize-0.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "83ddcbbea3fff1502e90f4effc3d2a34",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 34645332,
            "upload_time": "2022-07-12T11:48:58",
            "upload_time_iso_8601": "2022-07-12T11:48:58.037979Z",
            "url": "https://files.pythonhosted.org/packages/2d/9a/00d4f9b9bbe64fb61c378b03517b7ebe8c3f08c8edc079ba8266273dd80a/pyhomogenize-0.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-07-12 11:48:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "ludwiglierhammer",
    "github_project": "pyhomogenize",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "pyhomogenize"
}
        
Elapsed time: 0.40451s