Commit 1ae816fb authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Detailed installation.

parent 8d5eab67
......@@ -3,4 +3,54 @@
Installation
============
Nothing here yet.
pymagglobal is distributed via the PyPI registry of the corresponding repository. It can be installed using
.. code-block:: bash
$ pip3 install pymagglobal --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@git.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple
Dependencies
------------
pymagglobal depends on
* `numpy <https://numpy.org/>`_
* `scipy <https://www.scipy.org/>`_
* `matplotlib <https://matplotlib.org/>`_
* `cartopy <https://scitools.org.uk/cartopy/>`_
* `PyQt5 <https://www.riverbankcomputing.com/software/pyqt/>`_
Depending on your setup, the latter two may require additional work to install.
The most fluent way to install pymagglobal is to first `install cartopy <https://scitools.org.uk/cartopy/docs/latest/installing.html#installing>`_ and `PyQt5 <https://www.riverbankcomputing.com/static/Docs/PyQt5/installation.html>`__ and then run the pip command given above.
In general you should follow the installation instructions given on the respective package homepages.
Below we illuminate some ways to install the dependencies, that we pursued during troubleshooting.
If you run into problems during installing pymagglobal, do not hesitate to `contact us <mailto:arthus@gfz-potsdam.de>`_.
Please try to install the dependencies beforehand.
Conda
-----
Since `conda <https://docs.conda.io/>`_ version 4.6, conda and pip get along well. So you can also run `pip3 install ...` from inside your conda environment. The dependencies come via
.. code-block:: bash
conda install cartopy pyqt5
Debian
------
First you have to install python and pip:
.. code-block:: bash
apt-get install python3-dev python3-pip
The debian-packages necessary to install cartopy can be installed via
.. code-block:: bash
apt-get install libproj-dev libgeos-dev proj-bin
Afterwards cartopy will be installed alongside pymagglobal, if you run the pip command from above.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment