Skip to main content

Mapping the annual UK Scout Census to local geographies

Project description

Incognita

Python Versions Status PyPI Latest Release Conda Latest Release License Code style: black

Incognita is a tool to map UK Scout data and enable geospatial analysis.

We use ONS open data to link scout areas (Groups, Districts, etc.) to UK administrative geographies.

Incognita comes from Terra Incognita, or Parts Unknown - solving the known unknowns!

Where to get it

The source code for the project is hosted on GitHub at the-scouts/incognita

We strongly recommended using conda to install Incognita, however pip can be used with a number of manual installation steps as below.

To install Incognita with Conda, run the following commands in the terminal

# conda
conda env create -n incognita_env
conda activate incognita_env
conda install --channel conda-forge geopandas
# or PyPI
pip install incognita

If installing with pip, you will need to manually install geopandas and its dependencies. Please follow below:

Installing geopandas on Windows:

We strongly recommended using conda to install Incognita.

However, to install geopandas using pip on Windows, please follow these instructions.

Dependencies

This project is written and tested in Python 3.9, and depends on:

Getting Started:

You will need to obtain the latest version of the ONS Postcode Directory. Note that this has some open licences attached to it.

If this is not May 2018, then you will need to create another child class of ONSPostcodeDirectory in ONS_data.py

You will need to populate the settings.json file with the appropriate file paths

Generating the data file

To generate the datafile needed for most operations, run setup_data_file.py with clean prototype extract.

You may also run setup_reduce_onspd.py to produce a smaller ONS Postcode Directory file to speed up lookup operations and reduce memory consumption.

Directory Structure:

To run Incognita locally, you will need to create a data folder as below, and populate it with the ONS Postcode Directory files and a copy of the Scout Census extract.

  • data/
    • ONS_PD_DATE/
    • Scout Census Data/
      • Census Extract Files

Resources:

Postcode Directory:

Shapefiles:

Administrative/Electoral Geographies:

Use the same boundary resolution for each of the following (BFE, BFC, BGC, BUC)

BFE: Full Extent of the Realm; BFC: Full Extent Clipped; BGC: Generalised Clipped; BSC: Super Generalised Clipped

Census Geographies:

England and Wales:
Scotland:
Northern Ireland:

Single year of age profiles:

Westminster Parliamentary Constituencies:

Other useful data sources

Guide:

The Beginner's Guide to UK Geography can be useful as an introduction for those new to GIS.

Branches

The heroku branch is specifically for the heroku application: http://scout-mapping.herokuapp.com. It contains a cut down requirements file to ensure that it loads into heroku correctly.

License

Incognita is naturally open source and is licensed under the MIT license.

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

incognita-0.26.0.tar.gz (42.3 kB view details)

Uploaded Source

Built Distribution

incognita-0.26.0-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

Details for the file incognita-0.26.0.tar.gz.

File metadata

  • Download URL: incognita-0.26.0.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for incognita-0.26.0.tar.gz
Algorithm Hash digest
SHA256 8eb62491c24405ff70887268381b3b7cd4d5b9be69b98b42d52ea406c082de41
MD5 10a9836346307c6978fc422b9465feb3
BLAKE2b-256 a653378171ed0748235c159d7aae4d317081a03b585b5ffb95db7acee3a0f1d9

See more details on using hashes here.

Provenance

File details

Details for the file incognita-0.26.0-py3-none-any.whl.

File metadata

  • Download URL: incognita-0.26.0-py3-none-any.whl
  • Upload date:
  • Size: 46.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for incognita-0.26.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4cc81ac852e6c5b1a63f1256f3f115278f2fdf9a0e53e7f652a1269a1aaaa6de
MD5 e951b440a0fe6293755d6532332d8dbf
BLAKE2b-256 f9048726a3cca426dbdb6b1181c2e9252f6c4bab47bd3f2cee2d1b5a72e46926

See more details on using hashes here.

Provenance

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