BATEM
BATEM is a dynamic building energy simulator and teaching toolkit. It models wall inertia, air renewal, body metabolism, solar gains through glazing and opaque façades, HVAC, comfort, and PV.
The interactive entry point is baterm (the BATEM terminal). You do not need VS Code, MyBinder, or a special IDE setup to follow the course or run simulations.
Install and start
pip install batem
baterm
# or: python -m batem.baterm
Requires Python ≥ 3.12. Inside the shell, use help, help baterm, and manual for the full user guide.
Project files (.context, .building, .pv, …) resolve under ./data by default. Tab completion lists that folder.
Lectures
Lecture PDFs ship with the package (batem/lectures/slidesXX_*.pdf). From baterm:
lectures # list available slides
lectures 1 # open slides01_*.pdf in your system PDF viewer
lectures 15 # open slides15_*.pdf
Workshops (Jupyter notebooks)
Workshops are workshopXX_*.ipynb notebooks. baterm starts JupyterLab for you:
workshops list # list notebooks
workshops 1 # open workshop01_sun.ipynb
workshops 15 # open workshop15_design.ipynb
workshops stop # stop the JupyterLab server started by baterm
JupyterLab runs in the background; baterm stays usable. The login URL and token are printed in the terminal. Notebooks can import batem without extra path setup.
Suggested order for each topic:
- Open the lecture:
lectures N - Open the workshop:
workshops N - Answer questions in a separate document (Word, PDF, text, …) with clear references to section/question numbers
- Upload that document to the course platform when required
Running a building simulation
Everything runs inside baterm (GUIs and plots open in separate windows; closing them does not exit the shell).
context load mysite # or: context new
building load myhouse # or: building new
building 3d # optional geometry check
building simulate # annual hourly run (--quick = first 7 days)
building results # HVAC + comfort
building plot # pick time series
building vars # list building variables
export annual_run # Excel hand-off → annual_run.xlsx
Useful next steps:
building edit # Tk form (Lock/Tune for optimize)
building optimize # comfort-first tune of Tune fields
building variation --quick # parametric sweeps
pv load roof # photovoltaic plant
pv simulate
building plot # also offers PV:power_W after pv simulate
enercost # electricity bill (needs building + pv simulate)
Help in the shell: help building, help pv, help naming, manual.
Longer reference: batem/doc/Baterm_User_Manual.md · quick sheet: batem/doc/QUICK_REFERENCE.md.
Working with workshop notebooks
Notebooks opened by workshops use JupyterLab in the browser.
- Text cells — edit, then Shift+Enter to render
- Code cells — Run / Shift+Enter to execute
- Restart & run all — re-run the whole notebook when needed
Interactive Plotly figures:
- Double-click a legend item to isolate a series
- Drag to zoom; use Autoscale to reset
- Hover for point values
Evaluation
You are evaluated on answers to the questions and exercises in the workshops.
Put answers in a separate document and reference question numbers clearly, for example:
Section I., Question 1: (your answer)
Then upload that document to the course platform.
1 maintainer
Metadata
1 maintainer
Release files for batem 0.7.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| batem-0.7.11.tar.gz | 97.9 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| batem-0.7.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 196.1 MB
Release files / batem-0.7.11.tar.gz
| Download URL | batem-0.7.11.tar.gz |
|---|---|
| Size | 97.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
86efab1ab1bf7bad105e042befc8a9626fd63ffb8fff4aec438d4257b444e445
|
|
BLAKE2b-256 checksum How to use checksums |
5f8b53150b9ca1299f07d7cf357f3f3a84ccec72f702615e3ac5bfbf52a104b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.9
|
Release files / batem-0.7.11-py3-none-any.whl
| Download URL | batem-0.7.11-py3-none-any.whl |
|---|---|
| Size | 98.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e7e0d2bca7cb9d6f74a12beb3cf80bdc457cf1a4054606158b553c73113a747b
|
|
BLAKE2b-256 checksum How to use checksums |
bc95bea29d32ba0c586bf501233c2f1476ea0a94e756a7869e7474c5034b1bdb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.9
|
Security for batem 0.7.11
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
