Development

Build the package

Ensure the Python package build is installed:

pip install build

In the project base directory, run:

python -m build

Build the documentation

Change into the ./doc/ directory:

cd doc

Build (for instance) the HTML documentation:

make html

The terminal output indicates “The HTML pages are in _build/html”. Open the file index.html in this directory.

Write and run tests

The message_ix_buildings package has some tests.

Run these using pytest:

pytest