diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..23cbbcd --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: fcdc215d0bedfc57a14a8d537aa21449 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/about.doctree b/.doctrees/about.doctree new file mode 100644 index 0000000..59e0d5d Binary files /dev/null and b/.doctrees/about.doctree differ diff --git a/.doctrees/autoapi/aggregate_inputs/index.doctree b/.doctrees/autoapi/aggregate_inputs/index.doctree new file mode 100644 index 0000000..19a421f Binary files /dev/null and b/.doctrees/autoapi/aggregate_inputs/index.doctree differ diff --git a/.doctrees/autoapi/biomass_transport/index.doctree b/.doctrees/autoapi/biomass_transport/index.doctree new file mode 100644 index 0000000..9a2deb7 Binary files /dev/null and b/.doctrees/autoapi/biomass_transport/index.doctree differ diff --git a/.doctrees/autoapi/clustering/index.doctree b/.doctrees/autoapi/clustering/index.doctree new file mode 100644 index 0000000..0571823 Binary files /dev/null and b/.doctrees/autoapi/clustering/index.doctree differ diff --git a/.doctrees/autoapi/create_addon_files/index.doctree b/.doctrees/autoapi/create_addon_files/index.doctree new file mode 100644 index 0000000..bd71d50 Binary files /dev/null and b/.doctrees/autoapi/create_addon_files/index.doctree differ diff --git a/.doctrees/autoapi/create_conversion_dictionaries/index.doctree b/.doctrees/autoapi/create_conversion_dictionaries/index.doctree new file mode 100644 index 0000000..1fa0b0c Binary files /dev/null and b/.doctrees/autoapi/create_conversion_dictionaries/index.doctree differ diff --git a/.doctrees/autoapi/exo_electricity_demand/index.doctree b/.doctrees/autoapi/exo_electricity_demand/index.doctree new file mode 100644 index 0000000..4a180e8 Binary files /dev/null and b/.doctrees/autoapi/exo_electricity_demand/index.doctree differ diff --git a/.doctrees/autoapi/exo_heat_demand/index.doctree b/.doctrees/autoapi/exo_heat_demand/index.doctree new file mode 100644 index 0000000..94f4f35 Binary files /dev/null and b/.doctrees/autoapi/exo_heat_demand/index.doctree differ diff --git a/.doctrees/autoapi/exo_powerplants/index.doctree b/.doctrees/autoapi/exo_powerplants/index.doctree new file mode 100644 index 0000000..9be5240 Binary files /dev/null and b/.doctrees/autoapi/exo_powerplants/index.doctree differ diff --git a/.doctrees/autoapi/format_balmorel_data/index.doctree b/.doctrees/autoapi/format_balmorel_data/index.doctree new file mode 100644 index 0000000..b680678 Binary files /dev/null and b/.doctrees/autoapi/format_balmorel_data/index.doctree differ diff --git a/.doctrees/autoapi/format_dkstat/index.doctree b/.doctrees/autoapi/format_dkstat/index.doctree new file mode 100644 index 0000000..b37b8da Binary files /dev/null and b/.doctrees/autoapi/format_dkstat/index.doctree differ diff --git a/.doctrees/autoapi/format_energinet/index.doctree b/.doctrees/autoapi/format_energinet/index.doctree new file mode 100644 index 0000000..7e65c07 Binary files /dev/null and b/.doctrees/autoapi/format_energinet/index.doctree differ diff --git a/.doctrees/autoapi/format_vpdk21/index.doctree b/.doctrees/autoapi/format_vpdk21/index.doctree new file mode 100644 index 0000000..f883239 Binary files /dev/null and b/.doctrees/autoapi/format_vpdk21/index.doctree differ diff --git a/.doctrees/autoapi/geofiles/index.doctree b/.doctrees/autoapi/geofiles/index.doctree new file mode 100644 index 0000000..a886e1c Binary files /dev/null and b/.doctrees/autoapi/geofiles/index.doctree differ diff --git a/.doctrees/autoapi/geographic_sets/index.doctree b/.doctrees/autoapi/geographic_sets/index.doctree new file mode 100644 index 0000000..6d48419 Binary files /dev/null and b/.doctrees/autoapi/geographic_sets/index.doctree differ diff --git a/.doctrees/autoapi/grids/index.doctree b/.doctrees/autoapi/grids/index.doctree new file mode 100644 index 0000000..a956275 Binary files /dev/null and b/.doctrees/autoapi/grids/index.doctree differ diff --git a/.doctrees/autoapi/heat_profiles/index.doctree b/.doctrees/autoapi/heat_profiles/index.doctree new file mode 100644 index 0000000..12fb2bc Binary files /dev/null and b/.doctrees/autoapi/heat_profiles/index.doctree differ diff --git a/.doctrees/autoapi/index.doctree b/.doctrees/autoapi/index.doctree new file mode 100644 index 0000000..fa17897 Binary files /dev/null and b/.doctrees/autoapi/index.doctree differ diff --git a/.doctrees/autoapi/investment_options/index.doctree b/.doctrees/autoapi/investment_options/index.doctree new file mode 100644 index 0000000..4360864 Binary files /dev/null and b/.doctrees/autoapi/investment_options/index.doctree differ diff --git a/.doctrees/autoapi/municipal_template/index.doctree b/.doctrees/autoapi/municipal_template/index.doctree new file mode 100644 index 0000000..e229fed Binary files /dev/null and b/.doctrees/autoapi/municipal_template/index.doctree differ diff --git a/.doctrees/autoapi/offshore_wind/index.doctree b/.doctrees/autoapi/offshore_wind/index.doctree new file mode 100644 index 0000000..1b96ded Binary files /dev/null and b/.doctrees/autoapi/offshore_wind/index.doctree differ diff --git a/.doctrees/autoapi/onshore_vre_func/index.doctree b/.doctrees/autoapi/onshore_vre_func/index.doctree new file mode 100644 index 0000000..9b174d6 Binary files /dev/null and b/.doctrees/autoapi/onshore_vre_func/index.doctree differ diff --git a/.doctrees/autoapi/plot_dag/index.doctree b/.doctrees/autoapi/plot_dag/index.doctree new file mode 100644 index 0000000..cb139d8 Binary files /dev/null and b/.doctrees/autoapi/plot_dag/index.doctree differ diff --git a/.doctrees/autoapi/technology_data/index.doctree b/.doctrees/autoapi/technology_data/index.doctree new file mode 100644 index 0000000..43c3336 Binary files /dev/null and b/.doctrees/autoapi/technology_data/index.doctree differ diff --git a/.doctrees/autoapi/transport_heavy_demand/index.doctree b/.doctrees/autoapi/transport_heavy_demand/index.doctree new file mode 100644 index 0000000..fe5213f Binary files /dev/null and b/.doctrees/autoapi/transport_heavy_demand/index.doctree differ diff --git a/.doctrees/autoapi/transport_road_demand/index.doctree b/.doctrees/autoapi/transport_road_demand/index.doctree new file mode 100644 index 0000000..8af1b00 Binary files /dev/null and b/.doctrees/autoapi/transport_road_demand/index.doctree differ diff --git a/.doctrees/autoapi/utils/index.doctree b/.doctrees/autoapi/utils/index.doctree new file mode 100644 index 0000000..1a8e0e8 Binary files /dev/null and b/.doctrees/autoapi/utils/index.doctree differ diff --git a/.doctrees/autoapi/vre_profiles/index.doctree b/.doctrees/autoapi/vre_profiles/index.doctree new file mode 100644 index 0000000..00ed506 Binary files /dev/null and b/.doctrees/autoapi/vre_profiles/index.doctree differ diff --git a/.doctrees/chapter1.doctree b/.doctrees/chapter1.doctree new file mode 100644 index 0000000..9f0e106 Binary files /dev/null and b/.doctrees/chapter1.doctree differ diff --git a/.doctrees/chapter1/section1.doctree b/.doctrees/chapter1/section1.doctree new file mode 100644 index 0000000..fbb5a14 Binary files /dev/null and b/.doctrees/chapter1/section1.doctree differ diff --git a/.doctrees/chapter1/section2.doctree b/.doctrees/chapter1/section2.doctree new file mode 100644 index 0000000..7839cc7 Binary files /dev/null and b/.doctrees/chapter1/section2.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 0000000..5054a35 Binary files /dev/null and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 0000000..dd86656 Binary files /dev/null and b/.doctrees/index.doctree differ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/_images/sankey-diagram.png b/_images/sankey-diagram.png new file mode 100644 index 0000000..ae5aaed Binary files /dev/null and b/_images/sankey-diagram.png differ diff --git a/_sources/about.md.txt b/_sources/about.md.txt new file mode 100644 index 0000000..1aae90a --- /dev/null +++ b/_sources/about.md.txt @@ -0,0 +1,3 @@ +# About this code + +This documentation is under construction diff --git a/_sources/autoapi/aggregate_inputs/index.rst.txt b/_sources/autoapi/aggregate_inputs/index.rst.txt new file mode 100644 index 0000000..eabbfdf --- /dev/null +++ b/_sources/autoapi/aggregate_inputs/index.rst.txt @@ -0,0 +1,47 @@ +aggregate_inputs +================ + +.. py:module:: aggregate_inputs + +.. autoapi-nested-parse:: + + Spatial Aggregation of Balmorel + + Loads Balmorel input and aggregates them based on a gis file that includes cluster categories for each of the old region names + + Created on 01.10.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + aggregate_inputs.get_symbols_to_aggregate + aggregate_inputs.merge_RRR_names + aggregate_inputs.merge_IRRRI_names + aggregate_inputs.loop_and_replace_names + aggregate_inputs.aggregate_parameter + aggregate_inputs.aggregate_sets + aggregate_inputs.main + + +Module Contents +--------------- + +.. py:function:: get_symbols_to_aggregate(incfile_folder: str, exceptions: str, mean_aggfuncs: str, median_aggfuncs: str, zero_fillnas: str) + +.. py:function:: merge_RRR_names(df: pandas.DataFrame, clustering: geopandas.GeoDataFrame) + +.. py:function:: merge_IRRRI_names(df: pandas.DataFrame, clustering: geopandas.GeoDataFrame) + +.. py:function:: loop_and_replace_names(df: pandas.DataFrame, clustering: geopandas.GeoDataFrame, old_column: str) + +.. py:function:: aggregate_parameter(db: gams.GamsDatabase, symbol: str, clustering: geopandas.GeoDataFrame, aggfunc: str, unique_names: dict, fillna: Tuple[float, int, str] = 'EPS') + +.. py:function:: aggregate_sets(db: gams.GamsDatabase, symbol: str, clustering: geopandas.GeoDataFrame) + +.. py:function:: main(model_path: str, scenario: str, exceptions: str = '', mean_aggfuncs: str = '', median_aggfuncs: str = '', zero_fillnas: str = '', incfile_folder: str = 'Output') + diff --git a/_sources/autoapi/biomass_transport/index.rst.txt b/_sources/autoapi/biomass_transport/index.rst.txt new file mode 100644 index 0000000..1016623 --- /dev/null +++ b/_sources/autoapi/biomass_transport/index.rst.txt @@ -0,0 +1,44 @@ +biomass_transport +================= + +.. py:module:: biomass_transport + +.. autoapi-nested-parse:: + + TITLE + + Description + + Created on 11.10.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + biomass_transport.CLI + biomass_transport.transport + biomass_transport.plot_style + + +Module Contents +--------------- + +.. py:function:: CLI(ctx, dark_style: bool, plot_ext: str) + + Description of the CLI + + +.. py:function:: transport(transport_cost: float) + + Producing transport costs for fuels + + Args: + transport_cost (_type_): the cost of transport in €/GJ/km + + +.. py:function:: plot_style(ctx, fig: matplotlib.pyplot.figure, ax: matplotlib.pyplot.axes, name: str) + diff --git a/_sources/autoapi/clustering/index.rst.txt b/_sources/autoapi/clustering/index.rst.txt new file mode 100644 index 0000000..b00a408 --- /dev/null +++ b/_sources/autoapi/clustering/index.rst.txt @@ -0,0 +1,66 @@ +clustering +========== + +.. py:module:: clustering + +.. autoapi-nested-parse:: + + TITLE + + Description + + Created on 11.09.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Attributes +---------- + +.. autoapisummary:: + + clustering.cmap + clustering.columns + + +Functions +--------- + +.. autoapisummary:: + + clustering.truncate_colormap + clustering.correct_VRE_data + clustering.convert_municipal_code_to_name + clustering.collect_clusterdata + clustering.apply_filters + clustering.gather_data + clustering.cluster + clustering.new_geofile + clustering.main + + +Module Contents +--------------- + +.. py:data:: cmap + +.. py:function:: truncate_colormap(cmap, minval=0.0, maxval=1.0, n=100) + +.. py:function:: correct_VRE_data(path_to_file, generation_name: str) + +.. py:function:: convert_municipal_code_to_name(to_be_converted: pandas.DataFrame, column_to_convert: Tuple[str, int], pivot_table: bool = False, exclude_regions: list = ['Herlev', 'Christiansø'], muni_geofile_path: str = 'C:\\Users\\mberos\\gitRepos\\balmorel-preprocessing\\src\\Data\\Shapefiles\\Denmark\\Adm\\gadm36_DNK_2.shp') + +.. py:function:: collect_clusterdata(plot_cf: bool = False) + +.. py:function:: apply_filters(df: pandas.DataFrame, value_name: str, aggfunc: str = 'sum') + +.. py:data:: columns + +.. py:function:: gather_data(db: gams.GamsDatabase, cluster_params: list, aggfuncs: list) + +.. py:function:: cluster(collected_data: pandas.DataFrame, n_clusters: int, use_connectivity: bool = True, manual_corrections: list = [['Roedovre', 'Frederiksberg', 1], ['Slagelse', 'Nyborg', 0]], linkage: str = 'Ward', connection_remark: str = 'connec. included + artifical', data_remark: str = 'all combined + xy coords') + +.. py:function:: new_geofile(clustering: geopandas.GeoDataFrame, plot: bool = False) + +.. py:function:: main(model_path: str, scenario: str, cluster_params: str, aggregation_functions: str, cluster_size: int, plot_style: str = 'report') + diff --git a/_sources/autoapi/create_addon_files/index.rst.txt b/_sources/autoapi/create_addon_files/index.rst.txt new file mode 100644 index 0000000..41fdade --- /dev/null +++ b/_sources/autoapi/create_addon_files/index.rst.txt @@ -0,0 +1,37 @@ +create_addon_files +================== + +.. py:module:: create_addon_files + +.. autoapi-nested-parse:: + + Create Empty Sets for Aggregated Model + + The clustered model will include exogenous heat and electricity demands from addons in DE, DE_VAR_T, DH, DH_VAR_T etc. + Thus, this script is needed to 1) create empty files for INDUSTRY_DH, INDIVUSERS_DH etc., + and 2) to create the INDUSTRY_INDUSTRY_AAA and INDIVUSERS_INDIVUSERS_AAA etc. files required for categorising sets. + + Created on 04.10.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + create_addon_files.create_empty_set_files + create_addon_files.create_category_files + create_addon_files.main + + +Module Contents +--------------- + +.. py:function:: create_empty_set_files(addons: list, empty_files: list) + +.. py:function:: create_category_files(addons: list, clustering: geopandas.GeoDataFrame, category_files: list, **kwargs) + +.. py:function:: main(addons: Tuple[list, str] = ['INDUSTRY', 'HYDROGEN', 'INDIVUSERS'], empty_files: Tuple[list, str] = ['DE', 'DE_VAR_T', 'DH', 'DH_VAR_T', 'CCCRRRAAA', 'RRRAAA', 'AAA', 'AGKN', 'DISLOSS_E_AG']) + diff --git a/_sources/autoapi/create_conversion_dictionaries/index.rst.txt b/_sources/autoapi/create_conversion_dictionaries/index.rst.txt new file mode 100644 index 0000000..d12463f --- /dev/null +++ b/_sources/autoapi/create_conversion_dictionaries/index.rst.txt @@ -0,0 +1,30 @@ +create_conversion_dictionaries +============================== + +.. py:module:: create_conversion_dictionaries + +.. autoapi-nested-parse:: + + Is used to convert the easy-to-read-for-non-balmorel-user sets and elements to Balmorel input + + + +Attributes +---------- + +.. autoapisummary:: + + create_conversion_dictionaries.exo_elec_dem_conversion_dictionaries + create_conversion_dictionaries.exo_heat_dem_conversion_dictionaries + create_conversion_dictionaries.exo_grid_conversion_dictionaries + + +Module Contents +--------------- + +.. py:data:: exo_elec_dem_conversion_dictionaries + +.. py:data:: exo_heat_dem_conversion_dictionaries + +.. py:data:: exo_grid_conversion_dictionaries + diff --git a/_sources/autoapi/exo_electricity_demand/index.rst.txt b/_sources/autoapi/exo_electricity_demand/index.rst.txt new file mode 100644 index 0000000..801312a --- /dev/null +++ b/_sources/autoapi/exo_electricity_demand/index.rst.txt @@ -0,0 +1,65 @@ +exo_electricity_demand +====================== + +.. py:module:: exo_electricity_demand + +.. autoapi-nested-parse:: + + Create electricity demand profiles for Denmark + Use Energinet data for municipalities: + https://www.energidataservice.dk/tso-electricity/consumptionindustry + Convert LAU code to municipality name with: + LAU – NUTS 2021, EU-27 and EFTA / available candidate countries + https://ec.europa.eu/eurostat/web/nuts/local-administrative-units + Note: The dataset above also contains population + + Created on 22.08.2024 + + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Attributes +---------- + +.. autoapisummary:: + + exo_electricity_demand.cmap + exo_electricity_demand.style + exo_electricity_demand.fc + + +Functions +--------- + +.. autoapisummary:: + + exo_electricity_demand.main + + +Module Contents +--------------- + +.. py:data:: cmap + +.. py:data:: style + :value: 'report' + + +.. py:data:: fc + :value: 'white' + + +.. py:function:: main(conversion_file: str, el_dataset: str, show_difference: bool = False) + + Main function to process and convert dataset names, and create .inc files. + Args: + conversion_file (str): Path to the file containing conversion mappings. + el_dataset (str): Path to the dataset file to be processed. + show_difference (bool, optional): Flag to indicate whether to print the + dataset before and after conversion. + Defaults to False. + Returns: + None + + diff --git a/_sources/autoapi/exo_heat_demand/index.rst.txt b/_sources/autoapi/exo_heat_demand/index.rst.txt new file mode 100644 index 0000000..5c77be8 --- /dev/null +++ b/_sources/autoapi/exo_heat_demand/index.rst.txt @@ -0,0 +1,95 @@ +exo_heat_demand +=============== + +.. py:module:: exo_heat_demand + +.. autoapi-nested-parse:: + + Exogenous Heat Demands + + Create exogenous heat demands using data from various places + + Created on 20.09.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Attributes +---------- + +.. autoapisummary:: + + exo_heat_demand.cmap + exo_heat_demand.style + exo_heat_demand.fc + + +Classes +------- + +.. autoapisummary:: + + exo_heat_demand.DistrictHeatAAU + + +Functions +--------- + +.. autoapisummary:: + + exo_heat_demand.create_incfile + exo_heat_demand.create_DH + exo_heat_demand.create_INDUSTRY_DH + exo_heat_demand.create_INDIVUSERS_DH + exo_heat_demand.create_INDUSTRY_DH_VAR_T + exo_heat_demand.main + + +Module Contents +--------------- + +.. py:data:: cmap + +.. py:data:: style + :value: 'report' + + +.. py:data:: fc + :value: 'white' + + +.. py:class:: DistrictHeatAAU + + .. py:attribute:: district_heat + + + .. py:attribute:: industry + + + .. py:attribute:: annual_industry_demand + + + .. py:method:: combine_data(plot: bool = False) + + +.. py:function:: create_incfile(unique_processing) + + The general wrapper for creating and saving .inc files, + because the creating of the IncFile class and saving it is the same every time. + The unique processing of the .body content differs, however. + + Args: + unique_processing (func): The unique processing per case + **incfile_kwargs: Keyword arguments to pass to IncFile + + +.. py:function:: create_DH(incfile, new_dataset: xarray.Dataset) + +.. py:function:: create_INDUSTRY_DH(incfile, new_dataset: xarray.Dataset) + +.. py:function:: create_INDIVUSERS_DH(incfile, new_dataset: xarray.Dataset) + +.. py:function:: create_INDUSTRY_DH_VAR_T(incfile, el_new_dataset: xarray.Dataset, A_suffix: str) + +.. py:function:: main(show_difference: bool = False) + diff --git a/_sources/autoapi/exo_powerplants/index.rst.txt b/_sources/autoapi/exo_powerplants/index.rst.txt new file mode 100644 index 0000000..4317f2d --- /dev/null +++ b/_sources/autoapi/exo_powerplants/index.rst.txt @@ -0,0 +1,232 @@ +exo_powerplants +=============== + +.. py:module:: exo_powerplants + +.. autoapi-nested-parse:: + + Created on Fri Nov 25 13:33:33 2022 + + @author: Mathias Berg Rosendal, Research Assistant DTU Management + + Reads the Danish Energy Agency's "Energiproducenttælling" (EPT, includes solar power) + and windturbines datasheet. + + It is converted and aggregated to a GKFX.inc file for Balmorel. + + Download EPT and datasheet for windturbines here: + https://ens.dk/service/statistik-data-noegletal-og-kort/data-oversigt-over-energisektoren + + + +Attributes +---------- + +.. autoapisummary:: + + exo_powerplants.techs + exo_powerplants.T + exo_powerplants.fuels + exo_powerplants.fuels_assumed + exo_powerplants.F + exo_powerplants.units + exo_powerplants.units_assumed + exo_powerplants.U + exo_powerplants.Ymax + exo_powerplants.choice + exo_powerplants.filename_EPT + exo_powerplants.filename_WT + exo_powerplants.f + exo_powerplants.fWT + exo_powerplants.fWT + exo_powerplants.fWT + exo_powerplants.fWT + exo_powerplants.pp + exo_powerplants.pp + exo_powerplants.UTM32 + exo_powerplants.pp + exo_powerplants.newWT + exo_powerplants.pp + exo_powerplants.pp + exo_powerplants.pp + exo_powerplants.pp + exo_powerplants.dt + exo_powerplants.dt_int + exo_powerplants.idx + exo_powerplants.dt_int + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.CHPidx + exo_powerplants.EXTidx + exo_powerplants.idx + exo_powerplants.E + exo_powerplants.idxE + exo_powerplants.pp + exo_powerplants.crs + exo_powerplants.types + exo_powerplants.idx + exo_powerplants.lines + exo_powerplants.new_ax + exo_powerplants.new + exo_powerplants.temp_pp + exo_powerplants.idx + exo_powerplants.idx + exo_powerplants.dist + exo_powerplants.idx + exo_powerplants.GKFX + exo_powerplants.GKFX + exo_powerplants.GKFX + exo_powerplants.Ymin + exo_powerplants.GKFX + exo_powerplants.GKFX + exo_powerplants.dfAsString + + +Module Contents +--------------- + +.. py:data:: techs + +.. py:data:: T + +.. py:data:: fuels + +.. py:data:: fuels_assumed + +.. py:data:: F + +.. py:data:: units + +.. py:data:: units_assumed + +.. py:data:: U + +.. py:data:: Ymax + :value: 2050 + + +.. py:data:: choice + :value: 'DKMunicipalities_names' + + +.. py:data:: filename_EPT + :value: './Data/Powerplants... + + +.. py:data:: filename_WT + :value: './Data/Powerplants (Energistyrelsen)/anlaeg.xlsx' + + +.. py:data:: f + +.. py:data:: fWT + +.. py:data:: fWT + +.. py:data:: fWT + +.. py:data:: fWT + +.. py:data:: pp + +.. py:data:: pp + +.. py:data:: UTM32 + +.. py:data:: pp + +.. py:data:: newWT + +.. py:data:: pp + +.. py:data:: pp + +.. py:data:: pp + +.. py:data:: pp + +.. py:data:: dt + +.. py:data:: dt_int + +.. py:data:: idx + +.. py:data:: dt_int + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: CHPidx + +.. py:data:: EXTidx + +.. py:data:: idx + +.. py:data:: E + +.. py:data:: idxE + +.. py:data:: pp + +.. py:data:: crs + +.. py:data:: types + :value: 'main_fuel' + + +.. py:data:: idx + +.. py:data:: lines + +.. py:data:: new_ax + :value: [] + + +.. py:data:: new + +.. py:data:: temp_pp + +.. py:data:: idx + +.. py:data:: idx + +.. py:data:: dist + +.. py:data:: idx + +.. py:data:: GKFX + +.. py:data:: GKFX + +.. py:data:: GKFX + +.. py:data:: Ymin + +.. py:data:: GKFX + +.. py:data:: GKFX + +.. py:data:: dfAsString + diff --git a/_sources/autoapi/format_balmorel_data/index.rst.txt b/_sources/autoapi/format_balmorel_data/index.rst.txt new file mode 100644 index 0000000..801df62 --- /dev/null +++ b/_sources/autoapi/format_balmorel_data/index.rst.txt @@ -0,0 +1,53 @@ +format_balmorel_data +==================== + +.. py:module:: format_balmorel_data + +.. autoapi-nested-parse:: + + TITLE + + Description + + Created on 24.09.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + format_balmorel_data.main + format_balmorel_data.onshore_vre + format_balmorel_data.grids + format_balmorel_data.biomass_availability + + +Module Contents +--------------- + +.. py:function:: main(ctx, model_path: str, scenario: str, load_again: bool = False) + + CLI to convert Balmorel data from previous studies + + +.. py:function:: onshore_vre(ctx) + + Get onshore VRE profiles from previous study presented at EGU24, https://github.com/Mathias157/balmorel-preprocessing/releases/tag/egu24-poster + + +.. py:function:: grids(ctx) + + Create the connectivity matrix from previous Balmorel run + + +.. py:function:: biomass_availability(ctx, woodpot: float, strawpot: float, biogaspot: float, woodimport: bool) + + Get biomass distribution key from Bramstoft et al 2020, assume total availability. + + Distribution potentials: + Bramstoft, Rasmus, Amalia Pizarro-Alonso, Ida Græsted Jensen, Hans Ravn, and Marie Münster. “Modelling of Renewable Gas and Renewable Liquid Fuels in Future Integrated Energy Systems.” Applied Energy 268 (June 15, 2020): 114869. https://doi.org/10.1016/j.apenergy.2020.114869. + + diff --git a/_sources/autoapi/format_dkstat/index.rst.txt b/_sources/autoapi/format_dkstat/index.rst.txt new file mode 100644 index 0000000..55bbcef --- /dev/null +++ b/_sources/autoapi/format_dkstat/index.rst.txt @@ -0,0 +1,90 @@ +format_dkstat +============= + +.. py:module:: format_dkstat + +.. autoapi-nested-parse:: + + Processing data from Danmarks Statistik + + Link: + https://www.statistikbanken.dk/ + Search for: + - ENEGEO + - ENETYP + - ENE3H with choice H Transport + + Created on 30.08.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Attributes +---------- + +.. autoapisummary:: + + format_dkstat.style + format_dkstat.fc + + +Classes +------- + +.. autoapisummary:: + + format_dkstat.DKSTAT + + +Functions +--------- + +.. autoapisummary:: + + format_dkstat.load_transport_demand + format_dkstat.main + + +Module Contents +--------------- + +.. py:data:: style + :value: 'report' + + +.. py:data:: fc + :value: 'white' + + +.. py:class:: DKSTAT + + .. py:attribute:: f2 + + + .. py:attribute:: index + + + .. py:attribute:: name + :value: 'user' + + + + .. py:attribute:: IND + + + .. py:attribute:: f1 + + +.. py:function:: load_transport_demand(include_bunkering: bool = False) + + Loads Danish transport fuel demand in TWh + + Args: + include_bunkering (bool, optional): Include bunkering demand or not. Defaults to False. + + Returns: + pd.DataFrame: Most important fuel demands from 2000 to 2023 + + +.. py:function:: main(get_transport_demand: bool = False, include_bunkering: bool = False, get_industry_demand: bool = False) + diff --git a/_sources/autoapi/format_energinet/index.rst.txt b/_sources/autoapi/format_energinet/index.rst.txt new file mode 100644 index 0000000..d3383dd --- /dev/null +++ b/_sources/autoapi/format_energinet/index.rst.txt @@ -0,0 +1,34 @@ +format_energinet +================ + +.. py:module:: format_energinet + +.. autoapi-nested-parse:: + + Create electricity demand profiles for Denmark + Use Energinet data for municipalities: + https://www.energidataservice.dk/tso-electricity/consumptionindustry + Convert LAU code to municipality name with: + LAU – NUTS 2021, EU-27 and EFTA / available candidate countries + https://ec.europa.eu/eurostat/web/nuts/local-administrative-units + Note: The dataset above also contains population + + Created on 22.08.2024 + + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + format_energinet.main + + +Module Contents +--------------- + +.. py:function:: main(energinet_data_path: str) + diff --git a/_sources/autoapi/format_vpdk21/index.rst.txt b/_sources/autoapi/format_vpdk21/index.rst.txt new file mode 100644 index 0000000..5ed71d8 --- /dev/null +++ b/_sources/autoapi/format_vpdk21/index.rst.txt @@ -0,0 +1,113 @@ +format_vpdk21 +============= + +.. py:module:: format_vpdk21 + +.. autoapi-nested-parse:: + + Pre-Processing of the Varmeplan 2021 dataset + + Aalborg dataset, can be used to get individual and district heat gross supply: + https://vbn.aau.dk/da/datasets/kommunepakker-varmeplan-danmark-2021 + - Note that heat demand should be combined wrt. the s1-s5 scenarios (sums to 53.95 TWh without heat efficiency investments) + + Assumption for distribution of low-, mid- and high temperatures should probably come from: + Viegand Maagø and Energistyrelsen. ‘Kortlægning Af Energiforbrug Og Opgørelse Af Energisparepotentialer i Produktionserhvervene’, 2022. + See page 8: + “ + - Omkring 45% af forbruget ligger ved temperaturer under 100 ºC – totalt 26.798 TJ/år + - Godt 40% ligger ved temperaturer over 200 ºC – totalt 23.774 TJ/år + - Resten, altså ca. 15%, ligger i intervallet 100 – 200 ºC eller derover + ”, Viegand Maagø and Energistyrelsen, 2022, p. 8 + + One simple, first assumption could be to say that 40-55% is high temperature, + and use that amount of TJ to distribute the sum of TJ in the "over 80C" category + of Aalborg data into high and middle temperature (middle temperature is the remaining over 80C) + - E.g.: + - 59496 TJ/år in total + - 32723 TJ/år for >100 C (55%) + AAU data: + GJ_over_80 17.1217 % 3369.050427 TJ + GJ_60_80C 12.1648 % 2393.687324 TJ + GJ_under_6 70.7135 % 13914.38463 TJ + ..doesn't really fit - maybe the assumption that surplus heat above 80C comes from high, 60-80C from mid and below 60C from low is good enough? + for that to be true: + - 17.1217 + 12.1648 = 29.2865 + - 40 - 29.2865 = 10.7135 + - 10.7135 / 0.7 = 15.305% of GJ_under_6 is high, plus 100% of GJ_60_80C and 100% of GJ_over_80 + - 15% / 0.7 = 21.42857142857143 of GJ_under_6 is mid + - 45% / 0.7 = 64.28571428571429 of GJ_under_6 is low + + Python package requirements: + - xlrd + + Created on 26.08.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Attributes +---------- + +.. autoapisummary:: + + format_vpdk21.style + format_vpdk21.fc + format_vpdk21.merge_example + + +Classes +------- + +.. autoapisummary:: + + format_vpdk21.VPDK21 + + +Functions +--------- + +.. autoapisummary:: + + format_vpdk21.main + + +Module Contents +--------------- + +.. py:data:: style + :value: 'report' + + +.. py:data:: fc + :value: 'white' + + +.. py:class:: VPDK21(scenario: str = 'SUM_GWh_uden_besp') + + .. py:attribute:: files + + + .. py:attribute:: DH + + + .. py:attribute:: IND + + + .. py:attribute:: correct_names + + + .. py:attribute:: temp + + + .. py:attribute:: names + :value: ['year', 'municipality', 'user'] + + + +.. py:function:: main() + +.. py:data:: merge_example + :value: False + + diff --git a/_sources/autoapi/geofiles/index.rst.txt b/_sources/autoapi/geofiles/index.rst.txt new file mode 100644 index 0000000..7cc1a2b --- /dev/null +++ b/_sources/autoapi/geofiles/index.rst.txt @@ -0,0 +1,113 @@ +geofiles +======== + +.. py:module:: geofiles + +.. autoapi-nested-parse:: + + Created on Sat Dec 3 15:33:10 2022 + + @author: mathi + + See the following documentation, for understanding how this script works: + Cutouts: https://atlite.readthedocs.io/en/latest/examples/create_cutout.html + Power potentials: https://atlite.readthedocs.io/en/latest/examples/landuse-availability.html + + + +Attributes +---------- + +.. autoapisummary:: + + geofiles.style + geofiles.fc + + +Functions +--------- + +.. autoapisummary:: + + geofiles.prepared_geofiles + geofiles.calculate_intersects + geofiles.assign_area_to_region + + +Module Contents +--------------- + +.. py:data:: style + :value: 'report' + + +.. py:data:: fc + :value: 'white' + + +.. py:function:: prepared_geofiles(choice: str, plot: bool = False) -> tuple[str, geopandas.GeoDataFrame, str] + + Prepared geofiles for various spatial resolutions + + Parameters + ---------- + choice : str + Currently supports: + + 'DK Municipalities' + + 'NUTS1' + + 'NUTS2' + + 'NUTS3' + + 'Nordpool' + + 'NordpoolReal' + + 'BalmorelVREAreas' + + 'Antbalm' + + + plot : str + Chooses to plot or not + + Returns + ------- + area_names : Array of str + The region names. + + areas : GeoDataFrame + The pre-processed shapefile, including all metadata. + + +.. py:function:: calculate_intersects(areas_inter1: geopandas.GeoDataFrame, areas_inter2: geopandas.GeoDataFrame, sum_total: bool = False) -> pandas.DataFrame + + Calculates intersection of the series of areas_inter2 to each areas_inter1 element + + Args: + areas_inter1 (gpd.GeoDataFrame): _description_ + areas_inter2 (gpd.GeoDataFrame): _description_ + sum_total (bool, optional): _description_. Defaults to False. + + Returns: + pd.DataFrame: _description_ + + +.. py:function:: assign_area_to_region(A: Union[geopandas.GeoSeries, pandas.Series], R: Union[geopandas.GeoSeries, pandas.Series] = gpd.GeoSeries(), A_suffix: str = '_A', R_suffix: str = '', method: str = '', splitstring: str = '_', splitint: int = 0) + + Assigns areas to regions. Defaults to assign the inserted series to itself, by putting + an _A suffix on the A-series + + Args: + A (Union[gpd.GeoSeries, pd.Series]): _description_ + R (Union[gpd.GeoSeries, pd.Series], optional): _description_. Defaults to gpd.GeoDataFrame(). + A_suffix (str, optional): _description_. Defaults to '_A'. + R_suffix (str, optional): _description_. Defaults to ''. + method (str, optional): 'splitstring' or geometries 'within'. Defaults to 'splitstring'. + splitstring (str, optional): _description_. Defaults to '_'. + splitint (int, optional): _description_. Defaults to 0. + + diff --git a/_sources/autoapi/geographic_sets/index.rst.txt b/_sources/autoapi/geographic_sets/index.rst.txt new file mode 100644 index 0000000..fe44328 --- /dev/null +++ b/_sources/autoapi/geographic_sets/index.rst.txt @@ -0,0 +1,35 @@ +geographic_sets +=============== + +.. py:module:: geographic_sets + +.. autoapi-nested-parse:: + + TITLE + + Description + + Created on 24.09.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + geographic_sets.load_set + geographic_sets.format_set + geographic_sets.main + + +Module Contents +--------------- + +.. py:function:: load_set(file: str) + +.. py:function:: format_set(combined_dict: dict, set_dimension: int) + +.. py:function:: main() + diff --git a/_sources/autoapi/grids/index.rst.txt b/_sources/autoapi/grids/index.rst.txt new file mode 100644 index 0000000..a211a8e --- /dev/null +++ b/_sources/autoapi/grids/index.rst.txt @@ -0,0 +1,74 @@ +grids +===== + +.. py:module:: grids + +.. autoapi-nested-parse:: + + Created on Thu Dec 22 22:51:15 2022 + + @author: Mathias Berg Rosendal, PhD, DTU Management + + Use electricity transmission cost data from DEA2021: + https://ens.dk/en/our-services/projections-and-models/technology-data/technology-catalogue-transport-energy + A map of the extisting transmission grids: + https://energinet.dk/media/gqjj2xpk/eksisterende-net-2021.pdf <- DK + + This is used to create demand files for Balmorel. + + Assumption of how much a certain kV of transmission line can transmit of power + comes from: https://wise-answer.com/how-much-power-can-a-transmission-line-carry/ + 765 kV => 2200-2400 MW + 500 kV => 900 MW + 345 kV => 400 MW + *300 kV => 300 MW + *132 kV => 100 MW + *220 kV => 200 MW + GET A BETTER SOURCE!!! Look in power grid course material? + * = derived from three data assumptions (2nd degree assumption) + + + Power grid is manually drawed from: https://energinet.dk/media/ouufo5ll/eksisterende-net-2021.jpeg + NEED automatic source! (ENTSO-E data) + + Works with the environment.yaml distributed in XXX + + + +Attributes +---------- + +.. autoapisummary:: + + grids.run_old_script + + +Functions +--------- + +.. autoapisummary:: + + grids.get_distance_matrix + grids.get_connections + grids.create_grid_incfiles + grids.create_tech_specific_distribution_loss + grids.main + + +Module Contents +--------------- + +.. py:function:: get_distance_matrix(areas: geopandas.GeoDataFrame) + +.. py:function:: get_connections(areas: pandas.DataFrame) + +.. py:function:: create_grid_incfiles(d: pandas.DataFrame, X: pandas.DataFrame, XE_cost: float, XCOST_E: float, XLOSS_E: float, DCOST_E: float, DLOSS_E: float, carrier: str) + +.. py:function:: create_tech_specific_distribution_loss(wind_offshore_loss: dict, nordsoeen_connection: str, industry_loss: float, individual_loss: float) + +.. py:function:: main(nordsoeen_connection: str = 'Esbjerg') + +.. py:data:: run_old_script + :value: False + + diff --git a/_sources/autoapi/heat_profiles/index.rst.txt b/_sources/autoapi/heat_profiles/index.rst.txt new file mode 100644 index 0000000..9c60487 --- /dev/null +++ b/_sources/autoapi/heat_profiles/index.rst.txt @@ -0,0 +1,73 @@ +heat_profiles +============= + +.. py:module:: heat_profiles + +.. autoapi-nested-parse:: + + Generate Heat Demand Timeseries + + Will use temperature coordinates to 1) find average temperatures within polygons, + 2) use heating degree days assumption from Eurostat to generate heat demand profiles based on these timeseries + 3) aggregate this profile with a flat profile for hot water consumption, being 25% of the total profile + + Created on 14.10.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + heat_profiles.CLI + heat_profiles.generate + heat_profiles.aggregate_temperatures + heat_profiles.format_data + heat_profiles.plot_data + heat_profiles.plot_style + heat_profiles.load_profiles_from_balmorel + heat_profiles.heat_profiles_func + + +Module Contents +--------------- + +.. py:function:: CLI(ctx, dark_style: bool, plot_ext: str) + + Description of the CLI + + +.. py:function:: generate(ctx, cutout: str, weather_year: int, plot: bool) + + A command in the CLI + + +.. py:function:: aggregate_temperatures(temperature: xarray.DataArray, geofile: geopandas.GeoDataFrame, aggfunc: str = 'mean') + +.. py:function:: format_data(agg_temperatures: xarray.Dataset, weather_year: int) -> pandas.DataFrame + + Format timeseries to format expected by Balmorel + + Args: + agg_temperatures (xr.Dataset): The dataset with heat demands per municipality + + Returns: + pd.DataFrame: The formatted dataframe, ready for the IncFile class + + +.. py:function:: plot_data(ctx, aggregated_temperatures: xarray.Dataset, data: str) + +.. py:function:: plot_style(ctx, fig: matplotlib.pyplot.figure, ax: matplotlib.pyplot.axes, name: str, legend: bool) + +.. py:function:: load_profiles_from_balmorel(ctx) + +.. py:function:: heat_profiles_func(df) + + Generates heat profiles from previous Balmorel input data + + Args: + df (_type_): The previous profiles input data + + diff --git a/_sources/autoapi/index.rst.txt b/_sources/autoapi/index.rst.txt new file mode 100644 index 0000000..f2ee6d5 --- /dev/null +++ b/_sources/autoapi/index.rst.txt @@ -0,0 +1,36 @@ +API Reference +============= + +This page contains auto-generated API reference documentation [#f1]_. + +.. toctree:: + :titlesonly: + + /autoapi/grids/index + /autoapi/utils/index + /autoapi/geofiles/index + /autoapi/plot_dag/index + /autoapi/clustering/index + /autoapi/vre_profiles/index + /autoapi/format_dkstat/index + /autoapi/heat_profiles/index + /autoapi/offshore_wind/index + /autoapi/format_vpdk21/index + /autoapi/exo_heat_demand/index + /autoapi/exo_powerplants/index + /autoapi/technology_data/index + /autoapi/geographic_sets/index + /autoapi/aggregate_inputs/index + /autoapi/onshore_vre_func/index + /autoapi/format_energinet/index + /autoapi/biomass_transport/index + /autoapi/investment_options/index + /autoapi/create_addon_files/index + /autoapi/municipal_template/index + /autoapi/format_balmorel_data/index + /autoapi/transport_road_demand/index + /autoapi/transport_heavy_demand/index + /autoapi/exo_electricity_demand/index + /autoapi/create_conversion_dictionaries/index + +.. [#f1] Created with `sphinx-autoapi `_ \ No newline at end of file diff --git a/_sources/autoapi/investment_options/index.rst.txt b/_sources/autoapi/investment_options/index.rst.txt new file mode 100644 index 0000000..a11bd89 --- /dev/null +++ b/_sources/autoapi/investment_options/index.rst.txt @@ -0,0 +1,41 @@ +investment_options +================== + +.. py:module:: investment_options + +.. autoapi-nested-parse:: + + TITLE + + Description + + Created on 25.09.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + investment_options.save_symbol_from_all_endofmodel + investment_options.base_AGKN + investment_options.industry_AGKN + investment_options.individual_AGKN + investment_options.main + + +Module Contents +--------------- + +.. py:function:: save_symbol_from_all_endofmodel(symbol: str, columns: list, param_or_set: str, path_to_allendofmodel: str = 'C:\\Users\\mberos\\gitRepos\\Balmorel\\all_endofmodel.gdx') + +.. py:function:: base_AGKN(AGKN: pandas.DataFrame, print_options: bool = False) + +.. py:function:: industry_AGKN(AGKN: pandas.DataFrame, print_options: bool = False) + +.. py:function:: individual_AGKN(AGKN: pandas.DataFrame, print_options: bool = False) + +.. py:function:: main(large_munis: str, medium_munis: str, path_to_allendofmodel: str) + diff --git a/_sources/autoapi/municipal_template/index.rst.txt b/_sources/autoapi/municipal_template/index.rst.txt new file mode 100644 index 0000000..e4424cb --- /dev/null +++ b/_sources/autoapi/municipal_template/index.rst.txt @@ -0,0 +1,75 @@ +municipal_template +================== + +.. py:module:: municipal_template + +.. autoapi-nested-parse:: + + TITLE + + Description + + Created on 28.08.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Attributes +---------- + +.. autoapisummary:: + + municipal_template.style + municipal_template.fc + municipal_template.x + + +Classes +------- + +.. autoapisummary:: + + municipal_template.DataContainer + + +Module Contents +--------------- + +.. py:data:: style + :value: 'report' + + +.. py:data:: fc + :value: 'white' + + +.. py:class:: DataContainer + + .. py:attribute:: muni_geofile + + + .. py:attribute:: correct_names + + + .. py:attribute:: muni + + + .. py:attribute:: temp + + + .. py:attribute:: name + :value: 'municipality' + + + + .. py:attribute:: index + + + .. py:attribute:: centroids + + + .. py:method:: get_polygons(resolution: str = 'muni', coord_system: str = 'geographic') + + +.. py:data:: x + diff --git a/_sources/autoapi/offshore_wind/index.rst.txt b/_sources/autoapi/offshore_wind/index.rst.txt new file mode 100644 index 0000000..1e1af4e --- /dev/null +++ b/_sources/autoapi/offshore_wind/index.rst.txt @@ -0,0 +1,44 @@ +offshore_wind +============= + +.. py:module:: offshore_wind + +.. autoapi-nested-parse:: + + Offshore Wind Definition + + Loads profiles generated with "createVRE.py" + + Created on 27.09.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + offshore_wind.load_profiles + offshore_wind.create_geo_sets + offshore_wind.create_profiles + offshore_wind.create_investment_options + offshore_wind.distribute_offshore_potential + offshore_wind.main + + +Module Contents +--------------- + +.. py:function:: load_profiles(choice: str = 'dkmunicipalities_names', nordsoeen_connection: str = 'Esbjerg', plot: bool = False) + +.. py:function:: create_geo_sets(profiles: xarray.Dataset) + +.. py:function:: create_profiles(profiles: xarray.Dataset, year: int = 2012) + +.. py:function:: create_investment_options(profiles: xarray.Dataset) + +.. py:function:: distribute_offshore_potential(total_potential: float, geofile: geopandas.GeoDataFrame) + +.. py:function:: main(weather_year: int, total_offshore_wind_potential: float, nordsoeen_connection: str = 'Esbjerg') + diff --git a/_sources/autoapi/onshore_vre_func/index.rst.txt b/_sources/autoapi/onshore_vre_func/index.rst.txt new file mode 100644 index 0000000..2d79944 --- /dev/null +++ b/_sources/autoapi/onshore_vre_func/index.rst.txt @@ -0,0 +1,19 @@ +onshore_vre_func +================ + +.. py:module:: onshore_vre_func + + +Functions +--------- + +.. autoapisummary:: + + onshore_vre_func.onshore_vre_func + + +Module Contents +--------------- + +.. py:function:: onshore_vre_func(ctx) + diff --git a/_sources/autoapi/plot_dag/index.rst.txt b/_sources/autoapi/plot_dag/index.rst.txt new file mode 100644 index 0000000..cac18b4 --- /dev/null +++ b/_sources/autoapi/plot_dag/index.rst.txt @@ -0,0 +1,25 @@ +plot_dag +======== + +.. py:module:: plot_dag + +.. autoapi-nested-parse:: + + This requires an installation of graphviz on top of the python package + https://graphviz.org/download/ + + + +Functions +--------- + +.. autoapisummary:: + + plot_dag.main + + +Module Contents +--------------- + +.. py:function:: main(workflow: str, view: bool = False) + diff --git a/_sources/autoapi/technology_data/index.rst.txt b/_sources/autoapi/technology_data/index.rst.txt new file mode 100644 index 0000000..2440938 --- /dev/null +++ b/_sources/autoapi/technology_data/index.rst.txt @@ -0,0 +1,120 @@ +technology_data +=============== + +.. py:module:: technology_data + +.. autoapi-nested-parse:: + + Created on 24/04/2023 + + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + This script creates input data for technoeconomic assumptions. + Most technologies come from the technology catalogue of the Danish Energy Agency: + - District Heating and Power Generation, June 2022 https://ens.dk/en/our-services/projections-and-models/technology-data/technology-data-generation-electricity-and + - Renewable Fuels, March 2023 https://ens.dk/en/our-services/projections-and-models/technology-data/technology-data-renewable-fuels + - Energy Storage, January 2020 https://ens.dk/en/our-services/projections-and-models/technology-data/technology-data-energy-storage + + + +Attributes +---------- + +.. autoapisummary:: + + technology_data.style + technology_data.fc + technology_data.techs_to_add + technology_data.choice + technology_data.y_start + technology_data.y_stop + technology_data.y_step + technology_data.est + technology_data.GDATASTRING1 + technology_data.GDATASTRING2 + technology_data.GDATA + technology_data.eldh2balm + technology_data.eldh2TYPE + technology_data.eldh2TECH + technology_data.felDH + technology_data.areas + technology_data.GDATA + technology_data.y_range + technology_data.idx + technology_data.dfAsString + + +Functions +--------- + +.. autoapisummary:: + + technology_data.get_value + + +Module Contents +--------------- + +.. py:data:: style + :value: 'report' + + +.. py:data:: fc + :value: 'white' + + +.. py:function:: get_value(search_series, search_strings, y0, y1, den, y0_dif) + + Gets value by interpolation + + +.. py:data:: techs_to_add + :value: ['Gas turbine, combined cycle - extraction - natural gas - large'] + + +.. py:data:: choice + :value: 'NordpoolReal' + + +.. py:data:: y_start + :value: 2020 + + +.. py:data:: y_stop + :value: 2050 + + +.. py:data:: y_step + :value: 5 + + +.. py:data:: est + :value: 'ctrl' + + +.. py:data:: GDATASTRING1 + :value: "Generation type Fuel type Cv-value for CHP-Ext Cb-value for CHP Fuel efficiency CH4-factor... + + +.. py:data:: GDATASTRING2 + +.. py:data:: GDATA + +.. py:data:: eldh2balm + +.. py:data:: eldh2TYPE + +.. py:data:: eldh2TECH + +.. py:data:: felDH + +.. py:data:: areas + +.. py:data:: GDATA + +.. py:data:: y_range + +.. py:data:: idx + +.. py:data:: dfAsString + diff --git a/_sources/autoapi/transport_heavy_demand/index.rst.txt b/_sources/autoapi/transport_heavy_demand/index.rst.txt new file mode 100644 index 0000000..7c6bd8a --- /dev/null +++ b/_sources/autoapi/transport_heavy_demand/index.rst.txt @@ -0,0 +1,42 @@ +transport_heavy_demand +====================== + +.. py:module:: transport_heavy_demand + +.. autoapi-nested-parse:: + + Creating input for transport hydrogen demand + + Simple assumptions: + - Just assuming that there's a hydrogen demand where ports are (but will jet fuel be produced here as well? Will shipping fuel?) + - Making a fixed assumption on H2/fuel efficiency from my 2024 paper + E.g. for jet fuel: + TG-FT: No hydrogen demand (need to account for bio consumption!) + TG-FT-H2: 34/55.4=0.614 MWh hydrogen / MWh jet fuel (need to account for bio consumption!) + eFT: 100/42 =2.381 MWh hydrogen / MWh jet fuel (need to account for CCU consumption!) + For shipping fuel: + TG-MeOH: 33.8/82=0.412 MWh hydrogen / MWh MeOH (need to account for bio consumption!) + eMeOH: 100/119=0.840 MWh hydrogen / MWh MeOH (need to account for CCU consumption!) + eNH3: 100/86 =1.163 MWh hydrogen / MWh NH3 + + Created on 27.09.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + transport_heavy_demand.simple_assumptions + transport_heavy_demand.main + + +Module Contents +--------------- + +.. py:function:: simple_assumptions(meoh_per_jetfuel: float, year: int) + +.. py:function:: main(meoh_per_jetfuel: float, jetfuel_demand: float, shipping_demand: float, use_dkstat: bool, year: int) + diff --git a/_sources/autoapi/transport_road_demand/index.rst.txt b/_sources/autoapi/transport_road_demand/index.rst.txt new file mode 100644 index 0000000..361b3b4 --- /dev/null +++ b/_sources/autoapi/transport_road_demand/index.rst.txt @@ -0,0 +1,61 @@ +transport_road_demand +===================== + +.. py:module:: transport_road_demand + +.. autoapi-nested-parse:: + + Created on 22.06.2024 + + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + ASSUMPTIONS: + - Assumes one demand and charging capacity pr. electric vehicle + - Assumes a uniform distribution of EV demand within country regions (very bad for FR15-FR00 and UK00-UKNI) + + + +Classes +------- + +.. autoapisummary:: + + transport_road_demand.FlexDem + + +Functions +--------- + +.. autoapisummary:: + + transport_road_demand.distribute_road_flex_electricity_demand + transport_road_demand.distribute_dkstat_demand + transport_road_demand.main + + +Module Contents +--------------- + +.. py:class:: FlexDem + + .. py:method:: load_traffic_data(path: str = 'Data\\PyPSA-Eur-Sec Data\\emobility', file: str = 'KFZ__count') + + + .. py:method:: create_profile(plot: bool = False) + + + .. py:method:: create_road_demand_from_Nvehicles(demand_pr_vehicle: float = 100 * 52 / 1000, charger_capacity_pr_vehicle: float = 1.5) + + + .. py:method:: create_road_demand_from_dkstat(road_demand: xarray.DataArray) + + + .. py:method:: create_flexdem_incfiles(road_demand: xarray.Dataset, area_choice: str = 'dkmunicipalities_names') + + +.. py:function:: distribute_road_flex_electricity_demand(choice: str = 'dkmunicipalities_names') + +.. py:function:: distribute_dkstat_demand(geo: geopandas.GeoDataFrame, plot: bool = False) + +.. py:function:: main(chargercap: float) + diff --git a/_sources/autoapi/utils/index.rst.txt b/_sources/autoapi/utils/index.rst.txt new file mode 100644 index 0000000..07a11f4 --- /dev/null +++ b/_sources/autoapi/utils/index.rst.txt @@ -0,0 +1,48 @@ +utils +===== + +.. py:module:: utils + +.. autoapi-nested-parse:: + + Utility Functions + + Created on 19.09.2024 + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + + +Functions +--------- + +.. autoapisummary:: + + utils.convert_coordname_elements + utils.convert_names + utils.transform_xrdata + utils.store_balmorel_input + utils.df_set_to_dictionary + utils.save_dict_set + utils.combine_dicts + utils.join_to_gpd + + +Module Contents +--------------- + +.. py:function:: convert_coordname_elements(dataset: Tuple[xarray.Dataset, pandas.DataFrame], dimension_map: dict, element_map: dict, print_before_and_after: bool = False) + +.. py:function:: convert_names(conversion_file: str, dataset: xarray.Dataset, data_variable: str, convert_seasons_and_terms: bool = False) + +.. py:function:: transform_xrdata(xarray: xarray.Dataset, data_variable: str, selection: Tuple[dict, None] = None, sets_to_sum: Tuple[str, list, None] = None) + +.. py:function:: store_balmorel_input(symbol: str, columns: list, balmorel_model_path: str, scenario: str, load_again: bool = False, filter_func: Tuple[None, callable] = None, save: bool = True) + +.. py:function:: df_set_to_dictionary(df: pandas.DataFrame, column: str, suffix: Tuple[str, None] = None, parent_column: Tuple[str, None] = None) -> dict + +.. py:function:: save_dict_set(save_path: str, df: pandas.DataFrame, column: str, suffix: Tuple[str, None] = None, parent_column: Tuple[str, None] = None) + +.. py:function:: combine_dicts(dict_list: list) + +.. py:function:: join_to_gpd(df: pandas.DataFrame, left_col: str, gpd: join_to_gpd.gpd, right_col: str, new_col: list, suffix: Tuple[None, str] = None) + diff --git a/_sources/autoapi/vre_profiles/index.rst.txt b/_sources/autoapi/vre_profiles/index.rst.txt new file mode 100644 index 0000000..7f30097 --- /dev/null +++ b/_sources/autoapi/vre_profiles/index.rst.txt @@ -0,0 +1,41 @@ +vre_profiles +============ + +.. py:module:: vre_profiles + +.. autoapi-nested-parse:: + + Created on Sat Dec 3 15:33:10 2022 + + @author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling) + + See the following documentation, for understanding how atlite works: + Cutouts: https://atlite.readthedocs.io/en/latest/examples/create_cutout.html + Power potentials: https://atlite.readthedocs.io/en/latest/examples/landuse-availability.html + + REQUIRED: + Using ERA5 requires an API-key from Copernicus + 1) Sign up at https://cds.climate.copernicus.eu/#!/home + 2) Create a file called .cdsapirc in your home drive (typically C:/Users/USERNAME) + Copy paste the UID and API key that you got into .cdsapirc in the following format: + url: https://cds.climate.copernicus.eu/api/v2 + key: UID:API + + + +Functions +--------- + +.. autoapisummary:: + + vre_profiles.doLDC + vre_profiles.main + + +Module Contents +--------------- + +.. py:function:: doLDC(file, cols, idx, r, c, title='') + +.. py:function:: main(cutout_path: str, weather_year: int, offshore_profiles: bool = False, nordsoeen_connection: str = 'Esbjerg', overwrite_cutout: bool = False) + diff --git a/_sources/chapter1.md.txt b/_sources/chapter1.md.txt new file mode 100644 index 0000000..5956e85 --- /dev/null +++ b/_sources/chapter1.md.txt @@ -0,0 +1,8 @@ +# Chapter 1 + +```{toctree} +:maxdepth: 1 + +chapter1/section1.md +chapter1/section2.md +``` \ No newline at end of file diff --git a/_sources/chapter1/section1.md.txt b/_sources/chapter1/section1.md.txt new file mode 100644 index 0000000..679eb9b --- /dev/null +++ b/_sources/chapter1/section1.md.txt @@ -0,0 +1,11 @@ +# Section 1 + +See the [Figure](sankey_diagram) below + +:::{figure} ../img/sankey-diagram.png +:name: sankey_diagram +:alt: Sankey Diagram +:width: 100% +:align: center +A sankey diagram! +::: \ No newline at end of file diff --git a/_sources/chapter1/section2.md.txt b/_sources/chapter1/section2.md.txt new file mode 100644 index 0000000..e0277c6 --- /dev/null +++ b/_sources/chapter1/section2.md.txt @@ -0,0 +1,9 @@ +# Section 2 + +:::{warning} +A warning! +::: + +:::{tip} +A tip +::: \ No newline at end of file diff --git a/_sources/index.md.txt b/_sources/index.md.txt new file mode 100644 index 0000000..c02141b --- /dev/null +++ b/_sources/index.md.txt @@ -0,0 +1,17 @@ +# Balmorel Pre-Processing Framework + +```{toctree} +:maxdepth: 1 +:caption: Balmorel Pre-Processing Framework +:hidden: + +chapter1 +``` + +```{toctree} +:maxdepth: 1 +:caption: Reference +:hidden: + +about +``` \ No newline at end of file diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8141580 --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..f316efc --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/check-solid.svg b/_static/check-solid.svg new file mode 100644 index 0000000..92fad4b --- /dev/null +++ b/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/_static/clipboard.min.js b/_static/clipboard.min.js new file mode 100644 index 0000000..54b3c46 --- /dev/null +++ b/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/_static/copybutton.css b/_static/copybutton.css new file mode 100644 index 0000000..f1916ec --- /dev/null +++ b/_static/copybutton.css @@ -0,0 +1,94 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +/* Show the copybutton */ +.highlight:hover button.copybtn, button.copybtn.success { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/_static/copybutton.js b/_static/copybutton.js new file mode 100644 index 0000000..2ea7ff3 --- /dev/null +++ b/_static/copybutton.js @@ -0,0 +1,248 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copier dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for a moment, then changes it back +// We want the timeout of our `success` class to be a bit shorter than the +// tooltip and icon change, so that we can hide the icon before changing back. +var timeoutIcon = 2000; +var timeoutSuccessClass = 1500; + +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + // Remove success a little bit sooner than we change the tooltip + // So that we can use CSS to hide the copybutton first + setTimeout(() => el.classList.remove('success'), timeoutSuccessClass) + setTimeout(() => el.setAttribute('data-tooltip', oldText), timeoutIcon) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, timeoutIcon) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos'; + + let text = filterText(target, exclude); + return formatCopyText(text, '', false, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/_static/copybutton_funcs.js b/_static/copybutton_funcs.js new file mode 100644 index 0000000..dbe1aaa --- /dev/null +++ b/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 0000000..c718cee --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 0000000..19a446a --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/_static/css_options.css b/_static/css_options.css new file mode 100644 index 0000000..d111b7f --- /dev/null +++ b/_static/css_options.css @@ -0,0 +1,18 @@ +/* Changing the ugly purple visited colour to remain blue or white for all links */ +/* Cross references turns grayblue */ +a[class="reference internal"]:visited { + color: #6a8392; +} +a[class="reference external"]:visited { + color: #6a8392; +} + +/* Toctree remains white */ +div[class="wy-side-scroll"] li[class='toctree-l1'] a:visited { + color: white; +} + +/* Home icon turns grayblue */ +ul[class="wy-breadcrumbs"] a:visited { + color: #6a8392; +} \ No newline at end of file diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..4d67807 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..d1f2291 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '0.0.1', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/graphviz.css b/_static/graphviz.css new file mode 100644 index 0000000..027576e --- /dev/null +++ b/_static/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/html5shiv.min.js b/_static/js/html5shiv.min.js new file mode 100644 index 0000000..cd1c674 --- /dev/null +++ b/_static/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/_static/js/theme.js b/_static/js/theme.js new file mode 100644 index 0000000..1fddb6e --- /dev/null +++ b/_static/js/theme.js @@ -0,0 +1 @@ +!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 0000000..84ab303 --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 0000000..b08d58c --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,620 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + "Search finished, found ${resultCount} page(s) matching the search query." + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/about.html b/about.html new file mode 100644 index 0000000..28984e4 --- /dev/null +++ b/about.html @@ -0,0 +1,123 @@ + + + + + + + About this code — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

About this code

+

This documentation is under construction

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/aggregate_inputs/index.html b/autoapi/aggregate_inputs/index.html new file mode 100644 index 0000000..97ad09c --- /dev/null +++ b/autoapi/aggregate_inputs/index.html @@ -0,0 +1,234 @@ + + + + + + + aggregate_inputs — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

aggregate_inputs

+

Spatial Aggregation of Balmorel

+

Loads Balmorel input and aggregates them based on a gis file that includes cluster categories for each of the old region names

+

Created on 01.10.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + +

get_symbols_to_aggregate(incfile_folder, exceptions, ...)

merge_RRR_names(df, clustering)

merge_IRRRI_names(df, clustering)

loop_and_replace_names(df, clustering, old_column)

aggregate_parameter(db, symbol, clustering, aggfunc, ...)

aggregate_sets(db, symbol, clustering)

main(model_path, scenario[, exceptions, ...])

+
+
+

Module Contents

+
+
+aggregate_inputs.get_symbols_to_aggregate(incfile_folder: str, exceptions: str, mean_aggfuncs: str, median_aggfuncs: str, zero_fillnas: str)
+
+ +
+
+aggregate_inputs.merge_RRR_names(df: pandas.DataFrame, clustering: geopandas.GeoDataFrame)
+
+ +
+
+aggregate_inputs.merge_IRRRI_names(df: pandas.DataFrame, clustering: geopandas.GeoDataFrame)
+
+ +
+
+aggregate_inputs.loop_and_replace_names(df: pandas.DataFrame, clustering: geopandas.GeoDataFrame, old_column: str)
+
+ +
+
+aggregate_inputs.aggregate_parameter(db: gams.GamsDatabase, symbol: str, clustering: geopandas.GeoDataFrame, aggfunc: str, unique_names: dict, fillna: Tuple[float, int, str] = 'EPS')
+
+ +
+
+aggregate_inputs.aggregate_sets(db: gams.GamsDatabase, symbol: str, clustering: geopandas.GeoDataFrame)
+
+ +
+
+aggregate_inputs.main(model_path: str, scenario: str, exceptions: str = '', mean_aggfuncs: str = '', median_aggfuncs: str = '', zero_fillnas: str = '', incfile_folder: str = 'Output')
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/biomass_transport/index.html b/autoapi/biomass_transport/index.html new file mode 100644 index 0000000..71266ac --- /dev/null +++ b/autoapi/biomass_transport/index.html @@ -0,0 +1,204 @@ + + + + + + + biomass_transport — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

biomass_transport

+

TITLE

+

Description

+

Created on 11.10.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + +

CLI(ctx, dark_style, plot_ext)

Description of the CLI

transport(transport_cost)

Producing transport costs for fuels

plot_style(ctx, fig, ax, name)

+
+
+

Module Contents

+
+
+biomass_transport.CLI(ctx, dark_style: bool, plot_ext: str)
+

Description of the CLI

+
+ +
+
+biomass_transport.transport(transport_cost: float)
+

Producing transport costs for fuels

+
+
Args:

transport_cost (_type_): the cost of transport in €/GJ/km

+
+
+
+ +
+
+biomass_transport.plot_style(ctx, fig: matplotlib.pyplot.figure, ax: matplotlib.pyplot.axes, name: str)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/clustering/index.html b/autoapi/clustering/index.html new file mode 100644 index 0000000..b9fc2ba --- /dev/null +++ b/autoapi/clustering/index.html @@ -0,0 +1,278 @@ + + + + + + + clustering — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

clustering

+

TITLE

+

Description

+

Created on 11.09.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Attributes

+ + + + + + + + + +

cmap

columns

+
+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

truncate_colormap(cmap[, minval, maxval, n])

correct_VRE_data(path_to_file, generation_name)

convert_municipal_code_to_name(to_be_converted, ...[, ...])

collect_clusterdata([plot_cf])

apply_filters(df, value_name[, aggfunc])

gather_data(db, cluster_params, aggfuncs)

cluster(collected_data, n_clusters[, ...])

new_geofile(clustering[, plot])

main(model_path, scenario, cluster_params, ...[, ...])

+
+
+

Module Contents

+
+
+clustering.cmap
+
+ +
+
+clustering.truncate_colormap(cmap, minval=0.0, maxval=1.0, n=100)
+
+ +
+
+clustering.correct_VRE_data(path_to_file, generation_name: str)
+
+ +
+
+clustering.convert_municipal_code_to_name(to_be_converted: pandas.DataFrame, column_to_convert: Tuple[str, int], pivot_table: bool = False, exclude_regions: list = ['Herlev', 'Christiansø'], muni_geofile_path: str = 'C:\\Users\\mberos\\gitRepos\\balmorel-preprocessing\\src\\Data\\Shapefiles\\Denmark\\Adm\\gadm36_DNK_2.shp')
+
+ +
+
+clustering.collect_clusterdata(plot_cf: bool = False)
+
+ +
+
+clustering.apply_filters(df: pandas.DataFrame, value_name: str, aggfunc: str = 'sum')
+
+ +
+
+clustering.columns
+
+ +
+
+clustering.gather_data(db: gams.GamsDatabase, cluster_params: list, aggfuncs: list)
+
+ +
+
+clustering.cluster(collected_data: pandas.DataFrame, n_clusters: int, use_connectivity: bool = True, manual_corrections: list = [['Roedovre', 'Frederiksberg', 1], ['Slagelse', 'Nyborg', 0]], linkage: str = 'Ward', connection_remark: str = 'connec. included + artifical', data_remark: str = 'all combined + xy coords')
+
+ +
+
+clustering.new_geofile(clustering: geopandas.GeoDataFrame, plot: bool = False)
+
+ +
+
+clustering.main(model_path: str, scenario: str, cluster_params: str, aggregation_functions: str, cluster_size: int, plot_style: str = 'report')
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/create_addon_files/index.html b/autoapi/create_addon_files/index.html new file mode 100644 index 0000000..f46a0d2 --- /dev/null +++ b/autoapi/create_addon_files/index.html @@ -0,0 +1,200 @@ + + + + + + + create_addon_files — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

create_addon_files

+

Create Empty Sets for Aggregated Model

+

The clustered model will include exogenous heat and electricity demands from addons in DE, DE_VAR_T, DH, DH_VAR_T etc. +Thus, this script is needed to 1) create empty files for INDUSTRY_DH, INDIVUSERS_DH etc., +and 2) to create the INDUSTRY_INDUSTRY_AAA and INDIVUSERS_INDIVUSERS_AAA etc. files required for categorising sets.

+

Created on 04.10.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + +

create_empty_set_files(addons, empty_files)

create_category_files(addons, clustering, ...)

main([addons, empty_files])

+
+
+

Module Contents

+
+
+create_addon_files.create_empty_set_files(addons: list, empty_files: list)
+
+ +
+
+create_addon_files.create_category_files(addons: list, clustering: geopandas.GeoDataFrame, category_files: list, **kwargs)
+
+ +
+
+create_addon_files.main(addons: Tuple[list, str] = ['INDUSTRY', 'HYDROGEN', 'INDIVUSERS'], empty_files: Tuple[list, str] = ['DE', 'DE_VAR_T', 'DH', 'DH_VAR_T', 'CCCRRRAAA', 'RRRAAA', 'AAA', 'AGKN', 'DISLOSS_E_AG'])
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/create_conversion_dictionaries/index.html b/autoapi/create_conversion_dictionaries/index.html new file mode 100644 index 0000000..f28ad71 --- /dev/null +++ b/autoapi/create_conversion_dictionaries/index.html @@ -0,0 +1,193 @@ + + + + + + + create_conversion_dictionaries — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

create_conversion_dictionaries

+

Is used to convert the easy-to-read-for-non-balmorel-user sets and elements to Balmorel input

+
+

Attributes

+ + + + + + + + + + + + +

exo_elec_dem_conversion_dictionaries

exo_heat_dem_conversion_dictionaries

exo_grid_conversion_dictionaries

+
+
+

Module Contents

+
+
+create_conversion_dictionaries.exo_elec_dem_conversion_dictionaries
+
+ +
+
+create_conversion_dictionaries.exo_heat_dem_conversion_dictionaries
+
+ +
+
+create_conversion_dictionaries.exo_grid_conversion_dictionaries
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/exo_electricity_demand/index.html b/autoapi/exo_electricity_demand/index.html new file mode 100644 index 0000000..756b138 --- /dev/null +++ b/autoapi/exo_electricity_demand/index.html @@ -0,0 +1,235 @@ + + + + + + + exo_electricity_demand — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

exo_electricity_demand

+

Create electricity demand profiles for Denmark +Use Energinet data for municipalities: +https://www.energidataservice.dk/tso-electricity/consumptionindustry +Convert LAU code to municipality name with: +LAU – NUTS 2021, EU-27 and EFTA / available candidate countries +https://ec.europa.eu/eurostat/web/nuts/local-administrative-units +Note: The dataset above also contains population

+

Created on 22.08.2024

+

@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Attributes

+ + + + + + + + + + + + +

cmap

style

fc

+
+
+

Functions

+ + + + + + +

main(conversion_file, el_dataset[, show_difference])

Main function to process and convert dataset names, and create .inc files.

+
+
+

Module Contents

+
+
+exo_electricity_demand.cmap
+
+ +
+
+exo_electricity_demand.style = 'report'
+
+ +
+
+exo_electricity_demand.fc = 'white'
+
+ +
+
+exo_electricity_demand.main(conversion_file: str, el_dataset: str, show_difference: bool = False)
+
+

Main function to process and convert dataset names, and create .inc files.

+
+
+
Args:

conversion_file (str): Path to the file containing conversion mappings. +el_dataset (str): Path to the dataset file to be processed. +show_difference (bool, optional): Flag to indicate whether to print the

+
+

dataset before and after conversion. +Defaults to False.

+
+
+
Returns:

None

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/exo_heat_demand/index.html b/autoapi/exo_heat_demand/index.html new file mode 100644 index 0000000..ffa0b57 --- /dev/null +++ b/autoapi/exo_heat_demand/index.html @@ -0,0 +1,305 @@ + + + + + + + exo_heat_demand — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

exo_heat_demand

+

Exogenous Heat Demands

+

Create exogenous heat demands using data from various places

+

Created on 20.09.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Attributes

+ + + + + + + + + + + + +

cmap

style

fc

+
+
+

Classes

+ + + + + + +

DistrictHeatAAU

+
+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + +

create_incfile(unique_processing)

The general wrapper for creating and saving .inc files,

create_DH(incfile, new_dataset)

create_INDUSTRY_DH(incfile, new_dataset)

create_INDIVUSERS_DH(incfile, new_dataset)

create_INDUSTRY_DH_VAR_T(incfile, el_new_dataset, A_suffix)

main([show_difference])

+
+
+

Module Contents

+
+
+exo_heat_demand.cmap
+
+ +
+
+exo_heat_demand.style = 'report'
+
+ +
+
+exo_heat_demand.fc = 'white'
+
+ +
+
+class exo_heat_demand.DistrictHeatAAU
+
+
+district_heat
+
+ +
+
+industry
+
+ +
+
+annual_industry_demand
+
+ +
+
+combine_data(plot: bool = False)
+
+ +
+ +
+
+exo_heat_demand.create_incfile(unique_processing)
+

The general wrapper for creating and saving .inc files, +because the creating of the IncFile class and saving it is the same every time. +The unique processing of the .body content differs, however.

+
+
Args:

unique_processing (func): The unique processing per case +**incfile_kwargs: Keyword arguments to pass to IncFile

+
+
+
+ +
+
+exo_heat_demand.create_DH(incfile, new_dataset: xarray.Dataset)
+
+ +
+
+exo_heat_demand.create_INDUSTRY_DH(incfile, new_dataset: xarray.Dataset)
+
+ +
+
+exo_heat_demand.create_INDIVUSERS_DH(incfile, new_dataset: xarray.Dataset)
+
+ +
+
+exo_heat_demand.create_INDUSTRY_DH_VAR_T(incfile, el_new_dataset: xarray.Dataset, A_suffix: str)
+
+ +
+
+exo_heat_demand.main(show_difference: bool = False)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/exo_powerplants/index.html b/autoapi/exo_powerplants/index.html new file mode 100644 index 0000000..3ebf012 --- /dev/null +++ b/autoapi/exo_powerplants/index.html @@ -0,0 +1,741 @@ + + + + + + + exo_powerplants — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

exo_powerplants

+

Created on Fri Nov 25 13:33:33 2022

+

@author: Mathias Berg Rosendal, Research Assistant DTU Management

+

Reads the Danish Energy Agency’s “Energiproducenttælling” (EPT, includes solar power) +and windturbines datasheet.

+

It is converted and aggregated to a GKFX.inc file for Balmorel.

+

Download EPT and datasheet for windturbines here: +https://ens.dk/service/statistik-data-noegletal-og-kort/data-oversigt-over-energisektoren

+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

techs

T

fuels

fuels_assumed

F

units

units_assumed

U

Ymax

choice

filename_EPT

filename_WT

f

fWT

fWT

fWT

fWT

pp

pp

UTM32

pp

newWT

pp

pp

pp

pp

dt

dt_int

idx

dt_int

idx

idx

idx

idx

idx

idx

idx

idx

idx

CHPidx

EXTidx

idx

E

idxE

pp

crs

types

idx

lines

new_ax

new

temp_pp

idx

idx

dist

idx

GKFX

GKFX

GKFX

Ymin

GKFX

GKFX

dfAsString

+
+
+

Module Contents

+
+
+exo_powerplants.techs
+
+ +
+
+exo_powerplants.T
+
+ +
+
+exo_powerplants.fuels
+
+ +
+
+exo_powerplants.fuels_assumed
+
+ +
+
+exo_powerplants.F
+
+ +
+
+exo_powerplants.units
+
+ +
+
+exo_powerplants.units_assumed
+
+ +
+
+exo_powerplants.U
+
+ +
+
+exo_powerplants.Ymax = 2050
+
+ +
+
+exo_powerplants.choice = 'DKMunicipalities_names'
+
+ +
+
+exo_powerplants.filename_EPT = './Data/Powerplants...
+
+ +
+
+exo_powerplants.filename_WT = './Data/Powerplants (Energistyrelsen)/anlaeg.xlsx'
+
+ +
+
+exo_powerplants.f
+
+ +
+
+exo_powerplants.fWT
+
+ +
+
+exo_powerplants.fWT
+
+ +
+
+exo_powerplants.fWT
+
+ +
+
+exo_powerplants.fWT
+
+ +
+
+exo_powerplants.pp
+
+ +
+
+exo_powerplants.pp
+
+ +
+
+exo_powerplants.UTM32
+
+ +
+
+exo_powerplants.pp
+
+ +
+
+exo_powerplants.newWT
+
+ +
+
+exo_powerplants.pp
+
+ +
+
+exo_powerplants.pp
+
+ +
+
+exo_powerplants.pp
+
+ +
+
+exo_powerplants.pp
+
+ +
+
+exo_powerplants.dt
+
+ +
+
+exo_powerplants.dt_int
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.dt_int
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.CHPidx
+
+ +
+
+exo_powerplants.EXTidx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.E
+
+ +
+
+exo_powerplants.idxE
+
+ +
+
+exo_powerplants.pp
+
+ +
+
+exo_powerplants.crs
+
+ +
+
+exo_powerplants.types = 'main_fuel'
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.lines
+
+ +
+
+exo_powerplants.new_ax = []
+
+ +
+
+exo_powerplants.new
+
+ +
+
+exo_powerplants.temp_pp
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.dist
+
+ +
+
+exo_powerplants.idx
+
+ +
+
+exo_powerplants.GKFX
+
+ +
+
+exo_powerplants.GKFX
+
+ +
+
+exo_powerplants.GKFX
+
+ +
+
+exo_powerplants.Ymin
+
+ +
+
+exo_powerplants.GKFX
+
+ +
+
+exo_powerplants.GKFX
+
+ +
+
+exo_powerplants.dfAsString
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/format_balmorel_data/index.html b/autoapi/format_balmorel_data/index.html new file mode 100644 index 0000000..84f7c00 --- /dev/null +++ b/autoapi/format_balmorel_data/index.html @@ -0,0 +1,213 @@ + + + + + + + format_balmorel_data — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

format_balmorel_data

+

TITLE

+

Description

+

Created on 24.09.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + + + + +

main(ctx, model_path, scenario[, load_again])

CLI to convert Balmorel data from previous studies

onshore_vre(ctx)

Get onshore VRE profiles from previous study presented at EGU24, https://github.com/Mathias157/balmorel-preprocessing/releases/tag/egu24-poster

grids(ctx)

Create the connectivity matrix from previous Balmorel run

biomass_availability(ctx, woodpot, strawpot, ...)

Get biomass distribution key from Bramstoft et al 2020, assume total availability.

+
+
+

Module Contents

+
+
+format_balmorel_data.main(ctx, model_path: str, scenario: str, load_again: bool = False)
+

CLI to convert Balmorel data from previous studies

+
+ +
+
+format_balmorel_data.onshore_vre(ctx)
+

Get onshore VRE profiles from previous study presented at EGU24, https://github.com/Mathias157/balmorel-preprocessing/releases/tag/egu24-poster

+
+ +
+
+format_balmorel_data.grids(ctx)
+

Create the connectivity matrix from previous Balmorel run

+
+ +
+
+format_balmorel_data.biomass_availability(ctx, woodpot: float, strawpot: float, biogaspot: float, woodimport: bool)
+

Get biomass distribution key from Bramstoft et al 2020, assume total availability.

+

Distribution potentials: +Bramstoft, Rasmus, Amalia Pizarro-Alonso, Ida Græsted Jensen, Hans Ravn, and Marie Münster. “Modelling of Renewable Gas and Renewable Liquid Fuels in Future Integrated Energy Systems.” Applied Energy 268 (June 15, 2020): 114869. https://doi.org/10.1016/j.apenergy.2020.114869.

+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/format_dkstat/index.html b/autoapi/format_dkstat/index.html new file mode 100644 index 0000000..b25fcf4 --- /dev/null +++ b/autoapi/format_dkstat/index.html @@ -0,0 +1,269 @@ + + + + + + + format_dkstat — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

format_dkstat

+

Processing data from Danmarks Statistik

+

Link: +https://www.statistikbanken.dk/ +Search for: +- ENEGEO +- ENETYP +- ENE3H with choice H Transport

+

Created on 30.08.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Attributes

+ + + + + + + + + +

style

fc

+
+
+

Classes

+ + + + + + +

DKSTAT

+
+
+

Functions

+ + + + + + + + + +

load_transport_demand([include_bunkering])

Loads Danish transport fuel demand in TWh

main([get_transport_demand, include_bunkering, ...])

+
+
+

Module Contents

+
+
+format_dkstat.style = 'report'
+
+ +
+
+format_dkstat.fc = 'white'
+
+ +
+
+class format_dkstat.DKSTAT
+
+
+f2
+
+ +
+
+index
+
+ +
+
+name = 'user'
+
+ +
+
+IND
+
+ +
+
+f1
+
+ +
+ +
+
+format_dkstat.load_transport_demand(include_bunkering: bool = False)
+

Loads Danish transport fuel demand in TWh

+
+
Args:

include_bunkering (bool, optional): Include bunkering demand or not. Defaults to False.

+
+
Returns:

pd.DataFrame: Most important fuel demands from 2000 to 2023

+
+
+
+ +
+
+format_dkstat.main(get_transport_demand: bool = False, include_bunkering: bool = False, get_industry_demand: bool = False)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/format_energinet/index.html b/autoapi/format_energinet/index.html new file mode 100644 index 0000000..7125256 --- /dev/null +++ b/autoapi/format_energinet/index.html @@ -0,0 +1,185 @@ + + + + + + + format_energinet — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

format_energinet

+

Create electricity demand profiles for Denmark +Use Energinet data for municipalities: +https://www.energidataservice.dk/tso-electricity/consumptionindustry +Convert LAU code to municipality name with: +LAU – NUTS 2021, EU-27 and EFTA / available candidate countries +https://ec.europa.eu/eurostat/web/nuts/local-administrative-units +Note: The dataset above also contains population

+

Created on 22.08.2024

+

@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + +

main(energinet_data_path)

+
+
+

Module Contents

+
+
+format_energinet.main(energinet_data_path: str)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/format_vpdk21/index.html b/autoapi/format_vpdk21/index.html new file mode 100644 index 0000000..607f385 --- /dev/null +++ b/autoapi/format_vpdk21/index.html @@ -0,0 +1,291 @@ + + + + + + + format_vpdk21 — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

format_vpdk21

+

Pre-Processing of the Varmeplan 2021 dataset

+

Aalborg dataset, can be used to get individual and district heat gross supply: +https://vbn.aau.dk/da/datasets/kommunepakker-varmeplan-danmark-2021 +- Note that heat demand should be combined wrt. the s1-s5 scenarios (sums to 53.95 TWh without heat efficiency investments)

+

Assumption for distribution of low-, mid- and high temperatures should probably come from: +Viegand Maagø and Energistyrelsen. ‘Kortlægning Af Energiforbrug Og Opgørelse Af Energisparepotentialer i Produktionserhvervene’, 2022. +See page 8: +“ +- Omkring 45% af forbruget ligger ved temperaturer under 100 ºC – totalt 26.798 TJ/år +- Godt 40% ligger ved temperaturer over 200 ºC – totalt 23.774 TJ/år +- Resten, altså ca. 15%, ligger i intervallet 100 – 200 ºC eller derover +”, Viegand Maagø and Energistyrelsen, 2022, p. 8

+

One simple, first assumption could be to say that 40-55% is high temperature, +and use that amount of TJ to distribute the sum of TJ in the “over 80C” category +of Aalborg data into high and middle temperature (middle temperature is the remaining over 80C) +- E.g.: +- 59496 TJ/år in total +- 32723 TJ/år for >100 C (55%) +AAU data: +GJ_over_80 17.1217 % 3369.050427 TJ +GJ_60_80C 12.1648 % 2393.687324 TJ +GJ_under_6 70.7135 % 13914.38463 TJ +..doesn’t really fit - maybe the assumption that surplus heat above 80C comes from high, 60-80C from mid and below 60C from low is good enough? +for that to be true: +- 17.1217 + 12.1648 = 29.2865 +- 40 - 29.2865 = 10.7135 +- 10.7135 / 0.7 = 15.305% of GJ_under_6 is high, plus 100% of GJ_60_80C and 100% of GJ_over_80 +- 15% / 0.7 = 21.42857142857143 of GJ_under_6 is mid +- 45% / 0.7 = 64.28571428571429 of GJ_under_6 is low

+

Python package requirements: +- xlrd

+

Created on 26.08.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Attributes

+ + + + + + + + + + + + +

style

fc

merge_example

+
+
+

Classes

+ + + + + + +

VPDK21

+
+
+

Functions

+ + + + + + +

main()

+
+
+

Module Contents

+
+
+format_vpdk21.style = 'report'
+
+ +
+
+format_vpdk21.fc = 'white'
+
+ +
+
+class format_vpdk21.VPDK21(scenario: str = 'SUM_GWh_uden_besp')
+
+
+files
+
+ +
+
+DH
+
+ +
+
+IND
+
+ +
+
+correct_names
+
+ +
+
+temp
+
+ +
+
+names = ['year', 'municipality', 'user']
+
+ +
+ +
+
+format_vpdk21.main()
+
+ +
+
+format_vpdk21.merge_example = False
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/geofiles/index.html b/autoapi/geofiles/index.html new file mode 100644 index 0000000..45aa25c --- /dev/null +++ b/autoapi/geofiles/index.html @@ -0,0 +1,277 @@ + + + + + + + geofiles — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

geofiles

+

Created on Sat Dec 3 15:33:10 2022

+

@author: mathi

+
+
See the following documentation, for understanding how this script works:

Cutouts: https://atlite.readthedocs.io/en/latest/examples/create_cutout.html +Power potentials: https://atlite.readthedocs.io/en/latest/examples/landuse-availability.html

+
+
+
+

Attributes

+ + + + + + + + + +

style

fc

+
+
+

Functions

+ + + + + + + + + + + + +

prepared_geofiles(→ tuple[str, geopandas.GeoDataFrame, ...)

Prepared geofiles for various spatial resolutions

calculate_intersects(→ pandas.DataFrame)

Calculates intersection of the series of areas_inter2 to each areas_inter1 element

assign_area_to_region(A[, R, A_suffix, R_suffix, ...])

Assigns areas to regions. Defaults to assign the inserted series to itself, by putting

+
+
+

Module Contents

+
+
+geofiles.style = 'report'
+
+ +
+
+geofiles.fc = 'white'
+
+ +
+
+geofiles.prepared_geofiles(choice: str, plot: bool = False) → tuple[str, geopandas.GeoDataFrame, str]
+

Prepared geofiles for various spatial resolutions

+
+

Parameters

+
+
choicestr

Currently supports:

+
+

‘DK Municipalities’

+

‘NUTS1’

+

‘NUTS2’

+

‘NUTS3’

+

‘Nordpool’

+

‘NordpoolReal’

+

‘BalmorelVREAreas’

+

‘Antbalm’

+
+
+
plotstr

Chooses to plot or not

+
+
+
+
+

Returns

+
+
area_namesArray of str

The region names.

+
+
areasGeoDataFrame

The pre-processed shapefile, including all metadata.

+
+
+
+
+ +
+
+geofiles.calculate_intersects(areas_inter1: geopandas.GeoDataFrame, areas_inter2: geopandas.GeoDataFrame, sum_total: bool = False) → pandas.DataFrame
+

Calculates intersection of the series of areas_inter2 to each areas_inter1 element

+
+
Args:

areas_inter1 (gpd.GeoDataFrame): _description_ +areas_inter2 (gpd.GeoDataFrame): _description_ +sum_total (bool, optional): _description_. Defaults to False.

+
+
Returns:

pd.DataFrame: _description_

+
+
+
+ +
+
+geofiles.assign_area_to_region(A: geopandas.GeoSeries | pandas.Series, R: geopandas.GeoSeries | pandas.Series = gpd.GeoSeries(), A_suffix: str = '_A', R_suffix: str = '', method: str = '', splitstring: str = '_', splitint: int = 0)
+

Assigns areas to regions. Defaults to assign the inserted series to itself, by putting +an _A suffix on the A-series

+
+
Args:

A (Union[gpd.GeoSeries, pd.Series]): _description_ +R (Union[gpd.GeoSeries, pd.Series], optional): _description_. Defaults to gpd.GeoDataFrame(). +A_suffix (str, optional): _description_. Defaults to ‘_A’. +R_suffix (str, optional): _description_. Defaults to ‘’. +method (str, optional): ‘splitstring’ or geometries ‘within’. Defaults to ‘splitstring’. +splitstring (str, optional): _description_. Defaults to ‘_’. +splitint (int, optional): _description_. Defaults to 0.

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/geographic_sets/index.html b/autoapi/geographic_sets/index.html new file mode 100644 index 0000000..d076b83 --- /dev/null +++ b/autoapi/geographic_sets/index.html @@ -0,0 +1,198 @@ + + + + + + + geographic_sets — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

geographic_sets

+

TITLE

+

Description

+

Created on 24.09.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + +

load_set(file)

format_set(combined_dict, set_dimension)

main()

+
+
+

Module Contents

+
+
+geographic_sets.load_set(file: str)
+
+ +
+
+geographic_sets.format_set(combined_dict: dict, set_dimension: int)
+
+ +
+
+geographic_sets.main()
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/grids/index.html b/autoapi/grids/index.html new file mode 100644 index 0000000..e6610b5 --- /dev/null +++ b/autoapi/grids/index.html @@ -0,0 +1,249 @@ + + + + + + + grids — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

grids

+

Created on Thu Dec 22 22:51:15 2022

+

@author: Mathias Berg Rosendal, PhD, DTU Management

+

Use electricity transmission cost data from DEA2021: +https://ens.dk/en/our-services/projections-and-models/technology-data/technology-catalogue-transport-energy +A map of the extisting transmission grids: +https://energinet.dk/media/gqjj2xpk/eksisterende-net-2021.pdf <- DK

+

This is used to create demand files for Balmorel.

+

Assumption of how much a certain kV of transmission line can transmit of power +comes from: https://wise-answer.com/how-much-power-can-a-transmission-line-carry/ +765 kV => 2200-2400 MW +500 kV => 900 MW +345 kV => 400 MW +*300 kV => 300 MW +*132 kV => 100 MW +*220 kV => 200 MW +GET A BETTER SOURCE!!! Look in power grid course material? +* = derived from three data assumptions (2nd degree assumption)

+

Power grid is manually drawed from: https://energinet.dk/media/ouufo5ll/eksisterende-net-2021.jpeg +NEED automatic source! (ENTSO-E data)

+

Works with the environment.yaml distributed in XXX

+
+

Attributes

+ + + + + + +

run_old_script

+
+
+

Functions

+ + + + + + + + + + + + + + + + + + +

get_distance_matrix(areas)

get_connections(areas)

create_grid_incfiles(d, X, XE_cost, XCOST_E, XLOSS_E, ...)

create_tech_specific_distribution_loss(...)

main([nordsoeen_connection])

+
+
+

Module Contents

+
+
+grids.get_distance_matrix(areas: geopandas.GeoDataFrame)
+
+ +
+
+grids.get_connections(areas: pandas.DataFrame)
+
+ +
+
+grids.create_grid_incfiles(d: pandas.DataFrame, X: pandas.DataFrame, XE_cost: float, XCOST_E: float, XLOSS_E: float, DCOST_E: float, DLOSS_E: float, carrier: str)
+
+ +
+
+grids.create_tech_specific_distribution_loss(wind_offshore_loss: dict, nordsoeen_connection: str, industry_loss: float, individual_loss: float)
+
+ +
+
+grids.main(nordsoeen_connection: str = 'Esbjerg')
+
+ +
+
+grids.run_old_script = False
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/heat_profiles/index.html b/autoapi/heat_profiles/index.html new file mode 100644 index 0000000..4b62837 --- /dev/null +++ b/autoapi/heat_profiles/index.html @@ -0,0 +1,259 @@ + + + + + + + heat_profiles — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

heat_profiles

+

Generate Heat Demand Timeseries

+

Will use temperature coordinates to 1) find average temperatures within polygons, +2) use heating degree days assumption from Eurostat to generate heat demand profiles based on these timeseries +3) aggregate this profile with a flat profile for hot water consumption, being 25% of the total profile

+

Created on 14.10.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

CLI(ctx, dark_style, plot_ext)

Description of the CLI

generate(ctx, cutout, weather_year, plot)

A command in the CLI

aggregate_temperatures(temperature, geofile[, aggfunc])

format_data(→ pandas.DataFrame)

Format timeseries to format expected by Balmorel

plot_data(ctx, aggregated_temperatures, data)

plot_style(ctx, fig, ax, name, legend)

load_profiles_from_balmorel(ctx)

heat_profiles_func(df)

Generates heat profiles from previous Balmorel input data

+
+
+

Module Contents

+
+
+heat_profiles.CLI(ctx, dark_style: bool, plot_ext: str)
+

Description of the CLI

+
+ +
+
+heat_profiles.generate(ctx, cutout: str, weather_year: int, plot: bool)
+

A command in the CLI

+
+ +
+
+heat_profiles.aggregate_temperatures(temperature: xarray.DataArray, geofile: geopandas.GeoDataFrame, aggfunc: str = 'mean')
+
+ +
+
+heat_profiles.format_data(agg_temperatures: xarray.Dataset, weather_year: int) → pandas.DataFrame
+

Format timeseries to format expected by Balmorel

+
+
Args:

agg_temperatures (xr.Dataset): The dataset with heat demands per municipality

+
+
Returns:

pd.DataFrame: The formatted dataframe, ready for the IncFile class

+
+
+
+ +
+
+heat_profiles.plot_data(ctx, aggregated_temperatures: xarray.Dataset, data: str)
+
+ +
+
+heat_profiles.plot_style(ctx, fig: matplotlib.pyplot.figure, ax: matplotlib.pyplot.axes, name: str, legend: bool)
+
+ +
+
+heat_profiles.load_profiles_from_balmorel(ctx)
+
+ +
+
+heat_profiles.heat_profiles_func(df)
+

Generates heat profiles from previous Balmorel input data

+
+
Args:

df (_type_): The previous profiles input data

+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/index.html b/autoapi/index.html new file mode 100644 index 0000000..b553b1e --- /dev/null +++ b/autoapi/index.html @@ -0,0 +1,187 @@ + + + + + + + API Reference — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/investment_options/index.html b/autoapi/investment_options/index.html new file mode 100644 index 0000000..9ac99e2 --- /dev/null +++ b/autoapi/investment_options/index.html @@ -0,0 +1,216 @@ + + + + + + + investment_options — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

investment_options

+

TITLE

+

Description

+

Created on 25.09.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + + + + + + + +

save_symbol_from_all_endofmodel(symbol, columns, ...)

base_AGKN(AGKN[, print_options])

industry_AGKN(AGKN[, print_options])

individual_AGKN(AGKN[, print_options])

main(large_munis, medium_munis, path_to_allendofmodel)

+
+
+

Module Contents

+
+
+investment_options.save_symbol_from_all_endofmodel(symbol: str, columns: list, param_or_set: str, path_to_allendofmodel: str = 'C:\\Users\\mberos\\gitRepos\\Balmorel\\all_endofmodel.gdx')
+
+ +
+
+investment_options.base_AGKN(AGKN: pandas.DataFrame, print_options: bool = False)
+
+ +
+
+investment_options.industry_AGKN(AGKN: pandas.DataFrame, print_options: bool = False)
+
+ +
+
+investment_options.individual_AGKN(AGKN: pandas.DataFrame, print_options: bool = False)
+
+ +
+
+investment_options.main(large_munis: str, medium_munis: str, path_to_allendofmodel: str)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/municipal_template/index.html b/autoapi/municipal_template/index.html new file mode 100644 index 0000000..cae7f94 --- /dev/null +++ b/autoapi/municipal_template/index.html @@ -0,0 +1,255 @@ + + + + + + + municipal_template — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

municipal_template

+

TITLE

+

Description

+

Created on 28.08.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Attributes

+ + + + + + + + + + + + +

style

fc

x

+
+
+

Classes

+ + + + + + +

DataContainer

+
+
+

Module Contents

+
+
+municipal_template.style = 'report'
+
+ +
+
+municipal_template.fc = 'white'
+
+ +
+
+class municipal_template.DataContainer
+
+
+muni_geofile
+
+ +
+
+correct_names
+
+ +
+
+muni
+
+ +
+
+temp
+
+ +
+
+name = 'municipality'
+
+ +
+
+index
+
+ +
+
+centroids
+
+ +
+
+get_polygons(resolution: str = 'muni', coord_system: str = 'geographic')
+
+ +
+ +
+
+municipal_template.x
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/offshore_wind/index.html b/autoapi/offshore_wind/index.html new file mode 100644 index 0000000..69689c3 --- /dev/null +++ b/autoapi/offshore_wind/index.html @@ -0,0 +1,225 @@ + + + + + + + offshore_wind — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

offshore_wind

+

Offshore Wind Definition

+

Loads profiles generated with “createVRE.py”

+

Created on 27.09.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + +

load_profiles([choice, nordsoeen_connection, plot])

create_geo_sets(profiles)

create_profiles(profiles[, year])

create_investment_options(profiles)

distribute_offshore_potential(total_potential, geofile)

main(weather_year, total_offshore_wind_potential[, ...])

+
+
+

Module Contents

+
+
+offshore_wind.load_profiles(choice: str = 'dkmunicipalities_names', nordsoeen_connection: str = 'Esbjerg', plot: bool = False)
+
+ +
+
+offshore_wind.create_geo_sets(profiles: xarray.Dataset)
+
+ +
+
+offshore_wind.create_profiles(profiles: xarray.Dataset, year: int = 2012)
+
+ +
+
+offshore_wind.create_investment_options(profiles: xarray.Dataset)
+
+ +
+
+offshore_wind.distribute_offshore_potential(total_potential: float, geofile: geopandas.GeoDataFrame)
+
+ +
+
+offshore_wind.main(weather_year: int, total_offshore_wind_potential: float, nordsoeen_connection: str = 'Esbjerg')
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/onshore_vre_func/index.html b/autoapi/onshore_vre_func/index.html new file mode 100644 index 0000000..fd40fdd --- /dev/null +++ b/autoapi/onshore_vre_func/index.html @@ -0,0 +1,176 @@ + + + + + + + onshore_vre_func — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

onshore_vre_func

+
+

Functions

+ + + + + + +

onshore_vre_func(ctx)

+
+
+

Module Contents

+
+
+onshore_vre_func.onshore_vre_func(ctx)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/plot_dag/index.html b/autoapi/plot_dag/index.html new file mode 100644 index 0000000..a62936e --- /dev/null +++ b/autoapi/plot_dag/index.html @@ -0,0 +1,178 @@ + + + + + + + plot_dag — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

plot_dag

+

This requires an installation of graphviz on top of the python package +https://graphviz.org/download/

+
+

Functions

+ + + + + + +

main(workflow[, view])

+
+
+

Module Contents

+
+
+plot_dag.main(workflow: str, view: bool = False)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/technology_data/index.html b/autoapi/technology_data/index.html new file mode 100644 index 0000000..677659c --- /dev/null +++ b/autoapi/technology_data/index.html @@ -0,0 +1,376 @@ + + + + + + + technology_data — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

technology_data

+

Created on 24/04/2023

+

@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+

This script creates input data for technoeconomic assumptions. +Most technologies come from the technology catalogue of the Danish Energy Agency:

+
+
+
+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

style

fc

techs_to_add

choice

y_start

y_stop

y_step

est

GDATASTRING1

GDATASTRING2

GDATA

eldh2balm

eldh2TYPE

eldh2TECH

felDH

areas

GDATA

y_range

idx

dfAsString

+
+
+

Functions

+ + + + + + +

get_value(search_series, search_strings, y0, y1, den, ...)

Gets value by interpolation

+
+
+

Module Contents

+
+
+technology_data.style = 'report'
+
+ +
+
+technology_data.fc = 'white'
+
+ +
+
+technology_data.get_value(search_series, search_strings, y0, y1, den, y0_dif)
+

Gets value by interpolation

+
+ +
+
+technology_data.techs_to_add = ['Gas turbine, combined cycle - extraction - natural gas - large']
+
+ +
+
+technology_data.choice = 'NordpoolReal'
+
+ +
+
+technology_data.y_start = 2020
+
+ +
+
+technology_data.y_stop = 2050
+
+ +
+
+technology_data.y_step = 5
+
+ +
+
+technology_data.est = 'ctrl'
+
+ +
+
+technology_data.GDATASTRING1 = "Generation type Fuel type   Cv-value for CHP-Ext Cb-value for CHP  Fuel efficiency   CH4-factor...
+
+ +
+
+technology_data.GDATASTRING2
+
+ +
+
+technology_data.GDATA
+
+ +
+
+technology_data.eldh2balm
+
+ +
+
+technology_data.eldh2TYPE
+
+ +
+
+technology_data.eldh2TECH
+
+ +
+
+technology_data.felDH
+
+ +
+
+technology_data.areas
+
+ +
+
+technology_data.GDATA
+
+ +
+
+technology_data.y_range
+
+ +
+
+technology_data.idx
+
+ +
+
+technology_data.dfAsString
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/transport_heavy_demand/index.html b/autoapi/transport_heavy_demand/index.html new file mode 100644 index 0000000..74e3e30 --- /dev/null +++ b/autoapi/transport_heavy_demand/index.html @@ -0,0 +1,203 @@ + + + + + + + transport_heavy_demand — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

transport_heavy_demand

+

Creating input for transport hydrogen demand

+

Simple assumptions: +- Just assuming that there’s a hydrogen demand where ports are (but will jet fuel be produced here as well? Will shipping fuel?) +- Making a fixed assumption on H2/fuel efficiency from my 2024 paper

+
+
+
E.g. for jet fuel:

TG-FT: No hydrogen demand (need to account for bio consumption!) +TG-FT-H2: 34/55.4=0.614 MWh hydrogen / MWh jet fuel (need to account for bio consumption!) +eFT: 100/42 =2.381 MWh hydrogen / MWh jet fuel (need to account for CCU consumption!)

+
+
For shipping fuel:

TG-MeOH: 33.8/82=0.412 MWh hydrogen / MWh MeOH (need to account for bio consumption!) +eMeOH: 100/119=0.840 MWh hydrogen / MWh MeOH (need to account for CCU consumption!) +eNH3: 100/86 =1.163 MWh hydrogen / MWh NH3

+
+
+
+

Created on 27.09.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + +

simple_assumptions(meoh_per_jetfuel, year)

main(meoh_per_jetfuel, jetfuel_demand, ...)

+
+
+

Module Contents

+
+
+transport_heavy_demand.simple_assumptions(meoh_per_jetfuel: float, year: int)
+
+ +
+
+transport_heavy_demand.main(meoh_per_jetfuel: float, jetfuel_demand: float, shipping_demand: float, use_dkstat: bool, year: int)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/transport_road_demand/index.html b/autoapi/transport_road_demand/index.html new file mode 100644 index 0000000..8d0ac0d --- /dev/null +++ b/autoapi/transport_road_demand/index.html @@ -0,0 +1,241 @@ + + + + + + + transport_road_demand — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

transport_road_demand

+

Created on 22.06.2024

+

@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+

ASSUMPTIONS: +- Assumes one demand and charging capacity pr. electric vehicle +- Assumes a uniform distribution of EV demand within country regions (very bad for FR15-FR00 and UK00-UKNI)

+
+

Classes

+ + + + + + +

FlexDem

+
+
+

Functions

+ + + + + + + + + + + + +

distribute_road_flex_electricity_demand([choice])

distribute_dkstat_demand(geo[, plot])

main(chargercap)

+
+
+

Module Contents

+
+
+class transport_road_demand.FlexDem
+
+
+load_traffic_data(path: str = 'Data\\PyPSA-Eur-Sec Data\\emobility', file: str = 'KFZ__count')
+
+ +
+
+create_profile(plot: bool = False)
+
+ +
+
+create_road_demand_from_Nvehicles(demand_pr_vehicle: float = 100 * 52 / 1000, charger_capacity_pr_vehicle: float = 1.5)
+
+ +
+
+create_road_demand_from_dkstat(road_demand: xarray.DataArray)
+
+ +
+
+create_flexdem_incfiles(road_demand: xarray.Dataset, area_choice: str = 'dkmunicipalities_names')
+
+ +
+ +
+
+transport_road_demand.distribute_road_flex_electricity_demand(choice: str = 'dkmunicipalities_names')
+
+ +
+
+transport_road_demand.distribute_dkstat_demand(geo: geopandas.GeoDataFrame, plot: bool = False)
+
+ +
+
+transport_road_demand.main(chargercap: float)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/utils/index.html b/autoapi/utils/index.html new file mode 100644 index 0000000..1057655 --- /dev/null +++ b/autoapi/utils/index.html @@ -0,0 +1,242 @@ + + + + + + + utils — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

utils

+

Utility Functions

+

Created on 19.09.2024 +@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

convert_coordname_elements(dataset, dimension_map, ...)

convert_names(conversion_file, dataset, data_variable)

transform_xrdata(xarray, data_variable[, selection, ...])

store_balmorel_input(symbol, columns, ...[, ...])

df_set_to_dictionary(→ dict)

save_dict_set(save_path, df, column[, suffix, ...])

combine_dicts(dict_list)

join_to_gpd(df, left_col, gpd, right_col, new_col[, ...])

+
+
+

Module Contents

+
+
+utils.convert_coordname_elements(dataset: Tuple[xarray.Dataset, pandas.DataFrame], dimension_map: dict, element_map: dict, print_before_and_after: bool = False)
+
+ +
+
+utils.convert_names(conversion_file: str, dataset: xarray.Dataset, data_variable: str, convert_seasons_and_terms: bool = False)
+
+ +
+
+utils.transform_xrdata(xarray: xarray.Dataset, data_variable: str, selection: Tuple[dict, None] = None, sets_to_sum: Tuple[str, list, None] = None)
+
+ +
+
+utils.store_balmorel_input(symbol: str, columns: list, balmorel_model_path: str, scenario: str, load_again: bool = False, filter_func: Tuple[None, callable] = None, save: bool = True)
+
+ +
+
+utils.df_set_to_dictionary(df: pandas.DataFrame, column: str, suffix: Tuple[str, None] = None, parent_column: Tuple[str, None] = None) → dict
+
+ +
+
+utils.save_dict_set(save_path: str, df: pandas.DataFrame, column: str, suffix: Tuple[str, None] = None, parent_column: Tuple[str, None] = None)
+
+ +
+
+utils.combine_dicts(dict_list: list)
+
+ +
+
+utils.join_to_gpd(df: pandas.DataFrame, left_col: str, gpd: join_to_gpd.gpd, right_col: str, new_col: list, suffix: Tuple[None, str] = None)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/vre_profiles/index.html b/autoapi/vre_profiles/index.html new file mode 100644 index 0000000..05dd385 --- /dev/null +++ b/autoapi/vre_profiles/index.html @@ -0,0 +1,201 @@ + + + + + + + vre_profiles — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

vre_profiles

+

Created on Sat Dec 3 15:33:10 2022

+

@author: Mathias Berg Rosendal, PhD Student at DTU Management (Energy Economics & Modelling)

+
+
See the following documentation, for understanding how atlite works:

Cutouts: https://atlite.readthedocs.io/en/latest/examples/create_cutout.html +Power potentials: https://atlite.readthedocs.io/en/latest/examples/landuse-availability.html

+
+
REQUIRED:

Using ERA5 requires an API-key from Copernicus +1) Sign up at https://cds.climate.copernicus.eu/#!/home +2) Create a file called .cdsapirc in your home drive (typically C:/Users/USERNAME)

+
+

Copy paste the UID and API key that you got into .cdsapirc in the following format: +url: https://cds.climate.copernicus.eu/api/v2 +key: UID:API

+
+
+
+
+

Functions

+ + + + + + + + + +

doLDC(file, cols, idx, r, c[, title])

main(cutout_path, weather_year[, offshore_profiles, ...])

+
+
+

Module Contents

+
+
+vre_profiles.doLDC(file, cols, idx, r, c, title='')
+
+ +
+
+vre_profiles.main(cutout_path: str, weather_year: int, offshore_profiles: bool = False, nordsoeen_connection: str = 'Esbjerg', overwrite_cutout: bool = False)
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/chapter1.html b/chapter1.html new file mode 100644 index 0000000..8156d55 --- /dev/null +++ b/chapter1.html @@ -0,0 +1,132 @@ + + + + + + + Chapter 1 — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Chapter 1

+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/chapter1/section1.html b/chapter1/section1.html new file mode 100644 index 0000000..83e1df5 --- /dev/null +++ b/chapter1/section1.html @@ -0,0 +1,134 @@ + + + + + + + Section 1 — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Section 1

+

See the Figure below

+
+Sankey Diagram +
+

A sankey diagram!

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/chapter1/section2.html b/chapter1/section2.html new file mode 100644 index 0000000..641e11d --- /dev/null +++ b/chapter1/section2.html @@ -0,0 +1,135 @@ + + + + + + + Section 2 — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Section 2

+
+

Warning

+

A warning!

+
+
+

Tip

+

A tip

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 0000000..a3ad14f --- /dev/null +++ b/genindex.html @@ -0,0 +1,961 @@ + + + + + + Index — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Index
    • +
  • +
    • +
+
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | F + | G + | H + | I + | J + | L + | M + | N + | O + | P + | R + | S + | T + | U + | V + | X + | Y + +
+

A

+ + + +
+ +

B

+ + + +
    +
  • + biomass_transport + +
    • +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
    +
  • + heat_profiles + +
    • +
+ +

I

+ + + +
+ +

J

+ + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

R

+ + +
+ +

S

+ + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + + +
    +
  • + vre_profiles + +
    • +
+ +

X

+ + +
+ +

Y

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2024, Mathias Berg Rosendal.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..a9ed4e8 --- /dev/null +++ b/index.html @@ -0,0 +1,124 @@ + + + + + + + Balmorel Pre-Processing Framework — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Balmorel Pre-Processing Framework

+
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000..32f0229 Binary files /dev/null and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html new file mode 100644 index 0000000..780de07 --- /dev/null +++ b/py-modindex.html @@ -0,0 +1,313 @@ + + + + + + Python Module Index — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python Module Index
    • +
  • +
    • +
+
+
+
+
+ + +

Python Module Index

+ +
+ a | + b | + c | + e | + f | + g | + h | + i | + m | + o | + p | + t | + u | + v +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ a
+ aggregate_inputs +
 
+ b
+ biomass_transport +
 
+ c
+ clustering +
+ create_addon_files +
+ create_conversion_dictionaries +
 
+ e
+ exo_electricity_demand +
+ exo_heat_demand +
+ exo_powerplants +
 
+ f
+ format_balmorel_data +
+ format_dkstat +
+ format_energinet +
+ format_vpdk21 +
 
+ g
+ geofiles +
+ geographic_sets +
+ grids +
 
+ h
+ heat_profiles +
 
+ i
+ investment_options +
 
+ m
+ municipal_template +
 
+ o
+ offshore_wind +
+ onshore_vre_func +
 
+ p
+ plot_dag +
 
+ t
+ technology_data +
+ transport_heavy_demand +
+ transport_road_demand +
 
+ u
+ utils +
 
+ v
+ vre_profiles +
+ + +
+
+
+ +
+ +
+

© Copyright 2024, Mathias Berg Rosendal.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 0000000..70929df --- /dev/null +++ b/search.html @@ -0,0 +1,133 @@ + + + + + + Search — Balmorel Pre-Processing Framework 0.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2024, Mathias Berg Rosendal.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..3cc2a74 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"API Reference": [[17, null]], "About this code": [[0, null]], "Attributes": [[3, "attributes"], [5, "attributes"], [6, "attributes"], [7, "attributes"], [8, "attributes"], [10, "attributes"], [12, "attributes"], [13, "attributes"], [15, "attributes"], [19, "attributes"], [23, "attributes"]], "Balmorel Pre-Processing Framework": [[31, null]], "Chapter 1": [[28, null]], "Classes": [[7, "classes"], [10, "classes"], [12, "classes"], [19, "classes"], [25, "classes"]], "Functions": [[1, "functions"], [2, "functions"], [3, "functions"], [4, "functions"], [6, "functions"], [7, "functions"], [9, "functions"], [10, "functions"], [11, "functions"], [12, "functions"], [13, "functions"], [14, "functions"], [15, "functions"], [16, "functions"], [18, "functions"], [20, "functions"], [21, "functions"], [22, "functions"], [23, "functions"], [24, "functions"], [25, "functions"], [26, "functions"], [27, "functions"]], "Module Contents": [[1, "module-contents"], [2, "module-contents"], [3, "module-contents"], [4, "module-contents"], [5, "module-contents"], [6, "module-contents"], [7, "module-contents"], [8, "module-contents"], [9, "module-contents"], [10, "module-contents"], [11, "module-contents"], [12, "module-contents"], [13, "module-contents"], [14, "module-contents"], [15, "module-contents"], [16, "module-contents"], [18, "module-contents"], [19, "module-contents"], [20, "module-contents"], [21, "module-contents"], [22, "module-contents"], [23, "module-contents"], [24, "module-contents"], [25, "module-contents"], [26, "module-contents"], [27, "module-contents"]], "Parameters": [[13, "parameters"]], "Returns": [[13, "returns"]], "Section 1": [[29, null]], "Section 2": [[30, null]], "aggregate_inputs": [[1, null]], "biomass_transport": [[2, null]], "clustering": [[3, null]], "create_addon_files": [[4, null]], "create_conversion_dictionaries": [[5, null]], "exo_electricity_demand": [[6, null]], "exo_heat_demand": [[7, null]], "exo_powerplants": [[8, null]], "format_balmorel_data": [[9, null]], "format_dkstat": [[10, null]], "format_energinet": [[11, null]], "format_vpdk21": [[12, null]], "geofiles": [[13, null]], "geographic_sets": [[14, null]], "grids": [[15, null]], "heat_profiles": [[16, null]], "investment_options": [[18, null]], "municipal_template": [[19, null]], "offshore_wind": [[20, null]], "onshore_vre_func": [[21, null]], "plot_dag": [[22, null]], "technology_data": [[23, null]], "transport_heavy_demand": [[24, null]], "transport_road_demand": [[25, null]], "utils": [[26, null]], "vre_profiles": [[27, null]]}, "docnames": ["about", "autoapi/aggregate_inputs/index", "autoapi/biomass_transport/index", "autoapi/clustering/index", "autoapi/create_addon_files/index", "autoapi/create_conversion_dictionaries/index", "autoapi/exo_electricity_demand/index", "autoapi/exo_heat_demand/index", "autoapi/exo_powerplants/index", "autoapi/format_balmorel_data/index", "autoapi/format_dkstat/index", "autoapi/format_energinet/index", "autoapi/format_vpdk21/index", "autoapi/geofiles/index", "autoapi/geographic_sets/index", "autoapi/grids/index", "autoapi/heat_profiles/index", "autoapi/index", "autoapi/investment_options/index", "autoapi/municipal_template/index", "autoapi/offshore_wind/index", "autoapi/onshore_vre_func/index", "autoapi/plot_dag/index", "autoapi/technology_data/index", "autoapi/transport_heavy_demand/index", "autoapi/transport_road_demand/index", "autoapi/utils/index", "autoapi/vre_profiles/index", "chapter1", "chapter1/section1", "chapter1/section2", "index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["about.md", "autoapi/aggregate_inputs/index.rst", "autoapi/biomass_transport/index.rst", "autoapi/clustering/index.rst", "autoapi/create_addon_files/index.rst", "autoapi/create_conversion_dictionaries/index.rst", "autoapi/exo_electricity_demand/index.rst", "autoapi/exo_heat_demand/index.rst", "autoapi/exo_powerplants/index.rst", "autoapi/format_balmorel_data/index.rst", "autoapi/format_dkstat/index.rst", "autoapi/format_energinet/index.rst", "autoapi/format_vpdk21/index.rst", "autoapi/geofiles/index.rst", "autoapi/geographic_sets/index.rst", "autoapi/grids/index.rst", "autoapi/heat_profiles/index.rst", "autoapi/index.rst", "autoapi/investment_options/index.rst", "autoapi/municipal_template/index.rst", "autoapi/offshore_wind/index.rst", "autoapi/onshore_vre_func/index.rst", "autoapi/plot_dag/index.rst", "autoapi/technology_data/index.rst", "autoapi/transport_heavy_demand/index.rst", "autoapi/transport_road_demand/index.rst", "autoapi/utils/index.rst", "autoapi/vre_profiles/index.rst", "chapter1.md", "chapter1/section1.md", "chapter1/section2.md", "index.md"], "indexentries": {"aggregate_inputs": [[1, "module-aggregate_inputs", false]], "aggregate_parameter() (in module aggregate_inputs)": [[1, "aggregate_inputs.aggregate_parameter", false]], "aggregate_sets() (in module aggregate_inputs)": [[1, "aggregate_inputs.aggregate_sets", false]], "aggregate_temperatures() (in module heat_profiles)": [[16, "heat_profiles.aggregate_temperatures", false]], "annual_industry_demand (exo_heat_demand.districtheataau attribute)": [[7, "exo_heat_demand.DistrictHeatAAU.annual_industry_demand", false]], "apply_filters() (in module clustering)": [[3, "clustering.apply_filters", false]], "areas (in module technology_data)": [[23, "technology_data.areas", false]], "assign_area_to_region() (in module geofiles)": [[13, "geofiles.assign_area_to_region", false]], "base_agkn() (in module investment_options)": [[18, "investment_options.base_AGKN", false]], "biomass_availability() (in module format_balmorel_data)": [[9, "format_balmorel_data.biomass_availability", false]], "biomass_transport": [[2, "module-biomass_transport", false]], "calculate_intersects() (in module geofiles)": [[13, "geofiles.calculate_intersects", false]], "centroids (municipal_template.datacontainer attribute)": [[19, "municipal_template.DataContainer.centroids", false]], "choice (in module exo_powerplants)": [[8, "exo_powerplants.choice", false]], "choice (in module technology_data)": [[23, "technology_data.choice", false]], "chpidx (in module exo_powerplants)": [[8, "exo_powerplants.CHPidx", false]], "cli() (in module biomass_transport)": [[2, "biomass_transport.CLI", false]], "cli() (in module heat_profiles)": [[16, "heat_profiles.CLI", false]], "cluster() (in module clustering)": [[3, "clustering.cluster", false]], "clustering": [[3, "module-clustering", false]], "cmap (in module clustering)": [[3, "clustering.cmap", false]], "cmap (in module exo_electricity_demand)": [[6, "exo_electricity_demand.cmap", false]], "cmap (in module exo_heat_demand)": [[7, "exo_heat_demand.cmap", false]], "collect_clusterdata() (in module clustering)": [[3, "clustering.collect_clusterdata", false]], "columns (in module clustering)": [[3, "clustering.columns", false]], "combine_data() (exo_heat_demand.districtheataau method)": [[7, "exo_heat_demand.DistrictHeatAAU.combine_data", false]], "combine_dicts() (in module utils)": [[26, "utils.combine_dicts", false]], "convert_coordname_elements() (in module utils)": [[26, "utils.convert_coordname_elements", false]], "convert_municipal_code_to_name() (in module clustering)": [[3, "clustering.convert_municipal_code_to_name", false]], "convert_names() (in module utils)": [[26, "utils.convert_names", false]], "correct_names (format_vpdk21.vpdk21 attribute)": [[12, "format_vpdk21.VPDK21.correct_names", false]], "correct_names (municipal_template.datacontainer attribute)": [[19, "municipal_template.DataContainer.correct_names", false]], "correct_vre_data() (in module clustering)": [[3, "clustering.correct_VRE_data", false]], "create_addon_files": [[4, "module-create_addon_files", false]], "create_category_files() (in module create_addon_files)": [[4, "create_addon_files.create_category_files", false]], "create_conversion_dictionaries": [[5, "module-create_conversion_dictionaries", false]], "create_dh() (in module exo_heat_demand)": [[7, "exo_heat_demand.create_DH", false]], "create_empty_set_files() (in module create_addon_files)": [[4, "create_addon_files.create_empty_set_files", false]], "create_flexdem_incfiles() (transport_road_demand.flexdem method)": [[25, "transport_road_demand.FlexDem.create_flexdem_incfiles", false]], "create_geo_sets() (in module offshore_wind)": [[20, "offshore_wind.create_geo_sets", false]], "create_grid_incfiles() (in module grids)": [[15, "grids.create_grid_incfiles", false]], "create_incfile() (in module exo_heat_demand)": [[7, "exo_heat_demand.create_incfile", false]], "create_indivusers_dh() (in module exo_heat_demand)": [[7, "exo_heat_demand.create_INDIVUSERS_DH", false]], "create_industry_dh() (in module exo_heat_demand)": [[7, "exo_heat_demand.create_INDUSTRY_DH", false]], "create_industry_dh_var_t() (in module exo_heat_demand)": [[7, "exo_heat_demand.create_INDUSTRY_DH_VAR_T", false]], "create_investment_options() (in module offshore_wind)": [[20, "offshore_wind.create_investment_options", false]], "create_profile() (transport_road_demand.flexdem method)": [[25, "transport_road_demand.FlexDem.create_profile", false]], "create_profiles() (in module offshore_wind)": [[20, "offshore_wind.create_profiles", false]], "create_road_demand_from_dkstat() (transport_road_demand.flexdem method)": [[25, "transport_road_demand.FlexDem.create_road_demand_from_dkstat", false]], "create_road_demand_from_nvehicles() (transport_road_demand.flexdem method)": [[25, "transport_road_demand.FlexDem.create_road_demand_from_Nvehicles", false]], "create_tech_specific_distribution_loss() (in module grids)": [[15, "grids.create_tech_specific_distribution_loss", false]], "crs (in module exo_powerplants)": [[8, "exo_powerplants.crs", false]], "datacontainer (class in municipal_template)": [[19, "municipal_template.DataContainer", false]], "df_set_to_dictionary() (in module utils)": [[26, "utils.df_set_to_dictionary", false]], "dfasstring (in module exo_powerplants)": [[8, "exo_powerplants.dfAsString", false]], "dfasstring (in module technology_data)": [[23, "technology_data.dfAsString", false]], "dh (format_vpdk21.vpdk21 attribute)": [[12, "format_vpdk21.VPDK21.DH", false]], "dist (in module exo_powerplants)": [[8, "exo_powerplants.dist", false]], "distribute_dkstat_demand() (in module transport_road_demand)": [[25, "transport_road_demand.distribute_dkstat_demand", false]], "distribute_offshore_potential() (in module offshore_wind)": [[20, "offshore_wind.distribute_offshore_potential", false]], "distribute_road_flex_electricity_demand() (in module transport_road_demand)": [[25, "transport_road_demand.distribute_road_flex_electricity_demand", false]], "district_heat (exo_heat_demand.districtheataau attribute)": [[7, "exo_heat_demand.DistrictHeatAAU.district_heat", false]], "districtheataau (class in exo_heat_demand)": [[7, "exo_heat_demand.DistrictHeatAAU", false]], "dkstat (class in format_dkstat)": [[10, "format_dkstat.DKSTAT", false]], "doldc() (in module vre_profiles)": [[27, "vre_profiles.doLDC", false]], "dt (in module exo_powerplants)": [[8, "exo_powerplants.dt", false]], "dt_int (in module exo_powerplants)": [[8, "exo_powerplants.dt_int", false], [8, "id9", false]], "e (in module exo_powerplants)": [[8, "exo_powerplants.E", false]], "eldh2balm (in module technology_data)": [[23, "technology_data.eldh2balm", false]], "eldh2tech (in module technology_data)": [[23, "technology_data.eldh2TECH", false]], "eldh2type (in module technology_data)": [[23, "technology_data.eldh2TYPE", false]], "est (in module technology_data)": [[23, "technology_data.est", false]], "exo_elec_dem_conversion_dictionaries (in module create_conversion_dictionaries)": [[5, "create_conversion_dictionaries.exo_elec_dem_conversion_dictionaries", false]], "exo_electricity_demand": [[6, "module-exo_electricity_demand", false]], "exo_grid_conversion_dictionaries (in module create_conversion_dictionaries)": [[5, "create_conversion_dictionaries.exo_grid_conversion_dictionaries", false]], "exo_heat_dem_conversion_dictionaries (in module create_conversion_dictionaries)": [[5, "create_conversion_dictionaries.exo_heat_dem_conversion_dictionaries", false]], "exo_heat_demand": [[7, "module-exo_heat_demand", false]], "exo_powerplants": [[8, "module-exo_powerplants", false]], "extidx (in module exo_powerplants)": [[8, "exo_powerplants.EXTidx", false]], "f (in module exo_powerplants)": [[8, "exo_powerplants.F", false], [8, "exo_powerplants.f", false]], "f1 (format_dkstat.dkstat attribute)": [[10, "format_dkstat.DKSTAT.f1", false]], "f2 (format_dkstat.dkstat attribute)": [[10, "format_dkstat.DKSTAT.f2", false]], "fc (in module exo_electricity_demand)": [[6, "exo_electricity_demand.fc", false]], "fc (in module exo_heat_demand)": [[7, "exo_heat_demand.fc", false]], "fc (in module format_dkstat)": [[10, "format_dkstat.fc", false]], "fc (in module format_vpdk21)": [[12, "format_vpdk21.fc", false]], "fc (in module geofiles)": [[13, "geofiles.fc", false]], "fc (in module municipal_template)": [[19, "municipal_template.fc", false]], "fc (in module technology_data)": [[23, "technology_data.fc", false]], "feldh (in module technology_data)": [[23, "technology_data.felDH", false]], "filename_ept (in module exo_powerplants)": [[8, "exo_powerplants.filename_EPT", false]], "filename_wt (in module exo_powerplants)": [[8, "exo_powerplants.filename_WT", false]], "files (format_vpdk21.vpdk21 attribute)": [[12, "format_vpdk21.VPDK21.files", false]], "flexdem (class in transport_road_demand)": [[25, "transport_road_demand.FlexDem", false]], "format_balmorel_data": [[9, "module-format_balmorel_data", false]], "format_data() (in module heat_profiles)": [[16, "heat_profiles.format_data", false]], "format_dkstat": [[10, "module-format_dkstat", false]], "format_energinet": [[11, "module-format_energinet", false]], "format_set() (in module geographic_sets)": [[14, "geographic_sets.format_set", false]], "format_vpdk21": [[12, "module-format_vpdk21", false]], "fuels (in module exo_powerplants)": [[8, "exo_powerplants.fuels", false]], "fuels_assumed (in module exo_powerplants)": [[8, "exo_powerplants.fuels_assumed", false]], "fwt (in module exo_powerplants)": [[8, "exo_powerplants.fWT", false], [8, "id0", false], [8, "id1", false], [8, "id2", false]], "gather_data() (in module clustering)": [[3, "clustering.gather_data", false]], "gdata (in module technology_data)": [[23, "id0", false], [23, "technology_data.GDATA", false]], "gdatastring1 (in module technology_data)": [[23, "technology_data.GDATASTRING1", false]], "gdatastring2 (in module technology_data)": [[23, "technology_data.GDATASTRING2", false]], "generate() (in module heat_profiles)": [[16, "heat_profiles.generate", false]], "geofiles": [[13, "module-geofiles", false]], "geographic_sets": [[14, "module-geographic_sets", false]], "get_connections() (in module grids)": [[15, "grids.get_connections", false]], "get_distance_matrix() (in module grids)": [[15, "grids.get_distance_matrix", false]], "get_polygons() (municipal_template.datacontainer method)": [[19, "municipal_template.DataContainer.get_polygons", false]], "get_symbols_to_aggregate() (in module aggregate_inputs)": [[1, "aggregate_inputs.get_symbols_to_aggregate", false]], "get_value() (in module technology_data)": [[23, "technology_data.get_value", false]], "gkfx (in module exo_powerplants)": [[8, "exo_powerplants.GKFX", false], [8, "id25", false], [8, "id26", false], [8, "id27", false], [8, "id28", false]], "grids": [[15, "module-grids", false]], "grids() (in module format_balmorel_data)": [[9, "format_balmorel_data.grids", false]], "heat_profiles": [[16, "module-heat_profiles", false]], "heat_profiles_func() (in module heat_profiles)": [[16, "heat_profiles.heat_profiles_func", false]], "idx (in module exo_powerplants)": [[8, "exo_powerplants.idx", false], [8, "id10", false], [8, "id11", false], [8, "id12", false], [8, "id13", false], [8, "id14", false], [8, "id15", false], [8, "id16", false], [8, "id17", false], [8, "id18", false], [8, "id19", false], [8, "id21", false], [8, "id22", false], [8, "id23", false], [8, "id24", false]], "idx (in module technology_data)": [[23, "technology_data.idx", false]], "idxe (in module exo_powerplants)": [[8, "exo_powerplants.idxE", false]], "ind (format_dkstat.dkstat attribute)": [[10, "format_dkstat.DKSTAT.IND", false]], "ind (format_vpdk21.vpdk21 attribute)": [[12, "format_vpdk21.VPDK21.IND", false]], "index (format_dkstat.dkstat attribute)": [[10, "format_dkstat.DKSTAT.index", false]], "index (municipal_template.datacontainer attribute)": [[19, "municipal_template.DataContainer.index", false]], "individual_agkn() (in module investment_options)": [[18, "investment_options.individual_AGKN", false]], "industry (exo_heat_demand.districtheataau attribute)": [[7, "exo_heat_demand.DistrictHeatAAU.industry", false]], "industry_agkn() (in module investment_options)": [[18, "investment_options.industry_AGKN", false]], "investment_options": [[18, "module-investment_options", false]], "join_to_gpd() (in module utils)": [[26, "utils.join_to_gpd", false]], "lines (in module exo_powerplants)": [[8, "exo_powerplants.lines", false]], "load_profiles() (in module offshore_wind)": [[20, "offshore_wind.load_profiles", false]], "load_profiles_from_balmorel() (in module heat_profiles)": [[16, "heat_profiles.load_profiles_from_balmorel", false]], "load_set() (in module geographic_sets)": [[14, "geographic_sets.load_set", false]], "load_traffic_data() (transport_road_demand.flexdem method)": [[25, "transport_road_demand.FlexDem.load_traffic_data", false]], "load_transport_demand() (in module format_dkstat)": [[10, "format_dkstat.load_transport_demand", false]], "loop_and_replace_names() (in module aggregate_inputs)": [[1, "aggregate_inputs.loop_and_replace_names", false]], "main() (in module aggregate_inputs)": [[1, "aggregate_inputs.main", false]], "main() (in module clustering)": [[3, "clustering.main", false]], "main() (in module create_addon_files)": [[4, "create_addon_files.main", false]], "main() (in module exo_electricity_demand)": [[6, "exo_electricity_demand.main", false]], "main() (in module exo_heat_demand)": [[7, "exo_heat_demand.main", false]], "main() (in module format_balmorel_data)": [[9, "format_balmorel_data.main", false]], "main() (in module format_dkstat)": [[10, "format_dkstat.main", false]], "main() (in module format_energinet)": [[11, "format_energinet.main", false]], "main() (in module format_vpdk21)": [[12, "format_vpdk21.main", false]], "main() (in module geographic_sets)": [[14, "geographic_sets.main", false]], "main() (in module grids)": [[15, "grids.main", false]], "main() (in module investment_options)": [[18, "investment_options.main", false]], "main() (in module offshore_wind)": [[20, "offshore_wind.main", false]], "main() (in module plot_dag)": [[22, "plot_dag.main", false]], "main() (in module transport_heavy_demand)": [[24, "transport_heavy_demand.main", false]], "main() (in module transport_road_demand)": [[25, "transport_road_demand.main", false]], "main() (in module vre_profiles)": [[27, "vre_profiles.main", false]], "merge_example (in module format_vpdk21)": [[12, "format_vpdk21.merge_example", false]], "merge_irrri_names() (in module aggregate_inputs)": [[1, "aggregate_inputs.merge_IRRRI_names", false]], "merge_rrr_names() (in module aggregate_inputs)": [[1, "aggregate_inputs.merge_RRR_names", false]], "module": [[1, "module-aggregate_inputs", false], [2, "module-biomass_transport", false], [3, "module-clustering", false], [4, "module-create_addon_files", false], [5, "module-create_conversion_dictionaries", false], [6, "module-exo_electricity_demand", false], [7, "module-exo_heat_demand", false], [8, "module-exo_powerplants", false], [9, "module-format_balmorel_data", false], [10, "module-format_dkstat", false], [11, "module-format_energinet", false], [12, "module-format_vpdk21", false], [13, "module-geofiles", false], [14, "module-geographic_sets", false], [15, "module-grids", false], [16, "module-heat_profiles", false], [18, "module-investment_options", false], [19, "module-municipal_template", false], [20, "module-offshore_wind", false], [21, "module-onshore_vre_func", false], [22, "module-plot_dag", false], [23, "module-technology_data", false], [24, "module-transport_heavy_demand", false], [25, "module-transport_road_demand", false], [26, "module-utils", false], [27, "module-vre_profiles", false]], "muni (municipal_template.datacontainer attribute)": [[19, "municipal_template.DataContainer.muni", false]], "muni_geofile (municipal_template.datacontainer attribute)": [[19, "municipal_template.DataContainer.muni_geofile", false]], "municipal_template": [[19, "module-municipal_template", false]], "name (format_dkstat.dkstat attribute)": [[10, "format_dkstat.DKSTAT.name", false]], "name (municipal_template.datacontainer attribute)": [[19, "municipal_template.DataContainer.name", false]], "names (format_vpdk21.vpdk21 attribute)": [[12, "format_vpdk21.VPDK21.names", false]], "new (in module exo_powerplants)": [[8, "exo_powerplants.new", false]], "new_ax (in module exo_powerplants)": [[8, "exo_powerplants.new_ax", false]], "new_geofile() (in module clustering)": [[3, "clustering.new_geofile", false]], "newwt (in module exo_powerplants)": [[8, "exo_powerplants.newWT", false]], "offshore_wind": [[20, "module-offshore_wind", false]], "onshore_vre() (in module format_balmorel_data)": [[9, "format_balmorel_data.onshore_vre", false]], "onshore_vre_func": [[21, "module-onshore_vre_func", false]], "onshore_vre_func() (in module onshore_vre_func)": [[21, "onshore_vre_func.onshore_vre_func", false]], "plot_dag": [[22, "module-plot_dag", false]], "plot_data() (in module heat_profiles)": [[16, "heat_profiles.plot_data", false]], "plot_style() (in module biomass_transport)": [[2, "biomass_transport.plot_style", false]], "plot_style() (in module heat_profiles)": [[16, "heat_profiles.plot_style", false]], "pp (in module exo_powerplants)": [[8, "exo_powerplants.pp", false], [8, "id20", false], [8, "id3", false], [8, "id4", false], [8, "id5", false], [8, "id6", false], [8, "id7", false], [8, "id8", false]], "prepared_geofiles() (in module geofiles)": [[13, "geofiles.prepared_geofiles", false]], "run_old_script (in module grids)": [[15, "grids.run_old_script", false]], "save_dict_set() (in module utils)": [[26, "utils.save_dict_set", false]], "save_symbol_from_all_endofmodel() (in module investment_options)": [[18, "investment_options.save_symbol_from_all_endofmodel", false]], "simple_assumptions() (in module transport_heavy_demand)": [[24, "transport_heavy_demand.simple_assumptions", false]], "store_balmorel_input() (in module utils)": [[26, "utils.store_balmorel_input", false]], "style (in module exo_electricity_demand)": [[6, "exo_electricity_demand.style", false]], "style (in module exo_heat_demand)": [[7, "exo_heat_demand.style", false]], "style (in module format_dkstat)": [[10, "format_dkstat.style", false]], "style (in module format_vpdk21)": [[12, "format_vpdk21.style", false]], "style (in module geofiles)": [[13, "geofiles.style", false]], "style (in module municipal_template)": [[19, "municipal_template.style", false]], "style (in module technology_data)": [[23, "technology_data.style", false]], "t (in module exo_powerplants)": [[8, "exo_powerplants.T", false]], "technology_data": [[23, "module-technology_data", false]], "techs (in module exo_powerplants)": [[8, "exo_powerplants.techs", false]], "techs_to_add (in module technology_data)": [[23, "technology_data.techs_to_add", false]], "temp (format_vpdk21.vpdk21 attribute)": [[12, "format_vpdk21.VPDK21.temp", false]], "temp (municipal_template.datacontainer attribute)": [[19, "municipal_template.DataContainer.temp", false]], "temp_pp (in module exo_powerplants)": [[8, "exo_powerplants.temp_pp", false]], "transform_xrdata() (in module utils)": [[26, "utils.transform_xrdata", false]], "transport() (in module biomass_transport)": [[2, "biomass_transport.transport", false]], "transport_heavy_demand": [[24, "module-transport_heavy_demand", false]], "transport_road_demand": [[25, "module-transport_road_demand", false]], "truncate_colormap() (in module clustering)": [[3, "clustering.truncate_colormap", false]], "types (in module exo_powerplants)": [[8, "exo_powerplants.types", false]], "u (in module exo_powerplants)": [[8, "exo_powerplants.U", false]], "units (in module exo_powerplants)": [[8, "exo_powerplants.units", false]], "units_assumed (in module exo_powerplants)": [[8, "exo_powerplants.units_assumed", false]], "utils": [[26, "module-utils", false]], "utm32 (in module exo_powerplants)": [[8, "exo_powerplants.UTM32", false]], "vpdk21 (class in format_vpdk21)": [[12, "format_vpdk21.VPDK21", false]], "vre_profiles": [[27, "module-vre_profiles", false]], "x (in module municipal_template)": [[19, "municipal_template.x", false]], "y_range (in module technology_data)": [[23, "technology_data.y_range", false]], "y_start (in module technology_data)": [[23, "technology_data.y_start", false]], "y_step (in module technology_data)": [[23, "technology_data.y_step", false]], "y_stop (in module technology_data)": [[23, "technology_data.y_stop", false]], "ymax (in module exo_powerplants)": [[8, "exo_powerplants.Ymax", false]], "ymin (in module exo_powerplants)": [[8, "exo_powerplants.Ymin", false]]}, "objects": {"": [[1, 0, 0, "-", "aggregate_inputs"], [2, 0, 0, "-", "biomass_transport"], [3, 0, 0, "-", "clustering"], [4, 0, 0, "-", "create_addon_files"], [5, 0, 0, "-", "create_conversion_dictionaries"], [6, 0, 0, "-", "exo_electricity_demand"], [7, 0, 0, "-", "exo_heat_demand"], [8, 0, 0, "-", "exo_powerplants"], [9, 0, 0, "-", "format_balmorel_data"], [10, 0, 0, "-", "format_dkstat"], [11, 0, 0, "-", "format_energinet"], [12, 0, 0, "-", "format_vpdk21"], [13, 0, 0, "-", "geofiles"], [14, 0, 0, "-", "geographic_sets"], [15, 0, 0, "-", "grids"], [16, 0, 0, "-", "heat_profiles"], [18, 0, 0, "-", "investment_options"], [19, 0, 0, "-", "municipal_template"], [20, 0, 0, "-", "offshore_wind"], [21, 0, 0, "-", "onshore_vre_func"], [22, 0, 0, "-", "plot_dag"], [23, 0, 0, "-", "technology_data"], [24, 0, 0, "-", "transport_heavy_demand"], [25, 0, 0, "-", "transport_road_demand"], [26, 0, 0, "-", "utils"], [27, 0, 0, "-", "vre_profiles"]], "aggregate_inputs": [[1, 1, 1, "", "aggregate_parameter"], [1, 1, 1, "", "aggregate_sets"], [1, 1, 1, "", "get_symbols_to_aggregate"], [1, 1, 1, "", "loop_and_replace_names"], [1, 1, 1, "", "main"], [1, 1, 1, "", "merge_IRRRI_names"], [1, 1, 1, "", "merge_RRR_names"]], "biomass_transport": [[2, 1, 1, "", "CLI"], [2, 1, 1, "", "plot_style"], [2, 1, 1, "", "transport"]], "clustering": [[3, 1, 1, "", "apply_filters"], [3, 1, 1, "", "cluster"], [3, 2, 1, "", "cmap"], [3, 1, 1, "", "collect_clusterdata"], [3, 2, 1, "", "columns"], [3, 1, 1, "", "convert_municipal_code_to_name"], [3, 1, 1, "", "correct_VRE_data"], [3, 1, 1, "", "gather_data"], [3, 1, 1, "", "main"], [3, 1, 1, "", "new_geofile"], [3, 1, 1, "", "truncate_colormap"]], "create_addon_files": [[4, 1, 1, "", "create_category_files"], [4, 1, 1, "", "create_empty_set_files"], [4, 1, 1, "", "main"]], "create_conversion_dictionaries": [[5, 2, 1, "", "exo_elec_dem_conversion_dictionaries"], [5, 2, 1, "", "exo_grid_conversion_dictionaries"], [5, 2, 1, "", "exo_heat_dem_conversion_dictionaries"]], "exo_electricity_demand": [[6, 2, 1, "", "cmap"], [6, 2, 1, "", "fc"], [6, 1, 1, "", "main"], [6, 2, 1, "", "style"]], "exo_heat_demand": [[7, 3, 1, "", "DistrictHeatAAU"], [7, 2, 1, "", "cmap"], [7, 1, 1, "", "create_DH"], [7, 1, 1, "", "create_INDIVUSERS_DH"], [7, 1, 1, "", "create_INDUSTRY_DH"], [7, 1, 1, "", "create_INDUSTRY_DH_VAR_T"], [7, 1, 1, "", "create_incfile"], [7, 2, 1, "", "fc"], [7, 1, 1, "", "main"], [7, 2, 1, "", "style"]], "exo_heat_demand.DistrictHeatAAU": [[7, 4, 1, "", "annual_industry_demand"], [7, 5, 1, "", "combine_data"], [7, 4, 1, "", "district_heat"], [7, 4, 1, "", "industry"]], "exo_powerplants": [[8, 2, 1, "", "CHPidx"], [8, 2, 1, "", "E"], [8, 2, 1, "", "EXTidx"], [8, 2, 1, "", "F"], [8, 2, 1, "id28", "GKFX"], [8, 2, 1, "", "T"], [8, 2, 1, "", "U"], [8, 2, 1, "", "UTM32"], [8, 2, 1, "", "Ymax"], [8, 2, 1, "", "Ymin"], [8, 2, 1, "", "choice"], [8, 2, 1, "", "crs"], [8, 2, 1, "", "dfAsString"], [8, 2, 1, "", "dist"], [8, 2, 1, "", "dt"], [8, 2, 1, "id9", "dt_int"], [8, 2, 1, "", "f"], [8, 2, 1, "id2", "fWT"], [8, 2, 1, "", "filename_EPT"], [8, 2, 1, "", "filename_WT"], [8, 2, 1, "", "fuels"], [8, 2, 1, "", "fuels_assumed"], [8, 2, 1, "id24", "idx"], [8, 2, 1, "", "idxE"], [8, 2, 1, "", "lines"], [8, 2, 1, "", "new"], [8, 2, 1, "", "newWT"], [8, 2, 1, "", "new_ax"], [8, 2, 1, "id20", "pp"], [8, 2, 1, "", "techs"], [8, 2, 1, "", "temp_pp"], [8, 2, 1, "", "types"], [8, 2, 1, "", "units"], [8, 2, 1, "", "units_assumed"]], "format_balmorel_data": [[9, 1, 1, "", "biomass_availability"], [9, 1, 1, "", "grids"], [9, 1, 1, "", "main"], [9, 1, 1, "", "onshore_vre"]], "format_dkstat": [[10, 3, 1, "", "DKSTAT"], [10, 2, 1, "", "fc"], [10, 1, 1, "", "load_transport_demand"], [10, 1, 1, "", "main"], [10, 2, 1, "", "style"]], "format_dkstat.DKSTAT": [[10, 4, 1, "", "IND"], [10, 4, 1, "", "f1"], [10, 4, 1, "", "f2"], [10, 4, 1, "", "index"], [10, 4, 1, "", "name"]], "format_energinet": [[11, 1, 1, "", "main"]], "format_vpdk21": [[12, 3, 1, "", "VPDK21"], [12, 2, 1, "", "fc"], [12, 1, 1, "", "main"], [12, 2, 1, "", "merge_example"], [12, 2, 1, "", "style"]], "format_vpdk21.VPDK21": [[12, 4, 1, "", "DH"], [12, 4, 1, "", "IND"], [12, 4, 1, "", "correct_names"], [12, 4, 1, "", "files"], [12, 4, 1, "", "names"], [12, 4, 1, "", "temp"]], "geofiles": [[13, 1, 1, "", "assign_area_to_region"], [13, 1, 1, "", "calculate_intersects"], [13, 2, 1, "", "fc"], [13, 1, 1, "", "prepared_geofiles"], [13, 2, 1, "", "style"]], "geographic_sets": [[14, 1, 1, "", "format_set"], [14, 1, 1, "", "load_set"], [14, 1, 1, "", "main"]], "grids": [[15, 1, 1, "", "create_grid_incfiles"], [15, 1, 1, "", "create_tech_specific_distribution_loss"], [15, 1, 1, "", "get_connections"], [15, 1, 1, "", "get_distance_matrix"], [15, 1, 1, "", "main"], [15, 2, 1, "", "run_old_script"]], "heat_profiles": [[16, 1, 1, "", "CLI"], [16, 1, 1, "", "aggregate_temperatures"], [16, 1, 1, "", "format_data"], [16, 1, 1, "", "generate"], [16, 1, 1, "", "heat_profiles_func"], [16, 1, 1, "", "load_profiles_from_balmorel"], [16, 1, 1, "", "plot_data"], [16, 1, 1, "", "plot_style"]], "investment_options": [[18, 1, 1, "", "base_AGKN"], [18, 1, 1, "", "individual_AGKN"], [18, 1, 1, "", "industry_AGKN"], [18, 1, 1, "", "main"], [18, 1, 1, "", "save_symbol_from_all_endofmodel"]], "municipal_template": [[19, 3, 1, "", "DataContainer"], [19, 2, 1, "", "fc"], [19, 2, 1, "", "style"], [19, 2, 1, "", "x"]], "municipal_template.DataContainer": [[19, 4, 1, "", "centroids"], [19, 4, 1, "", "correct_names"], [19, 5, 1, "", "get_polygons"], [19, 4, 1, "", "index"], [19, 4, 1, "", "muni"], [19, 4, 1, "", "muni_geofile"], [19, 4, 1, "", "name"], [19, 4, 1, "", "temp"]], "offshore_wind": [[20, 1, 1, "", "create_geo_sets"], [20, 1, 1, "", "create_investment_options"], [20, 1, 1, "", "create_profiles"], [20, 1, 1, "", "distribute_offshore_potential"], [20, 1, 1, "", "load_profiles"], [20, 1, 1, "", "main"]], "onshore_vre_func": [[21, 1, 1, "", "onshore_vre_func"]], "plot_dag": [[22, 1, 1, "", "main"]], "technology_data": [[23, 2, 1, "id0", "GDATA"], [23, 2, 1, "", "GDATASTRING1"], [23, 2, 1, "", "GDATASTRING2"], [23, 2, 1, "", "areas"], [23, 2, 1, "", "choice"], [23, 2, 1, "", "dfAsString"], [23, 2, 1, "", "eldh2TECH"], [23, 2, 1, "", "eldh2TYPE"], [23, 2, 1, "", "eldh2balm"], [23, 2, 1, "", "est"], [23, 2, 1, "", "fc"], [23, 2, 1, "", "felDH"], [23, 1, 1, "", "get_value"], [23, 2, 1, "", "idx"], [23, 2, 1, "", "style"], [23, 2, 1, "", "techs_to_add"], [23, 2, 1, "", "y_range"], [23, 2, 1, "", "y_start"], [23, 2, 1, "", "y_step"], [23, 2, 1, "", "y_stop"]], "transport_heavy_demand": [[24, 1, 1, "", "main"], [24, 1, 1, "", "simple_assumptions"]], "transport_road_demand": [[25, 3, 1, "", "FlexDem"], [25, 1, 1, "", "distribute_dkstat_demand"], [25, 1, 1, "", "distribute_road_flex_electricity_demand"], [25, 1, 1, "", "main"]], "transport_road_demand.FlexDem": [[25, 5, 1, "", "create_flexdem_incfiles"], [25, 5, 1, "", "create_profile"], [25, 5, 1, "", "create_road_demand_from_Nvehicles"], [25, 5, 1, "", "create_road_demand_from_dkstat"], [25, 5, 1, "", "load_traffic_data"]], "utils": [[26, 1, 1, "", "combine_dicts"], [26, 1, 1, "", "convert_coordname_elements"], [26, 1, 1, "", "convert_names"], [26, 1, 1, "", "df_set_to_dictionary"], [26, 1, 1, "", "join_to_gpd"], [26, 1, 1, "", "save_dict_set"], [26, 1, 1, "", "store_balmorel_input"], [26, 1, 1, "", "transform_xrdata"]], "vre_profiles": [[27, 1, 1, "", "doLDC"], [27, 1, 1, "", "main"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "terms": {"": [8, 24], "0": [3, 12, 13, 24], "01": 1, "04": [4, 23], "050427": 12, "06": 25, "08": [6, 10, 11, 12, 19], "09": [3, 7, 9, 14, 18, 20, 24, 26], "1": [3, 4, 16, 17, 24, 25, 27], "10": [1, 2, 4, 9, 12, 13, 16, 27], "100": [3, 12, 15, 24, 25], "1000": 25, "1016": 9, "11": [2, 3], "114869": 9, "119": 24, "12": 12, "1217": 12, "13": 8, "132": 15, "13914": 12, "14": 16, "15": [9, 12, 13, 15, 27], "163": 24, "1648": 12, "17": 12, "19": 26, "2": [4, 16, 24, 27, 28], "20": 7, "200": [12, 15], "2000": 10, "2012": 20, "2020": [9, 23], "2021": [6, 11, 12, 15], "2022": [8, 12, 13, 15, 23, 27], "2023": [10, 23], "2024": [1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 14, 16, 18, 19, 20, 24, 25, 26], "2050": [8, 23], "21": 12, "22": [6, 11, 15, 25], "220": 15, "2200": 15, "23": 12, "2393": 12, "24": [9, 14, 23], "2400": 15, "25": [8, 16, 18], "26": 12, "268": 9, "27": [6, 11, 20, 24], "28": 19, "28571428571429": 12, "2865": 12, "29": 12, "2nd": 15, "3": [13, 16, 27], "30": 10, "300": 15, "305": 12, "32723": 12, "33": [8, 13, 24, 27], "3369": 12, "34": 24, "345": 15, "381": 24, "38463": 12, "4": 24, "40": 12, "400": 15, "412": 24, "42": 24, "42857142857143": 12, "45": 12, "5": [23, 25], "500": 15, "51": 15, "52": 25, "53": 12, "55": [12, 24], "59496": 12, "60": 12, "60c": 12, "614": 24, "64": 12, "687324": 12, "7": 12, "70": 12, "7135": 12, "765": 15, "774": 12, "798": 12, "8": [12, 24], "80c": 12, "82": 24, "840": 24, "86": 24, "900": 15, "95": 12, "A": [13, 15, 16, 29, 30], "For": 24, "It": 8, "No": 24, "One": 12, "The": [4, 6, 7, 11, 13, 16], "Will": [16, 24], "_": 13, "_a": 13, "_description_": 13, "_type_": [2, 16], "a_suffix": [7, 13], "aaa": 4, "aalborg": 12, "aau": 12, "abov": [6, 11, 12], "account": 24, "addon": 4, "adm": 3, "administr": [6, 11], "af": 12, "after": 6, "agenc": [8, 23], "agg_temperatur": 16, "aggfunc": [1, 3, 16], "aggreg": [1, 4, 8, 16], "aggregate_input": 17, "aggregate_paramet": 1, "aggregate_set": 1, "aggregate_temperatur": 16, "aggregated_temperatur": 16, "aggregation_funct": 3, "agkn": [4, 18], "al": 9, "all": [3, 13], "all_endofmodel": 18, "alonso": 9, "also": [6, 11], "alts\u00e5": 12, "amalia": 9, "amount": 12, "an": [13, 22, 27], "anlaeg": 8, "annual_industry_demand": 7, "answer": 15, "antbalm": 13, "apenergi": 9, "api": 27, "appli": 9, "apply_filt": 3, "ar": 24, "area": [13, 15, 23], "area_choic": 25, "area_nam": 13, "areas_inter1": 13, "areas_inter2": 13, "arg": [2, 6, 7, 10, 13, 16], "argument": 7, "arrai": 13, "artif": 3, "assign": 13, "assign_area_to_region": 13, "assist": 8, "assum": [9, 24, 25], "assumpt": [12, 15, 16, 23, 24, 25], "atlit": [13, 27], "author": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "auto": 17, "autoapi": 17, "automat": 15, "avail": [6, 9, 11, 13, 27], "averag": 16, "ax": [2, 16], "bad": 25, "balmorel": [1, 3, 5, 8, 9, 15, 16, 18], "balmorel_model_path": 26, "balmorelvrearea": 13, "base": [1, 16], "base_agkn": 18, "becaus": 7, "befor": 6, "being": 16, "below": [12, 29], "berg": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "better": 15, "bio": 24, "biogaspot": 9, "biomass": 9, "biomass_avail": 9, "biomass_transport": 17, "bodi": 7, "bool": [2, 3, 6, 7, 9, 10, 13, 16, 18, 20, 22, 24, 25, 26, 27], "bramstoft": 9, "bunker": 10, "c": [3, 12, 18, 27], "ca": 12, "calcul": 13, "calculate_intersect": 13, "call": 27, "callabl": 26, "can": [12, 15], "candid": [6, 11], "capac": 25, "carri": 15, "carrier": 15, "case": 7, "catalogu": [15, 23], "categori": [1, 12], "categoris": 4, "category_fil": 4, "cb": 23, "cccrrraaa": 4, "ccu": 24, "cd": 27, "cdsapirc": 27, "centroid": 19, "certain": 15, "ch4": 23, "charg": 25, "charger_capacity_pr_vehicl": 25, "chargercap": 25, "choic": [8, 10, 13, 20, 23, 25], "choos": 13, "chp": 23, "chpidx": 8, "christians\u00f8": 3, "class": 16, "cli": [2, 9, 16], "climat": 27, "cluster": [1, 4, 17], "cluster_param": 3, "cluster_s": 3, "cmap": [3, 6, 7], "code": [6, 11], "col": 27, "collect_clusterdata": 3, "collected_data": 3, "column": [3, 18, 26], "column_to_convert": 3, "com": [9, 15], "combin": [3, 12, 23], "combine_data": 7, "combine_dict": 26, "combined_dict": 14, "come": [12, 15, 23], "command": 16, "connec": 3, "connect": 9, "connection_remark": 3, "construct": 0, "consumpt": [16, 24], "consumptionindustri": [6, 11], "contain": [6, 11, 17], "convers": 6, "conversion_fil": [6, 26], "convert": [5, 6, 8, 9, 11], "convert_coordname_el": 26, "convert_municipal_code_to_nam": 3, "convert_nam": 26, "convert_seasons_and_term": 26, "coord": 3, "coord_system": 19, "coordin": 16, "copernicu": 27, "copi": 27, "correct_nam": [12, 19], "correct_vre_data": 3, "cost": [2, 15], "could": 12, "countri": [6, 11, 25], "cours": 15, "cr": 8, "creat": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 23, 24, 25, 26, 27], "create_addon_fil": 17, "create_category_fil": 4, "create_conversion_dictionari": 17, "create_cutout": [13, 27], "create_dh": 7, "create_empty_set_fil": 4, "create_flexdem_incfil": 25, "create_geo_set": 20, "create_grid_incfil": 15, "create_incfil": 7, "create_indivusers_dh": 7, "create_industry_dh": 7, "create_industry_dh_var_t": 7, "create_investment_opt": 20, "create_profil": [20, 25], "create_road_demand_from_dkstat": 25, "create_road_demand_from_nvehicl": 25, "create_tech_specific_distribution_loss": 15, "createvr": 20, "ctrl": 23, "ctx": [2, 9, 16, 21], "current": 13, "cutout": [13, 16, 27], "cutout_path": 27, "cv": 23, "cycl": 23, "d": 15, "da": 12, "dai": 16, "danish": [8, 10, 23], "danmark": [10, 12], "dark_styl": [2, 16], "data": [3, 6, 7, 8, 9, 10, 11, 12, 15, 16, 23, 25], "data_remark": 3, "data_vari": 26, "dataarrai": [16, 25], "datacontain": 19, "datafram": [1, 3, 10, 13, 15, 16, 18, 26], "dataset": [6, 7, 11, 12, 16, 20, 25, 26], "datasheet": 8, "db": [1, 3], "dcost_": 15, "de": 4, "de_var_t": 4, "dea2021": 15, "dec": [13, 15, 27], "default": [6, 10, 13], "definit": 20, "degre": [15, 16], "demand": [4, 6, 7, 10, 11, 12, 15, 16, 24, 25], "demand_pr_vehicl": 25, "den": 23, "denmark": [3, 6, 11], "deriv": 15, "derov": 12, "descript": [2, 3, 9, 14, 16, 18, 19], "df": [1, 3, 16, 26], "df_set_to_dictionari": 26, "dfasstr": [8, 23], "dh": [4, 12], "dh_var_t": 4, "diagram": 29, "dict": [1, 14, 15, 26], "dict_list": 26, "differ": 7, "dimension_map": 26, "disloss_e_ag": 4, "dist": 8, "distribut": [9, 12, 15, 25], "distribute_dkstat_demand": 25, "distribute_offshore_potenti": 20, "distribute_road_flex_electricity_demand": 25, "district": [12, 23], "district_heat": 7, "districtheataau": 7, "dk": [6, 8, 10, 11, 12, 13, 15, 23], "dkmunicipalities_nam": [8, 20, 25], "dkstat": 10, "dloss_": 15, "document": [0, 13, 17, 27], "doesn": 12, "doi": 9, "doldc": 27, "download": [8, 22], "draw": 15, "drive": 27, "dt": 8, "dt_int": 8, "dtu": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "e": [8, 12, 15, 24], "each": [1, 13], "easi": 5, "ec": [6, 11], "econom": [1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 14, 16, 18, 19, 20, 23, 24, 25, 26, 27], "effici": [12, 23, 24], "eft": 24, "efta": [6, 11], "egu24": 9, "eksisterend": 15, "el_dataset": 6, "el_new_dataset": 7, "eldh2balm": 23, "eldh2tech": 23, "eldh2typ": 23, "electr": [4, 6, 11, 15, 23, 25], "element": [5, 13], "element_map": 26, "eller": 12, "emeoh": 24, "emobl": 25, "empti": 4, "empty_fil": 4, "en": [8, 13, 15, 23, 27], "ene3h": 10, "enegeo": 10, "energi": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "energidataservic": [6, 11], "energiforbrug": 12, "energinet": [6, 11, 15], "energinet_data_path": 11, "energiproducentt\u00e6l": 8, "energisektoren": 8, "energisparepotential": 12, "energistyrelsen": [8, 12], "enetyp": 10, "enh3": 24, "enough": 12, "entso": 15, "environ": 15, "ep": 1, "ept": 8, "era5": 27, "esbjerg": [15, 20, 27], "est": 23, "et": 9, "etc": 4, "eu": [6, 11, 27], "eur": 25, "europa": [6, 11], "eurostat": [6, 11, 16], "ev": 25, "everi": 7, "exampl": [13, 27], "except": 1, "exclude_region": 3, "exo_elec_dem_conversion_dictionari": 5, "exo_electricity_demand": 17, "exo_grid_conversion_dictionari": 5, "exo_heat_dem_conversion_dictionari": 5, "exo_heat_demand": 17, "exo_powerpl": 17, "exogen": [4, 7], "expect": 16, "ext": 23, "extidx": 8, "extist": 15, "extract": 23, "f": 8, "f1": 10, "f2": 10, "factor": 23, "fals": [3, 6, 7, 9, 10, 12, 13, 15, 18, 20, 22, 25, 26, 27], "fc": [6, 7, 10, 12, 13, 19, 23], "feldh": 23, "fig": [2, 16], "figur": [2, 16, 29], "file": [1, 4, 6, 7, 8, 12, 14, 15, 25, 27], "filename_ept": 8, "filename_wt": 8, "fillna": 1, "filter_func": 26, "find": 16, "first": 12, "fit": 12, "fix": 24, "flag": 6, "flat": 16, "flexdem": 25, "float": [1, 2, 9, 15, 20, 24, 25], "follow": [13, 27], "forbruget": 12, "format": [16, 27], "format_balmorel_data": 17, "format_data": 16, "format_dkstat": 17, "format_energinet": 17, "format_set": 14, "format_vpdk21": 17, "fr00": 25, "fr15": 25, "frederiksberg": 3, "fri": 8, "from": [4, 7, 9, 10, 12, 15, 16, 23, 24, 27], "ft": 24, "fuel": [2, 8, 9, 10, 23, 24], "fuels_assum": 8, "func": 7, "futur": 9, "fwt": 8, "g": [12, 24], "ga": [9, 23], "gadm36_dnk_2": 3, "gam": [1, 3], "gamsdatabas": [1, 3], "gather_data": 3, "gdata": 23, "gdatastring1": 23, "gdatastring2": 23, "gdx": 18, "gener": [7, 16, 17, 20, 23], "generation_nam": 3, "geo": 25, "geodatafram": [1, 3, 4, 13, 15, 16, 20, 25], "geofil": [16, 17, 20], "geograph": 19, "geographic_set": 17, "geometri": 13, "geopanda": [1, 3, 4, 13, 15, 16, 20, 25], "geoseri": 13, "get": [9, 12, 15, 23], "get_connect": 15, "get_distance_matrix": 15, "get_industry_demand": 10, "get_polygon": 19, "get_symbols_to_aggreg": 1, "get_transport_demand": 10, "get_valu": 23, "gi": 1, "github": 9, "gitrepo": [3, 18], "gj": 2, "gj_60_80c": 12, "gj_over_80": 12, "gj_under_6": 12, "gkfx": 8, "godt": 12, "good": 12, "got": 27, "gpd": [13, 26], "gqjj2xpk": 15, "graphviz": 22, "grid": [9, 17], "gross": 12, "gr\u00e6sted": 9, "h": 10, "h2": 24, "han": 9, "heat": [4, 7, 12, 16, 23], "heat_profil": 17, "heat_profiles_func": 16, "here": [8, 24], "herlev": 3, "high": 12, "home": 27, "hot": 16, "how": [13, 15, 27], "howev": 7, "html": [13, 27], "http": [6, 8, 9, 10, 11, 12, 13, 15, 22, 23, 27], "hydrogen": [4, 24], "i": [0, 4, 5, 7, 8, 12, 15], "ida": 9, "idx": [8, 23, 27], "import": 10, "inc": [6, 7, 8], "incfil": [7, 16], "incfile_fold": 1, "incfile_kwarg": 7, "includ": [1, 3, 4, 8, 10, 13], "include_bunk": 10, "ind": [10, 12], "index": [10, 19], "indic": 6, "individu": 12, "individual_agkn": 18, "individual_loss": 15, "indivus": 4, "indivusers_dh": 4, "indivusers_indivusers_aaa": 4, "industri": [4, 7], "industry_agkn": 18, "industry_dh": 4, "industry_industry_aaa": 4, "industry_loss": 15, "input": [1, 5, 16, 23, 24], "insert": 13, "instal": 22, "int": [1, 3, 13, 14, 16, 20, 24, 27], "integr": 9, "interpol": 23, "intersect": 13, "intervallet": 12, "invest": 12, "investment_opt": 17, "io": [13, 27], "itself": 13, "j": 9, "januari": 23, "jensen": 9, "jet": 24, "jetfuel_demand": 24, "join_to_gpd": 26, "jpeg": 15, "june": [9, 23], "just": 24, "kei": [9, 27], "keyword": 7, "kfz__count": 25, "km": 2, "kommunepakk": 12, "kort": 8, "kortl\u00e6gn": 12, "kv": 15, "kwarg": 4, "landus": [13, 27], "larg": 23, "large_muni": 18, "latest": [13, 27], "lau": [6, 11], "left_col": 26, "legend": 16, "ligger": 12, "line": [8, 15], "link": 10, "linkag": 3, "liquid": 9, "list": [3, 4, 18, 26], "load": [1, 10, 20], "load_again": [9, 26], "load_profil": 20, "load_profiles_from_balmorel": 16, "load_set": 14, "load_traffic_data": 25, "load_transport_demand": 10, "local": [6, 11], "look": 15, "loop_and_replace_nam": 1, "low": 12, "maag\u00f8": 12, "main": [1, 3, 4, 6, 7, 9, 10, 11, 12, 14, 15, 18, 20, 22, 24, 25, 27], "main_fuel": 8, "make": 24, "manag": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "manual": 15, "manual_correct": 3, "map": [6, 15], "march": 23, "mari": 9, "materi": 15, "mathi": 13, "mathia": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "mathias157": 9, "matplotlib": [2, 16], "matrix": 9, "maxval": 3, "mayb": 12, "mbero": [3, 18], "mean": 16, "mean_aggfunc": 1, "media": 15, "median_aggfunc": 1, "medium_muni": 18, "meoh": 24, "meoh_per_jetfuel": 24, "merge_exampl": 12, "merge_irrri_nam": 1, "merge_rrr_nam": 1, "metadata": 13, "method": 13, "mid": 12, "middl": 12, "minval": 3, "model": [1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "model_path": [1, 3, 9], "most": [10, 23], "much": 15, "muni": 19, "muni_geofil": 19, "muni_geofile_path": 3, "municip": [6, 11, 12, 13, 16, 19], "municipal_templ": 17, "mw": 15, "mwh": 24, "my": 24, "m\u00fcnster": 9, "n": 3, "n_cluster": 3, "name": [1, 2, 6, 10, 11, 12, 13, 16, 19], "natur": 23, "need": [4, 15, 24], "net": 15, "new": 8, "new_ax": 8, "new_col": 26, "new_dataset": 7, "new_geofil": 3, "newwt": 8, "nh3": 24, "noeglet": 8, "non": 5, "none": [6, 26], "nordpool": 13, "nordpoolr": [13, 23], "nordsoeen_connect": [15, 20, 27], "note": [6, 11, 12], "nov": 8, "nut": [6, 11], "nuts1": 13, "nuts2": 13, "nuts3": 13, "nyborg": 3, "offshor": 20, "offshore_profil": 27, "offshore_wind": 17, "og": [8, 12], "old": 1, "old_column": 1, "omkr": 12, "one": 25, "onshor": 9, "onshore_vr": 9, "onshore_vre_func": 17, "opg\u00f8rels": 12, "option": [6, 10, 13], "org": [9, 22], "our": [15, 23], "output": 1, "ouufo5l": 15, "over": [8, 12], "oversigt": 8, "overwrite_cutout": 27, "p": 12, "packag": [12, 22], "page": [12, 17], "panda": [1, 3, 13, 15, 16, 18, 26], "paper": 24, "param_or_set": 18, "parent_column": 26, "pass": 7, "past": 27, "path": [6, 25], "path_to_allendofmodel": 18, "path_to_fil": 3, "pd": [10, 13, 16], "pdf": 15, "per": [7, 16], "phd": [1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "pivot_t": 3, "pizarro": 9, "place": 7, "plot": [3, 7, 13, 16, 20, 25], "plot_cf": 3, "plot_dag": 17, "plot_data": 16, "plot_ext": [2, 16], "plot_styl": [2, 3, 16], "plu": 12, "polygon": 16, "popul": [6, 11], "port": 24, "poster": 9, "potenti": [9, 13, 27], "power": [8, 13, 15, 23, 27], "powerpl": 8, "pp": 8, "pr": 25, "pre": [12, 13], "prepar": 13, "prepared_geofil": 13, "preprocess": [3, 9], "present": 9, "previou": [9, 16], "print": 6, "print_before_and_aft": 26, "print_opt": 18, "probabl": 12, "process": [6, 7, 10, 12, 13], "produc": [2, 24], "produktionserhverven": 12, "profil": [6, 9, 11, 16, 20], "project": [15, 23], "put": 13, "py": 20, "pyplot": [2, 16], "pypsa": 25, "python": [12, 22], "r": [13, 27], "r_suffix": 13, "rasmu": 9, "ravn": 9, "read": [5, 8], "readi": 16, "readthedoc": [13, 27], "realli": 12, "region": [1, 13, 25], "releas": 9, "remain": 12, "renew": [9, 23], "report": [3, 6, 7, 10, 12, 13, 19, 23], "requir": [4, 12, 22, 27], "research": 8, "resolut": [13, 19], "resten": 12, "return": [6, 10, 16], "right_col": 26, "road_demand": 25, "roedovr": 3, "rosend": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "rrraaa": 4, "run": 9, "run_old_script": 15, "s1": 12, "s5": 12, "sai": 12, "same": 7, "sankei": 29, "sat": [13, 27], "save": [7, 26], "save_dict_set": 26, "save_path": 26, "save_symbol_from_all_endofmodel": 18, "scenario": [1, 3, 9, 12, 26], "script": [4, 13, 23], "search": 10, "search_seri": 23, "search_str": 23, "sec": 25, "section": 28, "see": [12, 13, 27, 29], "select": 26, "seri": 13, "servic": [8, 15, 23], "set": [4, 5], "set_dimens": 14, "sets_to_sum": 26, "shapefil": [3, 13], "ship": 24, "shipping_demand": 24, "should": 12, "show_differ": [6, 7], "shp": 3, "sign": 27, "simpl": [12, 24], "simple_assumpt": 24, "slagels": 3, "solar": 8, "sourc": 15, "spatial": [1, 13], "sphinx": 17, "splitint": 13, "splitstr": 13, "src": 3, "statistik": [8, 10], "statistikbanken": 10, "storag": 23, "store_balmorel_input": 26, "str": [1, 2, 3, 4, 6, 7, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20, 22, 25, 26, 27], "strawpot": 9, "student": [1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 14, 16, 18, 19, 20, 23, 24, 25, 26, 27], "studi": 9, "style": [6, 7, 10, 12, 13, 19, 23], "suffix": [13, 26], "sum": [3, 12], "sum_gwh_uden_besp": 12, "sum_tot": 13, "suppli": 12, "support": 13, "surplu": 12, "symbol": [1, 18, 26], "system": 9, "t": [8, 12], "tag": 9, "tech": 8, "technoeconom": 23, "technologi": [15, 23], "technology_data": 17, "techs_to_add": 23, "temp": [12, 19], "temp_pp": 8, "temperatur": [12, 16], "tg": 24, "them": 1, "thi": [4, 13, 15, 16, 17, 22, 23], "three": 15, "thu": [4, 15], "time": 7, "timeseri": 16, "tip": 30, "titl": [2, 3, 9, 14, 18, 19, 27], "tj": 12, "to_be_convert": 3, "top": 22, "total": [9, 12, 16], "total_offshore_wind_potenti": 20, "total_potenti": 20, "totalt": 12, "transform_xrdata": 26, "transmiss": 15, "transmit": 15, "transport": [2, 10, 15, 24], "transport_cost": 2, "transport_heavy_demand": 17, "transport_road_demand": 17, "true": [3, 12, 26], "truncate_colormap": 3, "tso": [6, 11], "tupl": [1, 3, 4, 13, 26], "turbin": 23, "twh": [10, 12], "type": [8, 23], "typic": 27, "u": 8, "uid": 27, "uk00": 25, "ukni": 25, "under": [0, 12], "understand": [13, 27], "uniform": 25, "union": 13, "uniqu": 7, "unique_nam": 1, "unique_process": 7, "unit": [6, 8, 11], "units_assum": 8, "up": 27, "url": 27, "us": [5, 6, 7, 11, 12, 15, 16, 27], "use_connect": 3, "use_dkstat": 24, "user": [3, 5, 10, 12, 18, 27], "usernam": 27, "util": 17, "utm32": 8, "v2": 27, "valu": 23, "value_nam": 3, "variou": [7, 13], "varmeplan": 12, "vbn": 12, "ved": 12, "vehicl": 25, "veri": 25, "viegand": 12, "view": 22, "vpdk21": 12, "vre": 9, "vre_profil": 17, "ward": 3, "warn": 30, "water": 16, "weather_year": [16, 20, 27], "web": [6, 11], "well": 24, "where": 24, "whether": 6, "white": [6, 7, 10, 12, 13, 19, 23], "wind": 20, "wind_offshore_loss": 15, "windturbin": 8, "wise": 15, "within": [13, 16, 25], "without": 12, "woodimport": 9, "woodpot": 9, "work": [13, 15, 27], "workflow": 22, "wrapper": 7, "wrt": 12, "www": [6, 10, 11], "x": [15, 19], "xarrai": [7, 16, 20, 25, 26], "xcost_": 15, "xe_cost": 15, "xloss_": 15, "xlrd": 12, "xlsx": 8, "xr": 16, "xxx": 15, "xy": 3, "y0": 23, "y0_dif": 23, "y1": 23, "y_rang": 23, "y_start": 23, "y_step": 23, "y_stop": 23, "yaml": 15, "year": [12, 20, 24], "ymax": 8, "ymin": 8, "you": 27, "your": 27, "zero_fillna": 1, "\u00bac": 12, "\u00e5r": 12}, "titles": ["About this code", "aggregate_inputs", "biomass_transport", "clustering", "create_addon_files", "create_conversion_dictionaries", "exo_electricity_demand", "exo_heat_demand", "exo_powerplants", "format_balmorel_data", "format_dkstat", "format_energinet", "format_vpdk21", "geofiles", "geographic_sets", "grids", "heat_profiles", "API Reference", "investment_options", "municipal_template", "offshore_wind", "onshore_vre_func", "plot_dag", "technology_data", "transport_heavy_demand", "transport_road_demand", "utils", "vre_profiles", "Chapter 1", "Section 1", "Section 2", "Balmorel Pre-Processing Framework"], "titleterms": {"1": [28, 29], "2": 30, "about": 0, "aggregate_input": 1, "api": 17, "attribut": [3, 5, 6, 7, 8, 10, 12, 13, 15, 19, 23], "balmorel": 31, "biomass_transport": 2, "chapter": 28, "class": [7, 10, 12, 19, 25], "cluster": 3, "code": 0, "content": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "create_addon_fil": 4, "create_conversion_dictionari": 5, "exo_electricity_demand": 6, "exo_heat_demand": 7, "exo_powerpl": 8, "format_balmorel_data": 9, "format_dkstat": 10, "format_energinet": 11, "format_vpdk21": 12, "framework": 31, "function": [1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 18, 20, 21, 22, 23, 24, 25, 26, 27], "geofil": 13, "geographic_set": 14, "grid": 15, "heat_profil": 16, "investment_opt": 18, "modul": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "municipal_templ": 19, "offshore_wind": 20, "onshore_vre_func": 21, "paramet": 13, "plot_dag": 22, "pre": 31, "process": 31, "refer": 17, "return": 13, "section": [29, 30], "technology_data": 23, "thi": 0, "transport_heavy_demand": 24, "transport_road_demand": 25, "util": 26, "vre_profil": 27}}) \ No newline at end of file