bugfix release v0.25.1

CHANGES.rst

@@ -1,3 +1,15 @@
+0.25.1 (2017-07-28)
+====================
+
+Bugfixes
+--------
+
+- Tests now don't run any SRTM-data related function, only if the option
+  `remote-data=any` is given (on CLI, within Python it is invoked with
+  `pycraf.test(remote_data='any')`). Therefore, one doesn't need to
+  manually download SRTM tiles beforehand anymore.
+
+
 0.25.0 (2017-07-27)
 ====================
 

README.rst

@@ -2,7 +2,7 @@
 pycraf
 ******
 
-- *Version:* 0.24
+- *Version:* 0.25
 - *Author:* Benjamin Winkel
 - *User manual:* Hosted on `GitHub Pages <https://bwinkel.github.io/pycraf/>`_
 
@@ -74,9 +74,6 @@ After installation (see below) you can test, if everything works as intended::
     import pycraf
 
     pycraf.test()
-    # this will skip over some tests that need to download
-    # data from the internet; to include them:
-    pycraf.test(remote_data='any')
 
 By default, the `test` function will skip over tests that require
 data from the internet. One can include them by::
@@ -143,33 +140,9 @@ features and to build the docs:
 * pyproj 1.9 or later; for the `geospatial` subpackage
 * sgp4 1.4 or later; for the `satellite` subpackage
 
-Windows machines
-----------------
-
-Note, for Windows machines we provide a binary wheel (Python 3.5+ only).
-However, the pyproj package is a dependency and unfortunately, the official
-pyproj repository on PyPI contains only the sources. You can download a
-suitable wheel from `Christoph Gohlke's package site <http://www.lfd.uci.edu/~gohlke/pythonlibs/#pyproj>`_. Then use::
-
-    pip install [path-to-wheel]\pyproj‑*.whl
-
-If you're using `Anaconda <https://www.continuum.io/downloads>`_ (recommended), it is much simpler::
-
-    conda install -c conda-forge pyproj
-
-In case you want or need to install from the sources, the MS Visual C compiler
-is necessary. You can download and use the `Visual C++ 2015 Build Tools
-<http://landinghub.visualstudio.com/visual-cpp-build-tools>`_ which is "only"
-4 GBytes...
-
-MacOS machines
---------------
-
-For installation on MacOS you'll have to install gcc-6. The clang compiler
-seems not to support OpenMP in a way that is needed by pycraf::
-
-    brew install gcc6
-    brew link --overwrite gcc@6
+For further details, we refer to the online documention `installation
+instructions <https://bwinkel.github.io/pycraf/install.html>`_. It also
+includes some hints for running pycraf on Windows or MacOS.
 
 SRTM data
 ---------

docs/install.rst

@@ -49,7 +49,7 @@ To install pycraf with `pip <http://www.pip-installer.org/en/latest/>`__, simply
 
 .. note::
 
-    You will need a C compiler (``gcc``) to be installed for the installation
+    You may need a C compiler (``gcc``) to be installed for the installation
     to succeed. Since `pycraf` needs OpenMP, ``clang`` is currently not
     supported.
 
@@ -75,13 +75,38 @@ To install pycraf with `pip <http://www.pip-installer.org/en/latest/>`__, simply
     Do **not** install pycraf or other third-party packages using ``sudo``
     unless you are fully aware of the risks.
 
+.. _source_install:
+
+Installation from source
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are two options, if you want to build pycraf from sources. Either, you
+install the tar-ball (*.tar.gz file) from `PyPI
+<https://pypi.python.org/pypi/pycraf>`_ and extract it to the directory of
+your choice, or, if you always want to stay up-to-date, clone the git
+repository:
+
+.. code-block:: bash
+
+    git clone https://github.com/bwinkel/pycraf
+
+Then go into the pycraf source directory and run:
+
+.. code-block:: bash
+
+    python setup.py install
+
+Again, consider the ``--user`` option or even better use a python distribution
+such as `Anaconda <https://www.continuum.io/downloads>`_ to avoid messing up
+the system-wide Python installation.
+
 
 .. _windows_install:
 
 Installation on Windows
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-Note, for Windows machines we provide a binary wheel (Python 3.5+ only).
+Note that for Windows machines we provide a binary wheel (Python 3.5+ only).
 However, the `pyproj <https://pypi.python.org/pypi/pyproj>`_ package is a
 dependency and unfortunately, the official
 `pyproj <https://pypi.python.org/pypi/pyproj>`__ repository on PyPI contains
@@ -118,7 +143,8 @@ If you're using `Anaconda <https://www.continuum.io/downloads>`__
 Installation on MacOS
 ~~~~~~~~~~~~~~~~~~~~~
 
-For installation on MacOS you'll have to install gcc-6. The clang compiler
+Even though we also provide a binary wheel for MacOS, it seems you'll still
+have to install a C-compiler, in particular *gcc-6*. The clang compiler
 seems not to support OpenMP in a way that is needed by pycraf:
 
 .. code-block:: bash
@@ -136,6 +162,15 @@ Then proceed as usual with
     # then
     pip install pycraf
 
+.. warning::
+
+    Currently, we only provide MacOS wheels for *gcc-6* (version 6.4).
+    It seems that if you have a different version of *gcc-6* on your machine
+    importing pycraf will fail with some ``libgomp`` error, which is probably
+    due to binary inconsistencies between the various *gcc* versions.
+    Please, consider updating to the 6.4-version of *gcc*, or install from
+    source with your own *gcc* compiler.
+
 .. _testing_installed_pycraf:
 
 Testing an installed pycraf

setup.cfg

@@ -48,7 +48,7 @@ url = https://github.com/bwinkel/pycraf
 edit_on_github = False
 github_project = bwinkel/pycraf
 # version should be PEP386 compatible (http://www.python.org/dev/peps/pep-0386)
-version = 0.25.0
+version = 0.25.1
 
 [entry_points]