Skip to content

Commit 818c8da

Browse files
committed
add installation docs
1 parent 2575d23 commit 818c8da

File tree

3 files changed

+91
-6
lines changed

3 files changed

+91
-6
lines changed

CHANGELOG

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The rules for this file:
1313
* accompany each entry with github issue/PR number (Issue #xyz)
1414

1515
------------------------------------------------------------------------------
16-
??/??/2019 giacomofiorin, orbeckst
16+
05/16/2019 giacomofiorin, orbeckst
1717

1818
* 0.5.0
1919

doc/source/index.rst

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,33 @@ version 3`_ (see also the files ``COPYING`` and ``COPYING.LESSER`` in
2121
the source distribution). Releases are available from the Python
2222
Package index under GridDataFormats_ and source code is available from
2323
the GitHub repository
24-
https://github.com/MDAnalysis/GridDataFormats. Please report problems
25-
and enhancement requests through the `issue tracker`_.
24+
https://github.com/MDAnalysis/GridDataFormats.
25+
26+
.. rubric:: Participating
27+
28+
Ask questions on the `mdnalysis-discussion mailing list`_ and join the
29+
discussion.
30+
31+
Please report problems and enhancement requests through the `issue
32+
tracker`_.
33+
34+
GridDataFormats is open source and welcomes your contributions. Fork
35+
the `GridDataFormats repository on GitHub`_ and submit a pull request. Participate on the
36+
`developer mailing list`_.
37+
38+
2639

2740
.. _`Lesser GNU General Public License, version 3`:
2841
https://www.gnu.org/licenses/lgpl-3.0.en.html
2942
.. _GridDataFormats: https://pypi.python.org/pypi/GridDataFormats/
3043
.. _issue tracker: https://github.com/MDAnalysis/GridDataFormats/issues
31-
44+
.. _mdnalysis-discussion mailing list:
45+
https://groups.google.com/group/mdnalysis-discussion
46+
.. _developer mailing list:
47+
https://groups.google.com/group/mdnalysis-devel
48+
.. _GridDataFormats repository on GitHub:
49+
https://github.com/MDAnalysis/GridDataFormats
50+
3251
.. |zenodo| image:: https://zenodo.org/badge/13219/MDAnalysis/GridDataFormats.svg
3352
:alt: Zenodo DOI
3453
:target: https://zenodo.org/badge/latestdoi/13219/MDAnalysis/GridDataFormats
@@ -40,14 +59,14 @@ and enhancement requests through the `issue tracker`_.
4059
:numbered:
4160
:maxdepth: 1
4261

62+
installation
4363
gridData/overview
4464
gridData/basic
4565
gridData/formats
4666
gridData/core
4767

4868

49-
Indices and tables
50-
==================
69+
.. rubric:: Indices and tables
5170

5271
* :ref:`genindex`
5372
* :ref:`modindex`

doc/source/installation.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
Installation
2+
============
3+
4+
GridDataFormats can be easily installed via the :ref:`conda<conda-install>` or
5+
:ref:`pip<pip-install>` package managers.
6+
7+
It is a pure-python package but it has a few other packages (namely
8+
scipy) as dependencies that contain compiled code. For ease of
9+
installation we recommend :ref:`conda<conda-install>` but
10+
:ref:`pip<pip-install>` and installation from source are also fully
11+
supported.
12+
13+
14+
15+
.. _conda-install:
16+
17+
Installing GridDataFormats with ``conda``
18+
-----------------------------------------
19+
20+
The `conda`_ package manager installs, runs, and updates whole
21+
environments with all their dependencies.
22+
23+
Installing *GridDataFormats* from the *conda-forge* channel can be
24+
achieved by adding "conda-forge" to your channels with::
25+
26+
conda config --add channels conda-forge
27+
28+
Once the *conda-forge* channel has been enabled, *GridDataFormats* can
29+
be installed with::
30+
31+
conda install griddataformats
32+
33+
Any missing dependencies will be automatically downloaded and
34+
installed in the appropriate versions.
35+
36+
You can later update with ::
37+
38+
conda update griddataformats
39+
40+
41+
.. _conda: https://docs.conda.io/
42+
43+
.. _pip-install:
44+
45+
Installing GridDataFormats with ``pip``
46+
---------------------------------------
47+
48+
Install with `pip`_::
49+
50+
pip install gridDataFormats
51+
52+
and you can later update with ::
53+
54+
pip install --upgrade gridDataFormats
55+
56+
57+
`pip` also automatically downloads all missing dependencies and will
58+
attempt to compile them if necessary; this step can fail if you do not
59+
have the correct build environment with the necessary compilers
60+
installed. You should then read the pip_ documentation to learn what
61+
is needed or switch to the :ref:`conda installation<conda-install>`.
62+
63+
64+
.. _pip: https://pip.pypa.io/
65+
66+

0 commit comments

Comments
 (0)