Skip to main content

Presents the landscape of Great Britain as a test bed for optimisation and sampling methods.

Project description

Where's Ben Nevis?

This repository contains the source code for the Python module nevis: a fun(?) project that presents the landscape of Great Britain (GB) as a test bed for numerical optimisation or sampling methods.

Installation

nevis requires Python 3.6 or newer. The additional package convertbng is recommended, but not required.

To install without cloning this repository, use

pip install nevis

or

pip install nevis[extras]

to install the convertbng module as well.

Developers may wish to clone and install from the repository, using the instructions in CONTRIBUTING.md.

Next, download the "OS Terrain 50" data set (see "Data set" below) from the Ordnance Survey using:

import nevis
nevis.load_os50()

By default, the data is installed into the user directory ~/nevis-data, for example /home/michael/nevis-data on a Linux system or C:\Users\michael\nevis-data on Windows. The installation path can be changed by specifying an alternative directory in the environment variable NEVIS_PATH before running load_os50().

Note that this data set is licensed under the terms explained here: www.ordnancesurvey.co.uk/opendata/licence

Usage

Check that everything was downloaded correctly by plotting a map of Great Britain:

# Import nevis
import nevis

# Create and store a figure
nevis.write_test_figure('gb-small.png')

Downscaled map of GB

Usage examples are given in the examples directory.

Full API documentation is currently not provided, but there is only a handful of public objects:

  • British national grid utilities (see _bng.py):
    • ben Returns grid coordinates (Coords) for Ben Nevis.
    • Coords Represents grid coordinates and can convert to various forms.
    • dimensions Returns the physical dimensions (in meters) of the grid.
    • fen Returns grid coordinates for Holme Fen, the lowest point (inland).
    • Hill Represents a hill from the hills database.
    • pub Returns grid coordinates for a random pub, selected from a very short list.
    • squares Returns the coordinates of major BNG squares.
  • OS Terrain 50 loading methods (see _os50.py):
    • DataNotFoundError An error raised if the data was not downloaded or can't be found.
    • download_os50 The method to download and unpack the data. Only needs to be run once.
    • gb Loads and returns the heights data for GB.
    • spacing returns the physical distance (in meters) between the points returned by gb.
  • Interpolants (see _interpolation.py)
    • linear_interpolant Returns a linear interpolant over the GB height data.
    • spline Returns a spline defined over the GB height data.
  • Plotting (see _plot.py)
    • plot Creates a plot of a map, with optional labels etc.
    • plot_line Creates a plot of the height profile between two points.
    • png_bytes Turns a matplotlib figure into a bytes string.
    • save_plot Stores a plot and checks its size. Less paranoid people can use fig.savefig() instead.
  • Various (see _util.py and __init__.py)
    • howdy Prints some old-school ascii art including the version number.
    • Timer Times and formats intervals.
    • write_test_figure Loads the data and writes a test figure to disk.

Data set

Height information is from the Terrain 50 data set made available by the UK's Ordnance Survey. More information can be found here.

The data is divided into squares indicated with a two letter code, and several data files per square. However, each data file contains its absolute "eastings" and "northings", so we can ignore the letter codes. Eastings and northings are defined by the "National Grid", or OSGB36. In easier terms, they are x and y coordinates, in meters, relative to the bottom-left point of the grid (which is the bottom left of the square "SV", which contains the Isles of Scilly).

As an example, the header from the NN17 file is:

ncols 200
nrows 200
xllcorner 210000
yllcorner 770000
cellsize 50

Here ncols and nrows indicate the number of grid points in the file, the Lower Left corner of the data in the file is given by xllcorner and yllcorner, and the distance between any two data points is given as cellsize. In the Terrain 50 data set, the cellsize is always 50 (giving it its name). There is a more accurate Terrain 5 set that costs money.

According to Wikipedia, the approximate coordinates for Ben Nevis are 216600, 771200 (which is in the NN17 square).

An easy way to find places on the grid is with https://britishnationalgrid.uk. Another nice map with BNG coordinates is https://explore.osmaps.com. A a great map without BNG coordinates can be found at https://opentopomap.org.

The sea

The sea is a bit messy in these files, as the values depend on mean sea level in each 10x10 km^2 area (OS Tile) relative to OS datum (0m) level which is mean sea level in Newlyn, Cornwall.

Hill tops

Names of hill and mountain tops are taken from The Database of British and Irish Hills v17.2, which is made available under a CC-BY license.

Lattitude and longitude 🐇🕳️

What about longitude (east-west) and lattitude (north-south)? These are defined, it seems, by WGS 84, although there is a Europe-specific version called ETRS89 which "for most purposes ... can be considered equivalent to WGS84" ("Transformations and OSGM15 User Guide"). Transforming from national grid coordinates to longitude and lattitude is hard, and the Ordnance Survey have released a thing called OSTN15 to do this. Although this still seems to result in x, y coordinates, not degrees. Luckily, somebody's made a tool for it. Unfortunately, some people have issues installing this, so that we rely on a less accurate fallback for the time being. If you can, please manually install convertbng too (BenNevis will try using this first, before switching to bnglonglat).

Interpolation

To get heights for arbitrary points, we need to interpolate. By default, we use a linear interpolant. We also experimented with a scipy RectBiVariateSpline. This takes some time (~30 seconds on a fast machine) and uses considerable memory (~3GB). Most importantly, the spline shows some very serious (and unrealistic) artefacts near high gradients (e.g. at the sea side), so that the linear interpolation seems the way to go for now.

Project details


Download files

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

Source Distribution

nevis-0.0.3.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

nevis-0.0.3-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file nevis-0.0.3.tar.gz.

File metadata

  • Download URL: nevis-0.0.3.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.9.13

File hashes

Hashes for nevis-0.0.3.tar.gz
Algorithm Hash digest
SHA256 00e0a698bf6bb2512c9bf26ef08a724fabd25e37220c131dc826e663f4b81bcf
MD5 fb69a81a99ae545279f06afc6791dabf
BLAKE2b-256 89e980ad0c3c468c213f354423e311ee6cb19328e88d326631f214c8cde463ab

See more details on using hashes here.

File details

Details for the file nevis-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: nevis-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.9.13

File hashes

Hashes for nevis-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a103bb51a2ff50882defc319aea79d7ea7683e930e3f87ee18c96864e3e495e2
MD5 d464bca7255420b13814ea790f4d833c
BLAKE2b-256 f6955d92b0ac00f567b182a1a486bb9f61c001bc1a66e2213603af095123c87e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page