Skip to main content

EnergyPLAN Output Parser/Converter

Since EnergyPLAN's output is the opposite of "easy to parse" for a program, I have created this script to convert it to a handy JSON file. You can use it both as a standalone program to convert the output file to JSON, or import it as a library in your python program and get the data as a standard Python dictionary. In the future, I might also add a CSV output format - although I think it's much less suited for such a structured output.

Installation

$ pip install eplan_parser

Usage as a Standalone Script

$ eplan_parser eplan_output.txt parsed_output.json
 ✓ - Read 8889 lines from "eplan_output.txt"
 ✓ - Parsed CO2 section
 ✓ - Parsed RES Share section
 ✓ - Parsed Fuel Consumption section
 ✓ - Parsed Annual Costs section
 ✓ - Parsed Yearly Totals section
 ✓ - Parsed Hourly Totals section
 ! - Costs overview parsing not yet implemented
 ! - Fuel balance parsing not yet implemented
 ✓ - Exported JSON dataset to "parsed_output.json" - 6.6 Mb (6928567 bytes) written

Usage as a Helper Library

import eplan_parser

# [...]
# Run EnergyPLAN & whatever
# [...]

data = load_dataset("eplan_output.txt")
co2_emission = data['CO2 Emissions']['total']
print(co2_emission)

Compatibility

Tested on EnergyPLAN versions:

  • 16.2

If you've used this script and found it useful, please let me know if you got any errors or had good compatibility, especially if you're using a different version of EnergyPLAN.

Metadata

Release files for eplan-parser 0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eplan-parser 0.7
File Size Uploaded Provenance
eplan_parser-0.7.tar.gz 7.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for eplan-parser 0.7
File Interpreter ABI Platform
eplan_parser-0.7-py3-none-any.whl Python 3 none any Details

Total release size: 15.9 kB

Release files / eplan_parser-0.7.tar.gz

Download URL eplan_parser-0.7.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
03b3ddddb64da41487d73f0e45faddc057c06f619683ad981d745798f8e8d677
BLAKE2b-256 checksum
How to use checksums
721ec8810b72291e59fe051188da46c9563bb7fb13b2a1f8b368c8586606b106
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release files / eplan_parser-0.7-py3-none-any.whl

Download URL eplan_parser-0.7-py3-none-any.whl
Size 8.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a72115b92a13e3d562a2e28b4c69a2d73be8313c68a8a9ad08609335c539b99c
BLAKE2b-256 checksum
How to use checksums
bd42820e6baac4c2303544163925b47e18be0f10ccb94ca697583cecd308efe0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Security for eplan-parser 0.7

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page