Metadata-Version: 2.1
Name: msl-io
Version: 0.1.0
Summary: Read and write data files
Home-page: https://github.com/MSLNZ/msl-io
Author: Measurement Standards Laboratory of New Zealand
Author-email: info@measurement.govt.nz
License: MIT
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Provides-Extra: h5py
Provides-Extra: google
Provides-Extra: tests
Provides-Extra: docs
Provides-Extra: dev
License-File: LICENSE.txt
License-File: AUTHORS.rst

MSL-IO
======

|docs| |pypi| |github tests|

**MSL-IO** follows the data model used by HDF5_ to read and write data files -- where there is a
Root_, Group_\s and Dataset_\s and these objects each have Metadata_ associated with them.

.. image:: https://raw.githubusercontent.com/MSLNZ/msl-io/main/docs/_static/hdf5_data_model.png

The tree structure is similar to the file-system structure used by operating systems. Group_\s
are analogous to the directories (where Root_ is the root Group_) and Dataset_\s are analogous
to the files.

The data files that can be read or created are not restricted to HDF5_ files, but any file format
that has a Reader_ implemented can be read and data files can be created using any of the Writer_\s.

Install
-------
To install **MSL-IO** run:

.. code-block:: console

   pip install https://github.com/MSLNZ/msl-io/archive/main.zip

Alternatively, using the `MSL Package Manager`_ run:

.. code-block:: console

   msl install io

Dependencies
++++++++++++
* Python 2.7, 3.5+
* numpy_
* xlrd_ (bundled with **MSL-IO**)

Documentation
-------------
The documentation for **MSL-IO** can be found `here <https://msl-io.readthedocs.io/en/stable/index.html>`_.

.. |docs| image:: https://readthedocs.org/projects/msl-io/badge/?version=latest
   :target: https://msl-io.readthedocs.io/en/stable/
   :alt: Documentation Status
   :scale: 100%

.. |pypi| image:: https://badge.fury.io/py/msl-io.svg
   :target: https://badge.fury.io/py/msl-io

.. |github tests| image:: https://github.com/MSLNZ/msl-io/actions/workflows/run-tests.yml/badge.svg
   :target: https://github.com/MSLNZ/msl-io/actions/workflows/run-tests.yml

.. _HDF5: https://www.hdfgroup.org/
.. _Root: https://msl-io.readthedocs.io/en/stable/_api/msl.io.base.html#msl.io.base.Root
.. _Group: https://msl-io.readthedocs.io/en/stable/group.html
.. _Dataset: https://msl-io.readthedocs.io/en/stable/dataset.html
.. _Metadata: https://msl-io.readthedocs.io/en/stable/metadata.html
.. _Reader: https://msl-io.readthedocs.io/en/stable/readers.html
.. _Writer: https://msl-io.readthedocs.io/en/stable/writers.html
.. _MSL Package Manager: https://msl-package-manager.readthedocs.io/en/stable/
.. _numpy: https://www.numpy.org/
.. _xlrd: https://xlrd.readthedocs.io/en/stable/
