Skip to main content

Toolbox for 3D geonumerical calculations

Project description

build-status docs

geonum provides functionality for geographical calculations in three dimensions and includes interfaces for accessing and processing of topographic data. Most of the features (e.g. distance retrievals) are based on the two fundamental objects GeoPoint and GeoVector3D which are inherited from the respective 2D base classes of the LatLon23 module and were expanded including the 3rd dimension (altitude). Geonum features online access to topographic data from the SRTM dataset, using the SRTM module. Furthermore, topographic data from the ETOPO1 Dataset is supported.

News / Notifications

  • Now also available and tested in Python > 3

  • Changed requirement LatLon -> LatLon23 to support Python 3

Planned changes

  • Refactoring of basemap dependency to cartopy

  • TopoData should be based on xarray.DataArray

  • Support for more topographic datasets, interpolation of gaps in topodata

Requirements

It is recommended to use Anaconda as Python package manager.

Please see requirements.txt for a list of requirements. Note that these are only the minimum required dependencies. Further, optional requirements are listed below. Note, that dependent on your OS and python version, some of these may be tricky to install:

Optional dependencies (to use extra features)

  • basemap (plotting of maps)

  • OpenCV

  • netCDF4

Installation

Please make sure to install all requirements beforehand (see above). You may do this by downloading the requirements file and calling from the command line:

pip install -r requirements.txt

Geonum can be installed from PyPi using:

pip install geonum

or from source by downloading and extracting the latest release or cloning the repository. After navigating to the source folder (where the setup.py file is located) call:

python setup.py install

Instructions and code documentation

The code documentation of geonum is hosted on Read The Docs

Get started

After installation try running the example scripts in order to test the installation. The scripts are also meant to provide an easy start into the main features of geonum.

Supported ETOPO1 files

In order to use topography data from the ETOPO1 dataset, please download and unzip one of the following files to the package folder geonum/local_topo_data/. Tested and supported are the following two files (grid registered):

  1. Ice surface: ETOPO1_Ice_g_gmt4.grd (download here)

  2. Bedrock: ETOPO1_Bed_g_gmt4.grd (download here)

The local installation folder can be accessed via:

import geonum
print(geonum.LOCAL_TOPO_PATH)

If a valid data file is stored in this folder, it will be detected automatically. It is also possible to store the topodata at another location (e.g. <data_path>). In this case, the local path to the folder containing the topograph files needs to be provided, e.g.:

import geonum
access = geonum.topodata.TopoDataAccess(mode="etopo1", local_path=<data_path>)

If the path is valid, it will be added to the installation file LOCAL_TOPO_PATHS.txt

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geonum-1.4.0.tar.gz (50.5 kB view details)

Uploaded Source

Built Distribution

geonum-1.4.0-py2.py3-none-any.whl (74.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file geonum-1.4.0.tar.gz.

File metadata

  • Download URL: geonum-1.4.0.tar.gz
  • Upload date:
  • Size: 50.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for geonum-1.4.0.tar.gz
Algorithm Hash digest
SHA256 f4848f2351a28e5c46c18a8a7b263717dc9d1865ceda41a2f7935c6c8a1b59c6
MD5 3682b28449b8848c79d6a9ab84640e49
BLAKE2b-256 668afa79c3b1b7c2fc5df1923b617a8ebc8d80441c4c35b46c68048a061bd6ed

See more details on using hashes here.

File details

Details for the file geonum-1.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: geonum-1.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 74.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for geonum-1.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 104dc60647f613ca02575146d1266518c3b9464a36992fe0de0061e2cdba28ea
MD5 a5f924201b2f8ab091c603751b5158cf
BLAKE2b-256 62abc3fa2865574437101efcf435c3b63036cc0c22c354038909cacb284c68df

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page