From d813551d782e31f27436401e6c52397e61805957 Mon Sep 17 00:00:00 2001 From: jgliss Date: Sat, 17 Nov 2018 13:17:55 +0100 Subject: [PATCH] Updated VERSION and README, ran tests --- README.rst | 24 ++++++++++++------------ VERSION.rst | 2 +- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index b6c9bf1..84831d0 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ .. note:: **NEW**: Supports both Python 2.7 and 3.6 from now. `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 +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 @@ -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 (jonasgliss@gmail.com) 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. @@ -35,11 +35,11 @@ It is recommended to use `Anaconda `_ as Pyt - numpy - matplotlib >= 1.4.3 - - matplotlib `basemap `_ (*installation of this module may not be straight forward - especially on Windows machines -, please follow the instructions provided on the web page*) + - matplotlib `basemap `_ (*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 `_ - + - Scipy (including `scipy.ndimage `_) **Optional dependencies (to use extra features)** @@ -53,11 +53,11 @@ Installation Geonum can be installed from `PyPi `_ 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 @@ -78,15 +78,15 @@ 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. ). 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 = ) - + If the path is valid, it will be added to the installation file *LOCAL_TOPO_PATHS.txt* diff --git a/VERSION.rst b/VERSION.rst index f0bb29e..3a3cd8c 100644 --- a/VERSION.rst +++ b/VERSION.rst @@ -1 +1 @@ -1.3.0 +1.3.1