Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backbonetools-2025.0.2.tar.gz (34.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

backbonetools-2025.0.2-py2.py3-none-any.whl (37.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file backbonetools-2025.0.2.tar.gz.

File metadata

  • Download URL: backbonetools-2025.0.2.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

Hashes for backbonetools-2025.0.2.tar.gz
Algorithm Hash digest
SHA256 21e8e7487b99bf16d863f2a7fe4aaf52bbfb4ad55b0a85add9e6ba30e432acd1
MD5 c5ba8cb183b937eb59e8b82ed8faed2f
BLAKE2b-256 d3cfd77641e19fa60eed2ca2f7499675ac072485853f218ae931f89d0a1e871b

See more details on using hashes here.

File details

Details for the file backbonetools-2025.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for backbonetools-2025.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0ae5a25b36c2ddf00c1710fddae6bf324da71e03f264dd53ea3d884376445a47
MD5 befb7cef64f301a0e7c77f9d054d081e
BLAKE2b-256 a685c6d38c15cb15815a1b2fcc590af31cdd39bf72f884788d56c257f6479983

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page