geomodels 1.0.0b1

Python package for Earth data models management

Copyright:

2019 Antonio Valentino

license:

MIT

url:

https://github.com/avalentino/geomodels

About

GeoModels provides tools for the management of Earth models like geoids, gravity models, and magnetic field models.

It also provides some utility function to download and install support data to that are necessary for Earth models computation.

It is basically a Cython wrapper for part of the the GeographicLib C++ library.

Installation

The GeoModels requires Python >= 3.6. To use GeoModels it is necessary to have the following Python packages installed:

• numpy

• tqdm (optional)

• argcomplete (optional)

The geomodels package provides some binary extensions so the installation from sources also requires:

• Cython

• a C/C++ compiler

• GeographicLib >= 1.49

The required Python packages are automatically installed installed by Pip and setuptools but the user is in charge of ensuring that the C++ compiler and GeographicLib are properly installed and configured.

Note

if GeographicLib is installed into a non-standard path, the used shall set the environment (e.g. CPPFLAGS, CXXFLAGS and LDFLAGS for the GNU GCC) to allow the compiler to find the GeographicLib header files and libraries.

Also, in this case, the used shall configure the environment to allow the system to find and load GeographicLib shared library (e.g. by setting the LD_LIBRARY_PATH on GNU/Linux systems).

The installation form sources can be done using the following command:

$ python3 -m pip install PATH_TO_GEOMODELS_SOURCES_OR_TARBALL

Please refer to the Pip user manual for details about installation options.

Developers may want to build the package inplace for development and testing purposes. In this case the following command can be used from within the root of the package source tree:

$ python3 setup.py build_ext --inplace

Testing

The recommended way to run tests is to use PyTest form the root of the geomodels package source tree:

$ python3 -m pytest

The above, of course, requires the PyTest to be installed.

In alternative the following command can be used:

$ python3 setup.py test

Note

running tests requires that model data, used by the underlying GeographicLib, are correctly installed in the default system location.

More in detail, the following data models are sued for testing:

geoid data:

‘egm96-5’, and data for the default model

gravity data:

‘egm96’, and data for the default model

magnetic field data:

‘wmm2015’, ‘igrf12’ and data for the default model

License

GeoModels is released under the terms of the MIT/X11 License (see LICENSE file).