Skip to content

Commit

Permalink
Updated VERSION and README, ran tests
Browse files Browse the repository at this point in the history
  • Loading branch information
jgliss committed Nov 17, 2018
1 parent 5c188d7 commit d813551
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. note:: **NEW**: Supports both Python 2.7 and 3.6 from now.

`geonum <https://github.com/jgliss/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 <https://pypi.org/project/LatLon23>`_ and were expanded including the 3rd dimension (altitude).
Geonum features online access to topographic data from the SRTM dataset, using the
Geonum features online access to topographic data from the SRTM dataset, using the
`SRTM module <https://pypi.python.org/pypi/SRTM.py/>`_. Furthermore, topographic data from the `ETOPO1 Dataset <https://www.ngdc.noaa.gov/mgg/global/global.html>`_ is supported.

News / Notifications
Expand All @@ -14,12 +14,12 @@ Planned changes
===============

- Refactoring of ``basemap`` dependency to ``cartopy``
- :class:`TopoData` should be based on :class:`xarray.DataArray`
- Support for more topographic datasets, interpolation of gaps in topodata and
- ``TopoData`` should be based on ``xarray.DataArray``
- Support for more topographic datasets, interpolation of gaps in topodata

Copyright
=========

Copyright (C) 2017 Jonas Gliss ([email protected])

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License a published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Expand All @@ -35,11 +35,11 @@ It is recommended to use `Anaconda <https://www.continuum.io/downloads>`_ as Pyt

- numpy
- matplotlib >= 1.4.3
- matplotlib `basemap <https://pypi.python.org/pypi/basemap/1.0.7>`_ (*installation of this module may not be straight forward - especially on Windows machines -, please follow the instructions provided on the web page*)
- matplotlib `basemap <https://pypi.python.org/pypi/basemap/1.0.7>`_ (*installation of this module may not be straight forward - especially on Windows machines -, please follow the instructions provided on the web page*)
- LatLon23 >= 1.0.7

- LatLon23 requires installation of `pyproj <https://pypi.python.org/pypi/pyproj/>`_

- Scipy (including `scipy.ndimage <https://docs.scipy.org/doc/scipy-0.18.1/reference/ndimage.html>`_)

**Optional dependencies (to use extra features)**
Expand All @@ -53,11 +53,11 @@ Installation
Geonum can be installed from `PyPi <https://pypi.python.org/pypi/geonum>`_ using::

pip install geonum

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

python setup.py install

If the installation fails make sure, that all dependencies (see above) are installed correctly. geonum is tested for Python 2.7.

Instructions and code documentation
Expand All @@ -78,15 +78,15 @@ Tested and supported are the following two files (grid registered):

1. Ice surface: ETOPO1_Ice_g_gmt4.grd (download `here <https://www.ngdc.noaa.gov/mgg/global/relief/ETOPO1/data/ice_surface/grid_registered/netcdf/ETOPO1_Ice_g_gmt4.grd.gz>`__)
2. Bedrock: ETOPO1_Bed_g_gmt4.grd (download `here <https://www.ngdc.noaa.gov/mgg/global/relief/ETOPO1/data/bedrock/grid_registered/netcdf/ETOPO1_Bed_g_gmt4.grd.gz>`__)

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*
2 changes: 1 addition & 1 deletion VERSION.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.3.0
1.3.1

0 comments on commit d813551

Please sign in to comment.