iiasa / pysquirrel

MIT License
2 stars 1 forks source link

pysquirrel - NUTS administrative region utility

license Code style: ruff pytest DOI

Copyright 2024 IIASA Scenario Services team

This repository is licensed under the MIT License.

Overview

pysquirrel is a Python package designed to work with NUTS administrative divisions.

The current NUTS version is valid from 1 January 2024.

Background

From the Eurostat website

The NUTS classification (Nomenclature of territorial units for statistics) is a geographical nomenclature subdividing the economic territory of the European Union (EU) into regions at three different levels (NUTS 1, 2 and 3 respectively, moving from larger to smaller territorial units). Above NUTS 1, there is the 'national' level of the Member States.

NUTS is used for:

Usage

pysquirrel allows searching the list of all territorial units by specifying the parameters and the values to search as shown below:

>>> import pysquirrel

>>> pysquirrel.nuts.get(country_code="AT")  # gets all regions in Austria

>>> pysquirrel.nuts.get(level=3)  # gets all NUTS3 regions

>>> pysquirrel.nuts.get(country_code="AT", level=3)  # gets all NUTS3 regions in Austria

Each Region object consists of five attributes:

Eurostat copyright notice on NUTS region data file

This package imports the NUTS spreadsheet from the Eurostat website.

Please note that pysquirrel is not developed, maintained or affiliated with Eurostat. The Eurostat copyright notice applies.

The Eurostat editorial content is licensed under the Creative Commons Attribution 4.0 International licence. Reuse of statistical metadata such as the NUTS classification is authorised with due citation of the source.

European Commission, Eurostat, Statistical regions in the European Union and partner countries -- NUTS and statistical regions 2021 -- 2022 edition, Publications Office of the European Union, 2022, https://data.europa.eu/doi/10.2785/321792

Acknowledgement

This package is developed and maintained by the Scenario Services & Scientific Software research theme at the IIASA Energy, Climate, and Enviroment program. Visit https://software.ece.iiasa.ac.at for more information.