pybalmorel

Convenient python framework for pre-, post-processing or executing the GAMS framework Balmorel. Install into your virtual python environment with:

pip install pybalmorel

For more information on how to manage and install virtual environments check out this resource, or if you are a conda user, this resource.

Get Started

Check out the documentation for examples on how to use pybalmorel. The following notebooks can also be downloaded:

• Pre-Processing
• Execution
• Post-Processing

Developer Notes

This package is distributed to PyPI. See the Developing pybalmorel section of the documentation for full details. The short version:

Install pixi and use one of the following environments:

Command	Purpose
pixi shell	Develop pybalmorel and build documentation (editable install + all tools)
pixi shell -e user	Test pybalmorel as an end-user (PyPI install only)

Publishing a new version

1. Update the pybalmorel version in pyproject.toml, docs/conf.py and docs/get_started/installation.md (a find and replace in VS Code will do)
2. Build the distribution: python -m build
3. Upload to PyPI with your PyPI token: python -m twine upload dist/pybalmorel-X.Y.Z.tar.gz