1============================
2 README for GridDataFormats
3============================
4
5|build| |cov| |docs| |zenodo| |conda|
6
7The **GridDataFormats** package provides classes to unify reading and
8writing n-dimensional datasets. One can read grid data from files,
9make them available as a `Grid`_ object, and write out the data again.
10
11Availability
12------------
13
14The package is licensed under the LGPL, v3 (see files COPYING_ and
15`COPYING.LESSER`_) and is available
16
17* from the Python Package Index under the name `GridDataFormats`_
18* as a conda package from the *conda-forge* channel, `conda-forge/griddataformats`_
19* in source from the GitHub repository https://github.com/MDAnalysis/GridDataFormats
20
21.. _GridDataFormats:
22   https://pypi.python.org/pypi/GridDataFormats
23.. _`conda-forge/griddataformats`:
24   https://anaconda.org/conda-forge/griddataformats
25.. _COPYING:
26   https://raw.githubusercontent.com/MDAnalysis/GridDataFormats/master/COPYING
27.. _`COPYING.LESSER`:
28   https://raw.githubusercontent.com/MDAnalysis/GridDataFormats/master/COPYING.LESSER
29.. _Grid:
30   https://www.mdanalysis.org/GridDataFormats/gridData/core.html#gridData.core.Grid
31
32Installation
33------------
34
35Installing GridDataFormats with ``pip``
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
38Install with `pip`_::
39
40  pip install gridDataFormats
41
42.. _pip: https://pip.pypa.io/
43
44
45Installing GridDataFormats with ``conda``
46~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47
48Installing *GridDataFormats* from the *conda-forge* channel can be
49achieved by adding "conda-forge" to your channels with::
50
51    conda config --add channels conda-forge
52
53Once the *conda-forge* channel has been enabled, *GridDataFormats* can
54be installed with::
55
56    conda install griddataformats
57
58
59
60Documentation
61-------------
62
63For the latest docs see the `GridDataFormats docs`_. (Multiple
64versions of the docs are also available at
65`griddataformats.readthedocs.org`_.)
66
67
68.. _GridDataFormats docs:
69   https://www.mdanalysis.org/GridDataFormats
70.. _`griddataformats.readthedocs.org`:
71   https://griddataformats.readthedocs.org
72
73
74Contributing
75------------
76
77Please use the `issue tracker`_ for bugs and questions.
78
79**GridDataFormats** is open source and contributions are
80welcome. Please fork the repository and submit a `pull request`_.
81
82.. _issue tracker:
83   https://github.com/MDAnalysis/GridDataFormats/issues
84.. _pull request:
85   https://github.com/MDAnalysis/GridDataFormats/pulls
86
87.. |numfocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
88    :alt: Powered by NumFOCUS
89    :target: https://www.numfocus.org/
90
91.. |build| image:: https://github.com/MDAnalysis/GridDataFormats/actions/workflows/gh-ci.yaml/badge.svg
92    :alt: Github Actions Build Status
93    :target: https://github.com/MDAnalysis/GridDataFormats/actions/workflows/gh-ci.yaml
94
95.. |cov| image:: https://codecov.io/gh/MDAnalysis/GridDataFormats/branch/master/graph/badge.svg
96     :alt: Coverage Status
97     :target: https://codecov.io/gh/MDAnalysis/GridDataFormats
98
99.. |docs| image:: https://readthedocs.org/projects/griddataformats/badge/?version=latest
100    :alt: Documentation
101    :target: http://griddataformats.readthedocs.org/en/latest/
102
103.. |zenodo| image:: https://zenodo.org/badge/13219/MDAnalysis/GridDataFormats.svg
104    :alt: Zenodo DOI
105    :target: https://zenodo.org/badge/latestdoi/13219/MDAnalysis/GridDataFormats
106
107.. |conda| image:: https://anaconda.org/conda-forge/griddataformats/badges/version.svg
108    :alt: Anaconda
109    :target: https://anaconda.org/conda-forge/griddataformats
110