.. ncdata documentation master file, created by
   sphinx-quickstart on Thu Apr  6 17:33:47 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

ncdata
======
NetCDF data interoperability.

Represents generic netcdf data in Python objects, with translation to and from common
analysis packages, so that netcdf-based data can be freely exchanged between packages
without data copying, and data storage formatting can be precisely controlled.

In particular Ncdata exchanges data **between Xarray and Iris** as efficiently as
possible.

   "lossless, copy-free and lazy-preserving".

This enables the user to freely mix+match operations from both projects, getting the
"best of both worlds".


User Documentation
------------------
For now, we don't yet have much documentation beyond this page, and the API notes.

* a general project introduction is provide in the project README,
  along with all the current project status information.

  * Please see : `README <https://github.com/pp-mo/ncdata#readme>`_

* Some simple usage examples (scripts) are provided in the codebase.

  * Please see : `Testcode scripts <https://github.com/pp-mo/ncdata/blob/main/tests/integration/example_scripts>`_


API documentation
-----------------

.. toctree::
   :maxdepth: 5

   api/modules


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`