Skip to main content

Toolbox for 3D geonumerical calculations and atmospheric composition

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 to support also the vertical dimension. Geonum features online access to topographic data from the SRTM dataset, using the SRTM module. Furthermore, topographic data from the ETOPO1 Dataset is supported.

Requirements

It is recommended to use the conda Python package manager (get it e.g. via miniconda)

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

geonum is tested and can be installed both for Python >= 3.6 and on all common OS (Windows, linux and OSX).

Installation via conda

The easiest way to install geonum is to install the latest release via the conda-forge channel:

conda install -c conda-forge geonum

This will install all requirements as well.

Installation via pip or from source

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

or - if you use Python 3 - by creating a new conda environment using the provided conda environment file:

conda env create -n geonum_env -f geonum_env.yml

After installing the requirements, 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

Getting 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

Planned changes (for v2.0.0)

See below for my (@jgliss) personal wish-list of new features, help is more than welcome as I have to work on geonum mostly in my spare time.

  • Refactoring of basemap dependency to cartopy
  • Base TopoData on xarray.DataArray
  • Support for more topographic datasets, interpolation of gaps in topodata, merging and interpolation of different topographic datasets

Project details


Download files

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

Files for geonum, version 1.4.5
Filename, size File type Python version Upload date Hashes
Filename, size geonum-1.4.5-py3-none-any.whl (76.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size geonum-1.4.5.tar.gz (65.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page