BackboneTools is a Python package for working with Backbone.
Project description
Backbone Tools
Tools to work with input and output data of the energy system modelling framework Backbone.
An important prerequisite is to have GAMS installed on your system, as this packages calls certain GAMS commands through python.
A detailled documentation can be found here: https://backbonetools.readthedocs.io.
Result parameters as DataFrames
This is likely one of the core use cases. The BackboneResult-class enables easy access to all symbols.
from backbonetools.io import BackboneResult
# load result
result = BackboneResult("path/to/result.gdx")
# any symbol is available as DataFrame
gen_df = result.r_gen_gnuft()
gen_df.head()
This may yield something like this:
| grid | node | unit | f | t | Val | |
|---|---|---|---|---|---|---|
| 0 | elec | AT0 0 | AT0 0 CCGT | f00 | 6 | 3295.9 |
| 1 | elec | AT0 0 | AT0 0 CCGT | f00 | 7 | 3295.9 |
| 2 | elec | AT0 0 | AT0 0 CCGT | f00 | 8 | 3295.9 |
| 3 | elec | AT0 0 | AT0 0 CCGT | f00 | 9 | 3295.9 |
| 4 | elec | AT0 0 | AT0 0 CCGT | f00 | 10 | 3295.9 |
Analysing multiple related results
In a similar manner, multiplep results (e.g., from a Sensitivity analyis) can be analysed. To do so, place all result files in a directory and follow these steps.
from backbonetools.io import BackboneScenarioAnalysis
# load all results in a directory
sa = BackboneScenarioAnalysis("path/to/result_dir")
# result symbols are available similarly
sa_gen_df = sa.r_gen_gnuft()
The difference between sa_gen_df and gen_df from above is that sa_gen_df has an additional column indicating to which result file the values adhere.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file backbonetools-2025.0.3.tar.gz.
File metadata
- Download URL: backbonetools-2025.0.3.tar.gz
- Upload date:
- Size: 34.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
acd16c84e0322c1bca1336d4aa36d6be6c56743718f8bc918148f56dfbd7e86e
|
|
| MD5 |
0ddd25e738d92379c74e17e78096ba67
|
|
| BLAKE2b-256 |
ce170e0c07da827d75bf4baf01bf18421d4308d72a0c0b900db6d1abcf16ce62
|
File details
Details for the file backbonetools-2025.0.3-py2.py3-none-any.whl.
File metadata
- Download URL: backbonetools-2025.0.3-py2.py3-none-any.whl
- Upload date:
- Size: 37.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3576ee8a0227205bc5f66bb0240f842cd7d1044e5d4fec9c0d303c6b7aaf73a8
|
|
| MD5 |
201b4f618dfd66a94c01ee0190749d82
|
|
| BLAKE2b-256 |
abd3ee262b5402d1a6ab964c2a7b63fa9c754f8c4f263ce11ed34aeedc1eecaa
|