Commit bda6bd02 authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Changed the install instructions a bit.

parent 4c74d5ad
# pymagglobal
**python interface for global geomagnetic field models**
......@@ -58,39 +57,45 @@ pymagglobal is built and installed using [conda](https://www.anaconda.com/).
1. Download and install [Miniconda](https://conda.io/miniconda.html) for Python 3
By default, the installation directory `<conda>` is `~/miniconda3/`.
If you let conda modify your `bash.rc`, `<conda>/bin/conda` may be replaced by
`conda`.
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>/bin/conda create --name Your_Environment
$ conda create --name Your_Environment
```
followed by
```console
$ <conda>/bin/conda activate Your_Environment
$ conda activate Your_Environment
```
Careful: With tcshell, you have to use activate.csh.
2. Install `conda-build`
```console
$ <conda>/bin/conda install conda-build
$ conda install conda-build
```
With `conda-build` installed, you may go to `<pymagglobal>` and run
```console
$ bash install.sh
```
which will do the next steps for you.
3. Build [FieldTools]
This step will make the pyfield library available via the local conda channel.
Navigate to `<pymagglobal>` and build [FieldTools]
```console
$ <conda>/bin/conda build FieldTools
$ conda build FieldTools
```
4. Build pymagglobal
Navigate to `../<pymagglobal>` and build pymagglobal
Navigate to `<pymagglobal>` and build pymagglobal
```console
$ <conda>/bin/conda build pymagglobal
$ conda build ./
```
5. Install pymagglobal
```console
$ <conda>/bin/conda install pymagglobal -c local
$ conda install pymagglobal -c local
```
This will make `pymagglobal` available as a python package, i.e. you can use
```python
......@@ -101,12 +106,6 @@ pymagglobal is built and installed using [conda](https://www.anaconda.com/).
$ pymagglobal --help
```
With `conda-build` installed, you may also go to `<pymagglobal>` and run
```console
$ bash install.sh
```
which will simply do steps 3-5 for you.
[FieldTools]: https://gitup.uni-potsdam.de/matusche/fieldtools
## Contact
......
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