|
| 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