Commit ac480455 authored by Maximilian Schanner's avatar Maximilian Schanner Committed by Maximilian Schanner
Browse files

Update install instructions [skip ci]

parent f422821e
......@@ -81,56 +81,13 @@ The object now contains several quantities of interest, for example the minimal
```
## Installation
`pymagglobal` is built and installed using [conda](https://www.anaconda.com/).
1. Clone the repository
```console
$ git clone https://gitext.gfz-potsdam.de/arthus/pymagglobal.git
```
In the following `<pymagglobal>` refers to the path you cloned the `pymagglobal` repository into.
1. Download and install [Miniconda](https://conda.io/miniconda.html) for Python 3
By default, the installation directory `<conda>` is `~/miniconda3/`.
If you do not allow conda to modify your `bash.rc`, `conda` has to be replaced by `<conda>/bin/conda`. This may cause `install.sh` to fail.
You may want to create a fresh environment for pymagglobal. This is done using
```console
$ conda create --name Your_Environment
```
followed by
```console
$ conda activate Your_Environment
```
Careful: With tcshell, you have to use activate.csh.
1. Install `conda-build`
```console
$ conda install conda-build
```
With `conda-build` installed, you may go to `<pymagglobal>` and run
> **Note:** pymagglobal depends on [cartopy](https://scitools.org.uk/cartopy). You have to install it, before running the install command.
> This should also help if you receive `ImportError: NumPy 1.10+ is required to install cartopy.`
`pymagglobal` is distributed via the PyPI registry of this repository. It can be installed using
```console
$ bash install.sh
```
which will do the next steps for you. If `install.sh` fails or you want to do the steps by hand:
Build pymagglobal
Navigate to `<pymagglobal>` and build pymagglobal
```console
$ conda build meta.yaml
```
Install pymagglobal
```console
$ conda install pymagglobal -c local
```
This will make `pymagglobal` available as a python package, i.e. you can use
```python
import pymagglobal
```
as well as register a shell command in your local environmet, so that you can run
```console
$ pymagglobal --help
```
$ pip install pymagglobal --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@gitext.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple
```
Another way to use `pymagglobal` is via nix-shell. With [nix](https://nixos.org/download.html) installed, simply run
```console
......
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