Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.41 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.41 KB

simple_regional

PyPI Status Python Version License

Read the documentation at https://simple_regional.readthedocs.io/ Tests Codecov

pre-commit Black

Do not use this library - it is a dramatic simplification of proper regionalization and will give you incorrect results unless you are very careful.

Installation

You can install simple_regional via [pip] from PyPI or Anaconda.

License

Distributed under the terms of the MIT license, simple_regional is free and open source software.

Building the Documentation

You can build the documentation locally by installing the documentation Conda environment:

conda env create -f docs/environment.yml

activating the environment

conda activate sphinx_simple_regional

and running the build command:

sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html