API
Interface
The interface module provides all the basic functionality of EESR.
read_data()
Read the .json file containing the metrics and metadata.
def read_data(data_path)data_path: String
Path to JSON file containing data.
generate_standard_profile()
def generate_standard_profile(data_path, profile_name, path="compact_report.html", generate_domain=False)data_path: String
Path to JSON file containing data.
profile_name: String
Choice between "std_prof", "sus_prof", and "ee_prof".
graph_data
Data for graph generation.
path: String
Output path.
generate_domain: bool
Whether to include additional data from input file in report
generate_compact_profile()
Same as above, except no graph_data.
to_pdf() & to_image()
Export a HTML report as pdf or image.
def to_image(report, out=None)
def to_pdf(report, out=None)report: String
Path to HTML report.
out: String
Output path. If left as default, output file will use path and name of input file.
opendc_grid_analysis()
Perform grid analysis for an OpenDC simulation using EEWriter.
def opendc_grid_analysis(dc_path, key_path, start, country, out, tz="Europe/Amsterdam", caching=True, green_ratio=None, PUE=1.59)dc_path: String
Path to input energy trace file.
key_path: String
Path to .txt file containing ENTSO-E API key. Can be obtained by requesting from ENSTO-E.
start: pandas.Timestamp
The start time of the DC energy trace. Does not have to match the start time in the trace file.
country: String
Bidding zone (country) where the DC is located. Possible bidding zones can be found on the ENTSO-E transparency website.
out: String
Output path of analysis.
tz: String
caching: bool
Whether to enable caching for data fetching.
green_ratio: float
Percentage of green energy to assume when calculating energy by type. If left blank, naive model is used where proportionality on the grid is kept.
PUE: float
The PUE value of the DC, used for preprocessing.
Last updated