Skip to content

Commit

Permalink
Preparing release 0.25.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin Winkel committed Jul 30, 2017
1 parent 850c07c commit 8a1684e
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 12 deletions.
5 changes: 4 additions & 1 deletion CHANGES.rst
@@ -1,4 +1,7 @@
0.25.2 (unreleased)
0.25.3 (unreleased)
====================

0.25.2 (2017-07-30)
====================

New Features
Expand Down
7 changes: 5 additions & 2 deletions docs/pathprof/index.rst
Expand Up @@ -136,6 +136,8 @@ one component::
>>> from astropy import units as u
>>> from pycraf import pathprof, conversions as cnv

>>> pathprof.SrtmConf.set(download='missing') # doctest: +IGNORE_OUTPUT

>>> freq = 1. * u.GHz

>>> lon_tx, lat_tx = 6.8836 * u.deg, 50.525 * u.deg
Expand All @@ -152,7 +154,7 @@ one component::
# clutter zones
>>> zone_t, zone_r = pathprof.CLUTTER.URBAN, pathprof.CLUTTER.SUBURBAN

>>> pprop = pathprof.PathProp( # doctest: +REMOTE_DATA
>>> pprop = pathprof.PathProp( # doctest: +REMOTE_DATA +IGNORE_OUTPUT
... freq,
... temperature, pressure,
... lon_tx, lat_tx,
Expand Down Expand Up @@ -239,7 +241,6 @@ to produce terrain maps of a region:
from astropy import units as u
from pycraf import pathprof

# allow download of missing SRTM data:
pathprof.SrtmConf.set(download='missing')

lon_t, lat_t = 9.943 * u.deg, 54.773 * u.deg # Northern Germany
Expand Down Expand Up @@ -403,6 +404,8 @@ Therefore, we added a faster alternative, `~pycraf.pathprof.atten_map_fast`. The
plt.show()


pathprof.SrtmConf.set(download='missing')

lon_tx, lat_tx = 6.88361 * u.deg, 50.52483 * u.deg
map_size_lon, map_size_lat = 0.5 * u.deg, 0.5 * u.deg
map_resolution = 10. * u.arcsec
Expand Down
12 changes: 4 additions & 8 deletions docs/pathprof/working_with_srtm.rst
Expand Up @@ -88,8 +88,7 @@ to download missing tiles during run-time::


>>> from pycraf.pathprof import SrtmConf
>>> SrtmConf.set(srtm_dir='/path/to/srtmdir')
<MultiState SrtmConf>
>>> SrtmConf.set(srtm_dir='/path/to/srtmdir') # doctest: +IGNORE_OUTPUT

Alternatively, if only a temporary change of the config is desired,
one can use `~pycraf.pathprof.SrtmConf` as a context manager::
Expand All @@ -102,16 +101,14 @@ Afterwards, the old settings will be re-established.

It is also possible to allow downloading of missing *.hgt* files::

>>> SrtmConf.set(download='missing')
<MultiState SrtmConf>
>>> SrtmConf.set(download='missing') # doctest: +IGNORE_OUTPUT

The default download server will be `server='nasa_v2.1'`. One could
also use the (very old) data (`server='nasa_v1.0'`) or inofficial
tiles from `viewfinderpanoramas.org
<http://viewfinderpanoramas.org/>`_ (`server='viewpano'`)::

>>> SrtmConf.set(server='viewpano')
<MultiState SrtmConf>
>>> SrtmConf.set(server='viewpano') # doctest: +IGNORE_OUTPUT

Of course, one can set several of these options simultaneously::

Expand All @@ -131,8 +128,7 @@ can also have nearest-neighbor (`interp='nearest'`) or spline
spline degrees (`kx` and `ky`) and smoothing factor (`s`).
To change these use::

>>> SrtmConf.set(interp='spline', spline_opts=(3, 0))
<MultiState SrtmConf>
>>> SrtmConf.set(interp='spline', spline_opts=(3, 0)) # doctest: +IGNORE_OUTPUT

We refer to `~scipy.interpolate.RectBivariateSpline` description for
further information.
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Expand Up @@ -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.2.dev
version = 0.25.2

[entry_points]

Expand Down

0 comments on commit 8a1684e

Please sign in to comment.