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

README update and license fix [skip ci]

parent 2d18ded0
......@@ -36,3 +36,9 @@ manual dependency config:
version: '0.7'
licenses:
- 'MIT'
- import name: 'packaging'
pkg name: 'packaging'
version: '20.7'
licenses:
- 'Apache-2.0'
- 'BSD-2-Clause'
......@@ -18,9 +18,9 @@
**Software Location:** [gitext](gitext.gfz-potsdam.de/arthus/pymagglobal)
**Last Commit:** 0d3d632b7026dab7b6a45c5b0a0016f2cab03c3b
**Last Commit:** 2d18ded04d8a7a8c4708585e9bf47c330be081b6
**Report Time:** 30/11/2020 11:09:45 UTC
**Report Time:** 30/11/2020 12:30:18 UTC
**Report Version:** 0.6.0
......@@ -67,6 +67,7 @@
|license|libraries|
|---|---|
|Apache-2.0 AND BSD-2-Clause|Python / packaging / user config|
|BSD|Python / numpy / 1.19.2 <br> Python / scipy / 1.5.2|
|GPL-3.0-or-later|Python / pyfield / user config|
|LGPLv3|Python / cartopy / 0.18.0|
......
......@@ -107,7 +107,10 @@ 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.
from `<pymagglobal>`. Some tests require `FieldTools`, `packaging` and `orthopoly` and will be skipped, if the respective pacakges are not available. You can install `orthopoly` and `packaging` together with `pymagglobal`, by running
```console
$ pip install pymagglobal[tests] --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@gitext.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple
```
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
......@@ -145,7 +148,7 @@ Computing in Science & Engineering, vol. 9, no. 3, pp. 90-95
[\[cartopy\]](https://scitools.org.uk/cartopy) Met Office (2015)
"Cartopy: a cartographic python library with a Matplotlib interface"
For testing `pymagglobal`, we use `pyfield` and `orthopoly`
For testing `pymagglobal`, we use `pyfield`, `orthopoly` and [`packaging`](https://packaging.pypa.io/):
[\[pyfield\]](http://doi.org/10.5880/fidgeo.2019.033) Matuschek, H. and Mauerberger, S. (2019)
FieldTools - A toolbox for manipulating vector fields on the sphere
......
......@@ -10,8 +10,25 @@ It can be applied to all cubic-spline based geomagnetic field models stored in t
package_documentation
command_line_interface
Installation
------------
.. 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 :code:`ImportError: NumPy 1.10+ is required to install cartopy.`
:code:`pymagglobal` is distributed via the PyPI registry of this repository. It can be installed using
.. code-block:: bash
$ pip install pymagglobal --extra-index-url https://public:5mz_iyigu-WE3HySBH1J@gitext.gfz-potsdam.de/api/v4/projects/1055/packages/pypi/simple
`See also. <https://gitext.gfz-potsdam.de/arthus/pymagglobal#installation>`_
.. include:: ../pymagglobal/dat/README.rst
License
-------
GNU General Public License, Version 3, 29 June 2007
......
......@@ -287,7 +287,7 @@ def dsh_basis(lmax, z, out, R=REARTH):
frame.", Geosci. Model Dev., vol. 8, pages 1979-1990, 2014.
.. [FieldTools] H. Matuschek and S. Mauerberger, "FieldTools - A toolbox
for manipulating vector fields on the sphere", GFZ Data Services, 2019.
DOI: `10.5880/fidgeo.2019.033<http://doi.org/10.5880/fidgeo.2019.033>`_
DOI: `10.5880/fidgeo.2019.033 <http://doi.org/10.5880/fidgeo.2019.033>`_
'''
_intcheck(lmax)
# check input consitency
......
......@@ -11,3 +11,4 @@ cartopy==0.18.0
# For testing
orthopoly==0.7
pyfield==0.1.3i
packaging==20.7
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