============================
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
Raw data
{
"_id": null,
"home_page": "https://github.com/MDAnalysis/GridDataFormats",
"name": "GridDataFormats",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "science array density",
"author": "Oliver Beckstein",
"author_email": "orbeckst@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/8b/e273fb4b3bb3d6c31b6387b34c602d96c407f535f2c58b17512f8b5a2746/GridDataFormats-1.0.2.tar.gz",
"platform": null,
"description": "============================\n README for GridDataFormats\n============================\n\n|build| |cov| |docs| |zenodo| |conda|\n\nThe **GridDataFormats** package provides classes to unify reading and\nwriting n-dimensional datasets. One can read grid data from files,\nmake them available as a `Grid`_ object, and write out the data again.\n\nAvailability\n------------\n\nThe package is licensed under the LGPL, v3 (see files COPYING_ and\n`COPYING.LESSER`_) and is available \n\n* from the Python Package Index under the name `GridDataFormats`_\n* as a conda package from the *conda-forge* channel, `conda-forge/griddataformats`_ \n* in source from the GitHub repository https://github.com/MDAnalysis/GridDataFormats\n\n.. _GridDataFormats:\n https://pypi.python.org/pypi/GridDataFormats\n.. _`conda-forge/griddataformats`:\n https://anaconda.org/conda-forge/griddataformats\n.. _COPYING:\n https://raw.githubusercontent.com/MDAnalysis/GridDataFormats/master/COPYING\n.. _`COPYING.LESSER`:\n https://raw.githubusercontent.com/MDAnalysis/GridDataFormats/master/COPYING.LESSER\n.. _Grid:\n https://www.mdanalysis.org/GridDataFormats/gridData/core.html#gridData.core.Grid\n\nInstallation\n------------\n\nInstalling GridDataFormats with ``pip``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nInstall with `pip`_::\n\n pip install gridDataFormats\n\n.. _pip: https://pip.pypa.io/\n\n\nInstalling GridDataFormats with ``conda``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nInstalling *GridDataFormats* from the *conda-forge* channel can be\nachieved by adding \"conda-forge\" to your channels with::\n\n conda config --add channels conda-forge\n\nOnce the *conda-forge* channel has been enabled, *GridDataFormats* can\nbe installed with::\n\n conda install griddataformats\n\n\n\nDocumentation\n-------------\n\nFor the latest docs see the `GridDataFormats docs`_. (Multiple\nversions of the docs are also available at\n`griddataformats.readthedocs.org`_.)\n\n\n.. _GridDataFormats docs:\n https://www.mdanalysis.org/GridDataFormats\n.. _`griddataformats.readthedocs.org`:\n https://griddataformats.readthedocs.org\n\n\nContributing\n------------\n\nPlease use the `issue tracker`_ for bugs and questions.\n\n**GridDataFormats** is open source and contributions are\nwelcome. Please fork the repository and submit a `pull request`_.\n\n.. _issue tracker:\n https://github.com/MDAnalysis/GridDataFormats/issues\n.. _pull request:\n https://github.com/MDAnalysis/GridDataFormats/pulls\n\n.. |numfocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A\n :alt: Powered by NumFOCUS\n :target: https://www.numfocus.org/\n\n.. |build| image:: https://github.com/MDAnalysis/GridDataFormats/actions/workflows/gh-ci.yaml/badge.svg\n :alt: Github Actions Build Status\n :target: https://github.com/MDAnalysis/GridDataFormats/actions/workflows/gh-ci.yaml\n\n.. |cov| image:: https://codecov.io/gh/MDAnalysis/GridDataFormats/branch/master/graph/badge.svg\n :alt: Coverage Status\n :target: https://codecov.io/gh/MDAnalysis/GridDataFormats\n\n.. |docs| image:: https://readthedocs.org/projects/griddataformats/badge/?version=latest\n :alt: Documentation\n :target: http://griddataformats.readthedocs.org/en/latest/\n\n.. |zenodo| image:: https://zenodo.org/badge/13219/MDAnalysis/GridDataFormats.svg\n :alt: Zenodo DOI\n :target: https://zenodo.org/badge/latestdoi/13219/MDAnalysis/GridDataFormats\n\n.. |conda| image:: https://anaconda.org/conda-forge/griddataformats/badges/version.svg\n :alt: Anaconda\n :target: https://anaconda.org/conda-forge/griddataformats\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "Reading and writing of data on regular grids in Python",
"version": "1.0.2",
"project_urls": {
"Download": "https://github.com/MDAnalysis/GridDataFormats/releases",
"Homepage": "https://github.com/MDAnalysis/GridDataFormats"
},
"split_keywords": [
"science",
"array",
"density"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89ab9cae972ca177f7c64017f4b76f3780c832da52737b95c3e39ed0701af7a7",
"md5": "22f0f95df972813a7497deb9bc52f8ef",
"sha256": "4562bb2da9a064a8e6640e5fb853e204c8f32f6403651703f6b0ef58a009054c"
},
"downloads": -1,
"filename": "GridDataFormats-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22f0f95df972813a7497deb9bc52f8ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 2140075,
"upload_time": "2023-10-21T21:47:40",
"upload_time_iso_8601": "2023-10-21T21:47:40.967641Z",
"url": "https://files.pythonhosted.org/packages/89/ab/9cae972ca177f7c64017f4b76f3780c832da52737b95c3e39ed0701af7a7/GridDataFormats-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da8be273fb4b3bb3d6c31b6387b34c602d96c407f535f2c58b17512f8b5a2746",
"md5": "1bd69759a77f09932e1cd8aa54c778e6",
"sha256": "b93cf7f36fce33dbc428026f26dba560d5c7ba2387caca495bad920f90094502"
},
"downloads": -1,
"filename": "GridDataFormats-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "1bd69759a77f09932e1cd8aa54c778e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2158614,
"upload_time": "2023-10-21T21:47:43",
"upload_time_iso_8601": "2023-10-21T21:47:43.113983Z",
"url": "https://files.pythonhosted.org/packages/da/8b/e273fb4b3bb3d6c31b6387b34c602d96c407f535f2c58b17512f8b5a2746/GridDataFormats-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-21 21:47:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MDAnalysis",
"github_project": "GridDataFormats",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "griddataformats"
}
JSON
