Metadata-Version: 2.1
Name: ldcpy
Version: 0.6
Summary: A library for lossy compression of netCDF files using xarray
Home-page: https://ldcpy.readthedocs.io
Maintainer: Alex Pinard
Maintainer-email: apinard@mines.edu
License: Apache 2.0
Project-URL: Documentation, https://ldcpy.readthedocs.io
Project-URL: Source, https://github.com/NCAR/ldcpy
Project-URL: Tracker, https://github.com/NCAR/ldcpy/issues
Keywords: compression,xarray
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Requires-Dist: xarray
Requires-Dist: numpy
Requires-Dist: netcdf4
Requires-Dist: cython
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: cmocean
Requires-Dist: jupyterlab
Requires-Dist: xrft
Requires-Dist: pip
Requires-Dist: dask[complete]
Requires-Dist: opencv-python (==4.2.0.34)
Requires-Dist: scikit-image
Requires-Dist: nc-time-axis

.. image:: https://img.shields.io/github/workflow/status/NCAR/ldcpy/CI?logo=github&style=for-the-badge
    :target: https://github.com/NCAR/ldcpy/actions
    :alt: GitHub Workflow CI Status

.. image:: https://img.shields.io/circleci/project/github/NCAR/ldcpy/master.svg?style=for-the-badge&logo=circleci
    :target: https://circleci.com/gh/NCAR/ldcpy/tree/master

.. image:: https://img.shields.io/github/workflow/status/NCAR/ldcpy/code-style?label=Code%20Style&style=for-the-badge
    :target: https://github.com/NCAR/ldcpy/actions
    :alt: GitHub Workflow Code Style Status

.. image:: https://img.shields.io/codecov/c/github/NCAR/ldcpy.svg?style=for-the-badge
    :target: https://codecov.io/gh/NCAR/ldcpy

.. image:: https://img.shields.io/readthedocs/ldcpy/latest.svg?style=for-the-badge
    :target: https://ldcpy.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/ldcpy.svg?style=for-the-badge
    :target: https://pypi.org/project/ldcpy
    :alt: Python Package Index

.. image:: https://img.shields.io/conda/vn/conda-forge/ldcpy.svg?style=for-the-badge
    :target: https://anaconda.org/conda-forge/ldcpy
    :alt: Conda Version

Large Data Comparison for Python
=================================

ldcpy is a utility for gathering and plotting metrics from NetCDF or Zarr files using the Pangeo stack.
It also contains a number of statistical and visual tools for gathering metrics and comparing Earth System Model data files.

Documentation and usage examples are available `here <http://ldcpy.readthedocs.io>`_.

Installation using Conda (recommended)
______________________________________

Ensure conda is up to date and create a clean Python (3.6+) environment:

.. code-block:: bash

    conda update conda
    conda create --name ldcpy python=3.8
    conda activate ldcpy

Now install ldcpy:

.. code-block:: bash

    conda install -c conda-forge ldcpy

Alternative Installation
________________________

Ensure pip is up to date, and your version of python is at least 3.6:

.. code-block:: bash

    pip install --upgrade pip
    python --version

Install cartopy using the instructions provided at https://scitools.org.uk/cartopy/docs/latest/installing.html.

Then install ldcpy:

.. code-block:: bash

    pip install ldcpy

Accessing the tutorial
______________________

If you want access to the tutorial notebook, clone the repository (this will create a local repository in the current directory):

.. code-block:: bash

    git clone https://github.com/NCAR/ldcpy.git

Start by enabling Hinterland for code completion and code hinting in Jupyter Notebook and then opening the tutorial notebook:

.. code-block:: bash

    jupyter nbextension enable hinterland/hinterland
    jupyter notebook


The tutorial notebook can be found in docs/source/notebooks/SampleNotebook.ipynb, feel free to gather your own metrics or create your own plots in this notebook!


