Welcome to the EPSM developer handbook. Whether you are trying your first example or contributing a new feature, start here for shared engineering guides, package responsibilities and small worked examples. Pick one task and find the package that owns it.
Start with How to contribute, then read the engineering guide and try the small example notebooks. Coding agents also follow AGENTS.md.
To check the handbook locally, use Python 3.11+ and Git. No extra packages are needed for these checks.
git clone https://github.com/SB-Chalmers/epsm_development.git
cd epsm_development
python3 scripts/check_docs.py
python3 -m unittest discover -s tests -v
python3 scripts/run_examples.py- Handbook index and detailed guidance
- Package responsibilities and engineering style
- Writing guide
- Branches and releases
- Examples and common use cases
MIT. See the shared licensing policy for EPSM-owned material and retained third-party terms.
Developed at Chalmers University of Technology as part of the EPSM research platform.
Funding: Swedish Energy Agency (Project ID: P2024-04053)
Partners:
- Lindholmen Science Park AB
- Sinom AB
- Stiftelsen Chalmers Industriteknik
Team:
- Lead Developer: Sanjay Somanath
- Principal Investigator: Alexander Hollberg
- Contributors: Yinan Yu, Dag Wästberg
