Browse Source

docs: improved installation guide

priors
Sebastian Heimann 2 years ago
parent
commit
09cbcbea97
1 changed files with 15 additions and 11 deletions
  1. +15
    -11
      docs/source/install/index.rst

+ 15
- 11
docs/source/install/index.rst View File

@ -3,22 +3,25 @@ Installation
Grond is compatible with Python 2.7 as well as Python 3.4 and above.
Installation from source (manual install)
-----------------------------------------
.. _manual-install:
Manual installation (from source)
---------------------------------
First install Grond's prerequisites. It depends on
* `Pyrocko`_ - required
* `Kite`_ - optional, needed for InSAR data modelling
Next, get Grond's source code using `git clone`:
Next, get Grond's source code using :program:`git clone`:
.. code-block :: sh
git clone https://github.com/pyrocko/grond.git
cd grond
Finally, decide if you want to install system-wide or just for a single user.
Finally, decide if you want to install Grond system-wide or just for a single
user.
System wide installation::
@ -34,14 +37,14 @@ Updating a manual installation
------------------------------
For updating an existing manual installation of Grond, update the source code
using 'git pull':
using :program:`git pull`:
.. code-block :: sh
cd grond # change to the directory to where you cloned Grond initially
git pull origin master
Then just over-install as described in the section above.
Then just reinstall as described in section :ref:`manual-install` above.
Installation under Anaconda
@ -52,6 +55,7 @@ installed with Anaconda's pip into the Anaconda environment.
.. code-block :: sh
conda install -c pyrocko pyrocko
pip install git@https://github.com/pyrocko/grond.git
@ -59,14 +63,14 @@ installed with Anaconda's pip into the Anaconda environment.
Installation with pip
---------------------
If you want to install Grond's prerequisite Pyrocko with pip, carefully read
`Installation with pip`_ in the Pyrocko manual first. Grond's prerequisites
must be installed beforehand, we do not allow pip to automatically resolve
dependencies.
If you want to install Pyrocko with pip, carefully read the section
`Installation with pip`_ in the Pyrocko manual first. We do not allow pip to
resolve its dependencies automatically, therefore you have to install
`Pyrocko`_ (required) and `Kite`_ (optional) separately.
.. code-block :: sh
pip3 install git@https://github.com/pyrocko/grond.git
pip install git@https://github.com/pyrocko/grond.git
.. _kite: https://pyrocko.org/docs/kite/current/


Loading…
Cancel
Save