1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
Metadata-Version: 2.1
Name: GridDataFormats
Version: 1.0.2
Summary: Reading and writing of data on regular grids in Python
Home-page: https://github.com/MDAnalysis/GridDataFormats
Download-URL: https://github.com/MDAnalysis/GridDataFormats/releases
Author: Oliver Beckstein
Author-email: orbeckst@gmail.com
License: LGPLv3
Keywords: science array density
Classifier: Development Status :: 6 - Mature
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: COPYING
License-File: COPYING.LESSER
License-File: AUTHORS
Requires-Dist: numpy>=1.21
Requires-Dist: scipy
Requires-Dist: mrcfile
============================
README for GridDataFormats
============================
|build| |cov| |docs| |zenodo| |conda|
The **GridDataFormats** package provides classes to unify reading and
writing n-dimensional datasets. One can read grid data from files,
make them available as a `Grid`_ object, and write out the data again.
Availability
------------
The package is licensed under the LGPL, v3 (see files COPYING_ and
`COPYING.LESSER`_) and is available
* from the Python Package Index under the name `GridDataFormats`_
* as a conda package from the *conda-forge* channel, `conda-forge/griddataformats`_
* in source from the GitHub repository https://github.com/MDAnalysis/GridDataFormats
.. _GridDataFormats:
https://pypi.python.org/pypi/GridDataFormats
.. _`conda-forge/griddataformats`:
https://anaconda.org/conda-forge/griddataformats
.. _COPYING:
https://raw.githubusercontent.com/MDAnalysis/GridDataFormats/master/COPYING
.. _`COPYING.LESSER`:
https://raw.githubusercontent.com/MDAnalysis/GridDataFormats/master/COPYING.LESSER
.. _Grid:
https://www.mdanalysis.org/GridDataFormats/gridData/core.html#gridData.core.Grid
Installation
------------
Installing GridDataFormats with ``pip``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install with `pip`_::
pip install gridDataFormats
.. _pip: https://pip.pypa.io/
Installing GridDataFormats with ``conda``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Installing *GridDataFormats* from the *conda-forge* channel can be
achieved by adding "conda-forge" to your channels with::
conda config --add channels conda-forge
Once the *conda-forge* channel has been enabled, *GridDataFormats* can
be installed with::
conda install griddataformats
Documentation
-------------
For the latest docs see the `GridDataFormats docs`_. (Multiple
versions of the docs are also available at
`griddataformats.readthedocs.org`_.)
.. _GridDataFormats docs:
https://www.mdanalysis.org/GridDataFormats
.. _`griddataformats.readthedocs.org`:
https://griddataformats.readthedocs.org
Contributing
------------
Please use the `issue tracker`_ for bugs and questions.
**GridDataFormats** is open source and contributions are
welcome. Please fork the repository and submit a `pull request`_.
.. _issue tracker:
https://github.com/MDAnalysis/GridDataFormats/issues
.. _pull request:
https://github.com/MDAnalysis/GridDataFormats/pulls
.. |numfocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
:alt: Powered by NumFOCUS
:target: https://www.numfocus.org/
.. |build| image:: https://github.com/MDAnalysis/GridDataFormats/actions/workflows/gh-ci.yaml/badge.svg
:alt: Github Actions Build Status
:target: https://github.com/MDAnalysis/GridDataFormats/actions/workflows/gh-ci.yaml
.. |cov| image:: https://codecov.io/gh/MDAnalysis/GridDataFormats/branch/master/graph/badge.svg
:alt: Coverage Status
:target: https://codecov.io/gh/MDAnalysis/GridDataFormats
.. |docs| image:: https://readthedocs.org/projects/griddataformats/badge/?version=latest
:alt: Documentation
:target: http://griddataformats.readthedocs.org/en/latest/
.. |zenodo| image:: https://zenodo.org/badge/13219/MDAnalysis/GridDataFormats.svg
:alt: Zenodo DOI
:target: https://zenodo.org/badge/latestdoi/13219/MDAnalysis/GridDataFormats
.. |conda| image:: https://anaconda.org/conda-forge/griddataformats/badges/version.svg
:alt: Anaconda
:target: https://anaconda.org/conda-forge/griddataformats
|
