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

Some README updates [skip ci]

parent f4bd5bc8
......@@ -83,7 +83,7 @@ The object now contains several quantities of interest, for example the minimal
## Installation
`pymagglobal` is built and installed using [conda](https://www.anaconda.com/).
0. Clone the repository
1. Clone the repository
```console
$ git clone https://gitext.gfz-potsdam.de/arthus/pymagglobal.git
```
......@@ -103,7 +103,7 @@ The object now contains several quantities of interest, for example the minimal
Careful: With tcshell, you have to use activate.csh.
2. Install `conda-build`
1. Install `conda-build`
```console
$ conda install conda-build
```
......@@ -114,20 +114,12 @@ $ bash install.sh
```
which will do the next steps for you. If `install.sh` fails or you want to do the steps by hand:
3. Build [FieldTools]
This step will make the pyfield library available via the local conda channel.
Navigate to `<pymagglobal>` and build [FieldTools]
```console
$ conda build FieldTools
```
4. Build pymagglobal
Build pymagglobal
Navigate to `<pymagglobal>` and build pymagglobal
```console
$ conda build ./
$ conda build meta.yaml
```
5. Install pymagglobal
Install pymagglobal
```console
$ conda install pymagglobal -c local
```
......@@ -144,7 +136,20 @@ Another way to use `pymagglobal` is via nix-shell. With [nix](https://nixos.org/
```console
$ nix-shell
```
from within the `pymagglobal` root directory.
from within the `pymagglobal` root directory. You may also use the nix-expression [pymagglobal.nix] to include `pymagglobal` in your own environments.
## Testing
To test your `pymagglobal` installation, run
```console
$ python tests/run_tests.py
```
from `<pymagglobal>`. Some tests require `FieldTools` and `orthopoly` and will be skipped, if the respective pacakges are not available.
We also provide the expression for a nix-shell with all dependencies installed. This will however not test your local installation, but your local repository. To perform the tests, run
```console
$ nix-shell .tests-shell.nix --run "python tests/run_tests.py"
```
[FieldTools]: http://doi.org/10.5880/fidgeo.2019.033
......
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