diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..69fe55e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/build/doctrees/Citizen.doctree b/docs/build/doctrees/Citizen.doctree new file mode 100644 index 0000000..3fcdfcd Binary files /dev/null and b/docs/build/doctrees/Citizen.doctree differ diff --git a/docs/build/doctrees/EnergyCalc.doctree b/docs/build/doctrees/EnergyCalc.doctree new file mode 100644 index 0000000..2b2b04e Binary files /dev/null and b/docs/build/doctrees/EnergyCalc.doctree differ diff --git a/docs/build/doctrees/Initialise.doctree b/docs/build/doctrees/Initialise.doctree new file mode 100644 index 0000000..25108b7 Binary files /dev/null and b/docs/build/doctrees/Initialise.doctree differ diff --git a/docs/build/doctrees/Initialise_nhoods.doctree b/docs/build/doctrees/Initialise_nhoods.doctree new file mode 100644 index 0000000..ca5b0d8 Binary files /dev/null and b/docs/build/doctrees/Initialise_nhoods.doctree differ diff --git a/docs/build/doctrees/Main_run.doctree b/docs/build/doctrees/Main_run.doctree new file mode 100644 index 0000000..5e82c0a Binary files /dev/null and b/docs/build/doctrees/Main_run.doctree differ diff --git a/docs/build/doctrees/Movement.doctree b/docs/build/doctrees/Movement.doctree new file mode 100644 index 0000000..4077377 Binary files /dev/null and b/docs/build/doctrees/Movement.doctree differ diff --git a/docs/build/doctrees/Nhood.doctree b/docs/build/doctrees/Nhood.doctree new file mode 100644 index 0000000..4e2f243 Binary files /dev/null and b/docs/build/doctrees/Nhood.doctree differ diff --git a/docs/build/doctrees/Profile.doctree b/docs/build/doctrees/Profile.doctree new file mode 100644 index 0000000..5511081 Binary files /dev/null and b/docs/build/doctrees/Profile.doctree differ diff --git a/docs/build/doctrees/STEBBS.doctree b/docs/build/doctrees/STEBBS.doctree new file mode 100644 index 0000000..1ce9cd3 Binary files /dev/null and b/docs/build/doctrees/STEBBS.doctree differ diff --git a/docs/build/doctrees/SolveGraph.doctree b/docs/build/doctrees/SolveGraph.doctree new file mode 100644 index 0000000..5cdb5d4 Binary files /dev/null and b/docs/build/doctrees/SolveGraph.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle new file mode 100644 index 0000000..61f36b3 Binary files /dev/null and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree new file mode 100644 index 0000000..9f14aee Binary files /dev/null and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/load_solved_graphs.doctree b/docs/build/doctrees/load_solved_graphs.doctree new file mode 100644 index 0000000..2672ee9 Binary files /dev/null and b/docs/build/doctrees/load_solved_graphs.doctree differ diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree new file mode 100644 index 0000000..3a0d072 Binary files /dev/null and b/docs/build/doctrees/modules.doctree differ diff --git a/docs/build/doctrees/multi_processing.doctree b/docs/build/doctrees/multi_processing.doctree new file mode 100644 index 0000000..4edef16 Binary files /dev/null and b/docs/build/doctrees/multi_processing.doctree differ diff --git a/docs/build/doctrees/plotting.doctree b/docs/build/doctrees/plotting.doctree new file mode 100644 index 0000000..82a10cc Binary files /dev/null and b/docs/build/doctrees/plotting.doctree differ diff --git a/docs/build/doctrees/serialize_travel_graphs.doctree b/docs/build/doctrees/serialize_travel_graphs.doctree new file mode 100644 index 0000000..2688908 Binary files /dev/null and b/docs/build/doctrees/serialize_travel_graphs.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo new file mode 100644 index 0000000..9ea0901 --- /dev/null +++ b/docs/build/html/.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: b4aaa4cb3370424f40c61fa4f5d134f3 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/Citizen.html b/docs/build/html/Citizen.html new file mode 100644 index 0000000..f75361c --- /dev/null +++ b/docs/build/html/Citizen.html @@ -0,0 +1,372 @@ + + + + + + + Citizen module — DAVE documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Citizen module

+

DAVE-03 - Citizen.

+
+
+class Citizen.Citizen(home: int, archetype: str, household_size: int, household_num: int, occupant_num: int, age_group: Age, current_grid: int, household_id: str, daytype: int = 0, work_grid: int | None = None, school_grid: int | None = None, subarea: Subarea = Subarea.HOME, state: State = State.ASLEEP, profile: Profile | None = None, movement: Movement | None = None, commute_mode_index: int | None = None, outside_test_area: bool = False)
+

Bases: object

+

Citizen object.

+
+

Parameters

+
+
homeint

Home Nhood of citizen

+
+
archetypestr

Building archetype citizen lives in

+
+
household_sizeint

Number of people living in citizens household

+
+
household_numint

Each household in a grid has a unique number identifier

+
+
occupant_numint

Each occcupant of a household has a unique number identifier

+
+
age_groupAge

Age group of citizen (Infant, Child, Adult, Senior)

+
+
current_gridint

Location of citizen at current time step

+
+
household_idstr

Each household in a building archetype has a unique number identifier

+
+
daytypeint

daytype (0 = workday, 1 = weekend). Initialised as 0 -> CHECK THIS

+
+
work_gridint

Nhood where citizen works. Initialised as None

+
+
school_gridint

Nhood where citizen goes to school. Initialised as None

+
+
current_route

If citzen is travellign this is their current route. Initialised as None

+
+
subareaSubarea

Subarea citizne is in at current timestep. Initialised as Home

+
+
stateState

If citizen is awake or asleep. Initialised as asleep

+
+
profile: Profile

Acitivity profile citizen is currently doing. Initialised as None

+
+
movement: Movement

Movement object holding information about citizens current journey (if travelling). +Initialised as None

+
+
commute_mode_index: int

Transport mode citizen uses for commuting to school/work

+
+
+
+
+add_to_dict(dictionary, key, value)
+

Check if key is in dictionary and initialise as value or add value.

+
+ +
+
+age_group: Age
+
+ +
+
+archetype: str
+
+ +
+
+commute_mode_index: int = None
+
+ +
+
+create_new_destination(ts)
+

Create new movement object for citizen.

+
+ +
+
+current_grid: int
+
+ +
+
+current_route = None
+
+ +
+
+daytype: int = 0
+
+ +
+
+classmethod from_row(grid_name, row)
+

Create citizen object from row of pandas dataframe.

+
+

Parameters

+
+
grid_namestr

Citizens home grid

+
+
row: Dataframe row

Each row of citizen input dataframe contains information on one citizen

+
+
+
+
+ +
+
+get_household_members(all_citizens)
+

Find other citizens who share a household with given citizen.

+
+ +
+
+hh_members_in_same_room(household_members)
+

Return list of household members in same room.

+
+

Parameters

+
+
household_memberslist

List of all household memebers

+
+
+
+
+

Returns

+
+
in_same_roomlist

List of all household members in same room

+
+
+
+
+ +
+
+home: int
+
+ +
+
+household_id: str
+
+ +
+
+household_num: int
+
+ +
+
+household_size: int
+
+ +
+
+increase_subarea_total(household)
+

Increase the total population for citizens subarea in Nhood object +Extract the appliance and metabolic energies, and the number of +water users in each grid from the citizen objects.

+
+ +
+
+movement: Movement = None
+
+ +
+
+next(ts)
+

Move citizen on to next step of energy profile or Movement route.

+
+

Parameters

+
+
tsint

Current time step

+
+
+
+
+ +
+
+occupant_num: int
+
+ +
+
+outside_test_area: bool = False
+
+ +
+
+profile: Profile = None
+
+ +
+
+school_grid: int = None
+
+ +
+
+select_profile(ts)
+

Randomly select activity profile from correct range in profiles.

+
+

Parameters

+
+
tsint

Current time step

+
+
+
+
+ +
+
+state: State = 1
+
+ +
+
+subarea: Subarea = 0
+
+ +
+
+work_grid: int = None
+
+ +
+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/EnergyCalc.html b/docs/build/html/EnergyCalc.html new file mode 100644 index 0000000..9a0f09f --- /dev/null +++ b/docs/build/html/EnergyCalc.html @@ -0,0 +1,347 @@ + + + + + + + EnergyCalc module — DAVE documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

EnergyCalc module

+
+
+EnergyCalc.QF_simple(T2)
+

Returns heating/cooling emissions at the residential level for +either heating/cooling.

+
+

Parameters

+
+
T2np.ndarray

Indoor residential temperature.

+
+
+
+
+

Return

+
+
qf_resnp.ndarray

Heating emissions due to heating/cooling at the residential +level.

+
+
+
+
+ +
+
+EnergyCalc.alter_dom_set_points(use_factor: ndarray, heat_min: float, heat_max: float, av_sp_t3: ndarray) ndarray
+

Provides new heating set point for domestic buildings, based on +active occupants. +Returns array of three set points, one new and two for two +previous time steps, that can be averaged to smoothly reset a +buildings heating set point.

+
+

Parameters

+
+
use_factornp.ndarray

Ratio of active occupants to total residential population.

+
+
heat_minfloat

Minimum heating set point.

+
+
heat_maxfloat

Maximum heating set point.

+
+
av_sp_t3np.ndarray

Set points for previous three time steps.

+
+
+
+
+

Returns

+
+
av_sp_t3np.ndarray

Set points for current and past two time steps.

+
+
+
+
+ +
+
+EnergyCalc.alter_heating_HDD(hdd: tuple) bool
+

Returns truth value of breaching HDD threshold. +First looks at the monthly HDD, then second looks at 5-day rolling +average. +If the HDD value is lower than both thresholds, then TRUE is +returned, meaning that the night time heating set points are used +in day.

+
+

Parameters

+
+
hddtuple

Tuple of monthly and 5-day rolling HDD values (as floats).

+
+
+
+
+

Returns

+

no name : bool

+
+
+ +
+
+EnergyCalc.ext_conv_coeff(wind_speed: ndarray) ndarray
+

Calculates the external convection coefficient using Eq. 11 in +Cole & Sturrock (1977).

+
+

Parameters

+
+
wind_speednp.ndarray

Wind speed $[m s^{-1}]$.

+
+
+
+
+

Returns

+
+
hcnp.ndarray

External convection coefficient.

+
+
+
+
+ +
+
+EnergyCalc.feed_dom_energy(ts: int, nhood: object, tair: ndarray, tsurf: ndarray, irradiance: ndarray, tground: ndarray, windspeed: ndarray, kwall: array, tsky: float, ldown: float, lwall: float)
+

Feeds appliance power demand and environmental variables into the +domestic BEMs, prompting the BEMs to simulate HC power demand and +QF emission into the outdoor environment.

+
+

Parameters

+
+
tairnp.ndarray

Outdoor air temperature [C].

+
+
tsurfnp.ndarray

Surface temperature [C].

+
+
irradiancenp.ndarray

Outdoor irradiance $[W m^{-2}]$.

+
+
tgroundnp.ndarray

Deep soil temperature [C].

+
+
windspeednp.ndarray

Outdoor wind speed $[m s^-1]$.

+
+
+
+
+

Returns

+
+
qfb_dom_airnp.ndarray

Sensible energy output from domestic buildings to outdoor air +for each AN [W].

+
+
qfb_dom_grnp.ndarray

Sensible energy output from domestic buildings to ground for +each AN [W].

+
+
qfm_domnp.ndarray

Energy output from metabolic sources in domestic buildings for +each AN [W].

+
+
qheat_domnp.ndarray

Power demand for heating domestic buildings for each AN [W].

+
+
qcool_domnp.ndarray

Power demand for cooling domestic buildings for each AN [W].

+
+
avindtempnp.ndarray

Average indoor temperature [K].

+
+
qfb_dom_fabricnp.ndarray

Energy output into domestic building fabric in each AN [W].

+
+
qhw_domnp.ndarray

Power demand for water heating in domestic buildings for each +AN [W].

+
+
+
+
+ +
+
+EnergyCalc.floor_plan(height, footprint)
+

“Calculate floor plan area from height_building and footprint area

+
+ +
+
+EnergyCalc.forcing_SUEWS(forcing_days, nhoods, coupled_forcing=False)
+

Returns the relevant meteorological features of the simulation.

+
+

Parameters

+
+
forcing_dayslist

Starting and ending date (“%d/%m/%Y”) of the simulation to +run. Figures from SUEWs are available for 2012 only, +so Y = 2012.

+
+
nhoodsnp.ndarray

List of the inquired neighbourhoods (output areas).

+
+
+

coupled_forcing: bool

+
+
+

Return

+
+
qf_extpd.core.series.Series

Simple heating emission estimate (using initial temperatures).

+
+
dict_forcingdict

date - timestep as keys, meteorological variables as values.

+
+
dict_statedict

date, spatial grid as keys, initial state meteorological +variables as values.

+
+
tstampsTimestamp

timestep inquired in Timestamp format.

+
+
+
+
+ +
+
+
+EnergyCalc.run_SUEWS_ts(envs, day_count, ts)
+

Returns the estimated heating emissions and energy demand +components for an inidividual timestep.

+
+

Parameters

+
+
dict_forcingdict

date - timestep as keys, meteorological variables as values.

+
+
dict_statedict

date, spatial grid as keys, initial state meteorological +variables as values.

+
+
forcing_tstampsTimestamp

The timestamp of the timestep at which the simulation is run.

+
+
day_countint

Progressive count of the days on which the simulation is being +run. The spin-up day has normally day_count = 0.

+
+
tsint

Progressive ten-minute time slot from 4 AM, included in +range(144). E.g., ts = 0 corresponds to 4:00 AM to 4:10 AM, +ts = 11 to 5:10 AM to 5:20 AM.

+
+
datestr

Environmental variable date in format “%d/%m/%y %H:%M”.

+
+
qf_extpd.core.series.Series

Simple heating emission estimate (using initial temperatures).

+
+
case_qffloat

Initial value for Qf - heating emission.

+
+
+
+
+

Return

+

tair +tsurf +kdn +windspeed

+
+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/Initialise.html b/docs/build/html/Initialise.html new file mode 100644 index 0000000..9eb900d --- /dev/null +++ b/docs/build/html/Initialise.html @@ -0,0 +1,171 @@ + + + + + + + Initialise module — DAVE documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Initialise module

+

Functions for initialising citizen and nhood objects.

+

Megan McGrory - Feb 2023

+
+
+class Initialise.Grid(name, journeys, stations)
+

Bases: object

+
+ +
+
+class Initialise.Journey(destination, time, mode)
+

Bases: object

+
+ +
+
+Initialise.assign_all_school_work_places(all_citizens, all_nhoods)
+
+ +
+
+Initialise.assign_school_work_place(all_nhoods, citizen)
+

Assign citizen with a school or work grid depending on age group.

+
+ +
+
+Initialise.create_all_citizens()
+

Create dictionary of citizen objects, classified by age group.

+
+

Returns

+

all_citizens: dict

+
+
+ +
+
+Initialise.create_all_profiles(all_energy_profiles)
+

Create dict of profiles from input files.

+
+ +
+
+Initialise.relative_path_to_absolute_path(relative_path)
+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/Initialise_nhoods.html b/docs/build/html/Initialise_nhoods.html new file mode 100644 index 0000000..b0039c9 --- /dev/null +++ b/docs/build/html/Initialise_nhoods.html @@ -0,0 +1,146 @@ + + + + + + + Initialise_nhoods module — DAVE documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Initialise_nhoods module

+

Functions for initialising citizen and nhood objects.

+

Megan McGrory - Feb 2023

+
+
+Initialise_nhoods.assign_households(all_citizens, nhood)
+
+ +
+
+Initialise_nhoods.create_all_nhoods()
+

Create dictionary of all nhoods

+
+ +
+
+Initialise_nhoods.order_files(filenames)
+

reorder filenames to match nhood_list

+
+ +
+
+Initialise_nhoods.relative_path_to_absolute_path(relative_path)
+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/Main_run.html b/docs/build/html/Main_run.html new file mode 100644 index 0000000..07d92cf --- /dev/null +++ b/docs/build/html/Main_run.html @@ -0,0 +1,116 @@ + + + + + + + Main_run module — DAVE documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Main_run module

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/Movement.html b/docs/build/html/Movement.html new file mode 100644 index 0000000..f9c603c --- /dev/null +++ b/docs/build/html/Movement.html @@ -0,0 +1,206 @@ + + + + + + + Movement module — DAVE documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Movement module

+

MovementControl.py +This module contains the Movement class, which stores the rules for the +Movement of citizens.

+
+
+class Movement.Movement(travel_from: int, travel_to: int, ts: int)
+

Bases: object

+

Object for the exchange of citizens between nhoods and subareas.

+
+

Parameters

+

travel_from: int +travel_to: int +ts: int

+
+
+

Attributes

+
+
+choose_mode(start_caps, end_caps)
+

Choose a starting travel mode. +Remove modes with capacity zero.

+
+ +
+
+find_route(start, end, graph_index)
+
+ +
+
+get_capacities(grid, ts)
+

Get capacity for given mode from capacity file

+
+ +
+
+get_capacity(mode, grid, ts)
+

Get capacity for given mode from capacity file

+
+ +
+
+get_mode_users(current_grid, subarea)
+

Return numbers of people using given mode (in given travel subarea).

+
+ +
+
+grids_in_ts(start, end, leg_times_cumsum)
+
+ +
+
+grids_travelled_through(tss, leg_times_cumsum)
+
+ +
+
+next(ts)
+

Move citizen along on route

+
+ +
+
+ +
+
+Movement.load_saved_graph(filename)
+
+ +
+
+Movement.relative_path_to_absolute_path(relative_path)
+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/Nhood.html b/docs/build/html/Nhood.html new file mode 100644 index 0000000..f765bf6 --- /dev/null +++ b/docs/build/html/Nhood.html @@ -0,0 +1,343 @@ + + + + + + + Nhood module — DAVE documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Nhood module

+
+
+class Nhood.BuildingArchetype(name: str, building: LBM, households: list)
+

Bases: object

+

An object holding attributes of building archetypes

+
+
+building: LBM
+
+ +
+
+households: list
+
+ +
+
+name: str
+
+ +
+ +
+
+class Nhood.Nhood(name: int, household_sizes: list[int], work_pop: int, shop_pop: int, primary_pop: int, secondary_pop: int, nhood_area: float, sso_areas: dict[SSO, float], industrial_modifiers: float, gravity_weights: dict[Subarea, dict[int, int]], subarea_pops: dict[Subarea, int], domestic_buildings: list, commercial_buildings: list, households: dict)
+

Bases: object

+

An object holding data for a neighbourhood (AN) and its subareas: +domestic, workplace, primary school, secondary school, shops and +other.

+
+
+commercial_buildings: list
+
+ +
+
+domestic_buildings: list
+
+ +
+
+classmethod from_grid_file(grid_file, gravity_weights)
+

Create Nhood object from file.

+
+ +
+
+gravity_weights: dict[Subarea, dict[int, int]]
+
+ +
+
+household_sizes: list[int]
+
+ +
+
+households: dict
+
+ +
+
+industrial_modifiers: float
+
+ +
+
+name: int
+
+ +
+
+nhood_area: float
+
+ +
+
+primary_pop: int
+
+ +
+
+reset_subarea_populations()
+
+ +
+
+secondary_pop: int
+
+ +
+
+select_grid_for_subarea(subarea)
+
+ +
+
+shop_pop: int
+
+ +
+
+sso_areas: dict[SSO, float]
+
+ +
+
+subarea_pops: dict[Subarea, int]
+
+ +
+
+work_pop: int
+
+ +
+ +
+
+class Nhood.SSO(value)
+

Bases: Enum

+

An enumeration.

+
+
+CULTURAL = 1
+
+ +
+
+HIGHENT = 2
+
+ +
+
+HIGHST = 3
+
+ +
+
+HOSPITAL = 4
+
+ +
+
+LOWSHOPS = 5
+
+ +
+
+OTHERMID = 6
+
+ +
+
+RESTAURANT = 7
+
+ +
+
+SCHOOL = 8
+
+ +
+
+SUPERMARKET = 9
+
+ +
+
+UNIVERSITY = 10
+
+ +
+
+ZERO = 11
+
+ +
+
+classmethod from_string(s)
+
+ +
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/Profile.html b/docs/build/html/Profile.html new file mode 100644 index 0000000..171cc62 --- /dev/null +++ b/docs/build/html/Profile.html @@ -0,0 +1,479 @@ + + + + + + + Profile module — DAVE documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Profile module

+
+
+class Profile.Age(value)
+

Bases: Enum

+

An enumeration.

+
+
+ADULT = 1
+
+ +
+
+CHILD = 2
+
+ +
+
+INFANT = 5
+
+ +
+
+SENIOR = 4
+
+ +
+
+TEENAGER = 3
+
+ +
+
+classmethod from_string(s)
+
+ +
+ +
+
+class Profile.DayType(value)
+

Bases: Enum

+

An enumeration.

+
+
+WEEKDAY = 2
+
+ +
+
+WEEKEND = 1
+
+ +
+
+classmethod from_string(s)
+
+ +
+ +
+
+class Profile.Profile(age: Profile.Age, household_size: int, day_type: Profile.DayType, ts: int, initial_subarea: Profile.Subarea, final_subarea: Profile.Subarea, initial_state: Profile.State, final_state: Profile.State, appliance_energy: list[float], metabolic_energy: list[float], light_use: list[int], water_use: list[int], rooms: list[str], finished: bool = False)
+

Bases: object

+
+
+age: Age
+
+ +
+
+appliance_energy: list[float]
+
+ +
+
+day_type: DayType
+
+ +
+
+final_state: State
+
+ +
+
+final_subarea: Subarea
+
+ +
+
+finished: bool = False
+
+ +
+
+classmethod from_row(row)
+
+ +
+
+household_size: int
+
+ +
+
+initial_state: State
+
+ +
+
+initial_subarea: Subarea
+
+ +
+
+key()
+
+ +
+
+light_use: list[int]
+
+ +
+
+metabolic_energy: list[float]
+
+ +
+
+next()
+
+ +
+
+rooms: list[str]
+
+ +
+
+ts: int
+
+ +
+
+water_use: list[int]
+
+ +
+ +
+
+class Profile.State(value)
+

Bases: Enum

+

An enumeration.

+
+
+ASLEEP = 1
+
+ +
+
+AWAKE = 2
+
+ +
+
+classmethod from_string(s)
+
+ +
+ +
+
+class Profile.Subarea(value)
+

Bases: Enum

+

An enumeration.

+
+
+BUS = 16
+
+ +
+
+CULTURAL = 5
+
+ +
+
+CYCLING = 19
+
+ +
+
+DRIVING = 20
+
+ +
+
+HEALTHCARE = 11
+
+ +
+
+HOME = 0
+
+ +
+
+HOSPITALITY = 12
+
+ +
+
+HOTEL = 10
+
+ +
+
+INDOORENT = 7
+
+ +
+
+LARGESHOP = 4
+
+ +
+
+OUTDOOR = 9
+
+ +
+
+OUTDOORENT = 8
+
+ +
+
+PRIMARY_SCHOOL = 2
+
+ +
+
+SECONDARY_SCHOOL = 3
+
+ +
+
+SMALLSHOP = 13
+
+ +
+
+TEMPRES = 6
+
+ +
+
+TRAIN = 18
+
+ +
+
+TUBE = 17
+
+ +
+
+UNIVERSITY = 14
+
+ +
+
+WAIT = 21
+
+ +
+
+WALKING = 15
+
+ +
+
+WORK = 1
+
+ +
+
+classmethod from_string(s)
+
+ +
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/STEBBS.html b/docs/build/html/STEBBS.html new file mode 100644 index 0000000..3575055 --- /dev/null +++ b/docs/build/html/STEBBS.html @@ -0,0 +1,1763 @@ + + + + + + + STEBBS module — DAVE documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

STEBBS module

+
+
+class STEBBS.LBM(nameListFile='none', nameList='none', commercial='none', w=0.0, h=0.0, d=0.0)
+

Bases: object

+

Simplified Thermal Energy Balance for Buildings Scheme (STEBBS)

+
+

Parameters

+
+
nameListFile: f90nml.Namelist.Namelist

NML file of domestic building archetypes and their parameters

+
+
nameList: str

Path to nameList file

+
+
commercial: bool

Bool for commercial building assignment

+
+
w: float

Width of building (x-axis) [m]

+
+
h: float

Height of building (z-axis) [m]

+
+
d: float

Depth of building (y-axis) [m]

+
+
+
+
+

Attributes

+

# NOTE: ‘HEAT FLUX’ ATTRIBUTES ARE GIVEN IN WATTS, TO BE DIVIDED BY +# AREA LATER +Qheat: float

+
+

Power demand for heating [W] +(Currently only sensible but this needs to be split into +sensible and latent heat components)

+
+
+
Qcool: float

Power demand for cooling [W] +(Currently only sensible but this needs to be split into +sensible and latent heat components)

+
+
Qmetabolic_sensible: float

Sensible heat flux from people in building [W]

+
+
Qmetabolic_latent: float

Latent heat flux from people in building [W]

+
+
Qtotal_water_tank: float

Power demand for heating water [W]

+
+
qhwtDrain: float

Energy in water drained from building to sewers [W]

+
+
EnergyExchange: list

Stores all surface energy exchanges of the timestep calculation +to allow QF,B and Qs to be calculated. In order: +Transmitted insolation through window [W] (Qsw_transmitted_window) +Absorbed insolation by window (Qsw_absorbed_window) [W] +Absorbed insolation by wall (Qsw_absorbed_wallroof) [W] +Convective heat transfer indoor air and internal mass (Qconv_indair_to_indoormass) [W] +Indoor wall surfaces radiative exchange (Qlw_net_intwallroof_to_allotherindoorsurfaces) +Indoor window surface radiative exchange (Qlw_net_intwindow_to_allotherindoorsurfaces) +Ground floor internal radiative exchange (Qlw_net_intgroundfloor_to_allotherindoorsurfaces) +Internal appliance gains (Q_appliance) [W] +Ventilation heat transfer (Q_ventilation) [W] +Indoor wall convective heat transfer (Qconv_indair_to_intwallroof) [W] +Indoor window convective heat transfer (Qconv_indair_to_intwindow) [W] +Indoor floor convective heat transfer (Qconv_indair_to_intgroundfloor) [W] +Additional system Heating Energy - loss due to efficiency (Qloss_efficiency_heating_air) [W] +Wall heat conduction, inside to outside (Qcond_wallroof) [W] +Window heat conduction, inside to outside (Qcond_window) [W] +Floor heat conduction, inside to outside (Qcond_groundfloor) [W] +Conducted heat to the ground (Qcond_ground) [W] +Outside wall radiative heat transfer (Qlw_net_extwallroof_to_outair) [W] +Outside window radiative heat transfer (Qlw_net_extwindow_to_outair) [W] +Outside wall convective heat transfer (Qconv_extwallroof_to_outair) [W] +Outside window convective heat transfer (Qconv_extwindow_to_outair) [W] +Heat and associated system energy ejected by cooling system +of building [W] +Heat storage flux (QS), [W] +Heat storage flux of fabric (QS_fabric), [W] +Heat storage flux of indoor air (QS_air), [W]

+
+
sigma: float

Stefan-Boltzmann constant [W m-2 K-4]

+
+
height_building: float

Height of building (z-axis) [m]

+
+
Afootprint: float

Floor plan area of buliding [m2]

+
+
wallExternalArea: float

External wall area [m2]

+
+
ratioInternalVolume: float

Ratio of internal to external volume [-]

+
+
ratio_window_wall: float

Window to wall ratio

+
+
thickness_wallroof: float

Wall and roof thickness (not separate) [m]

+
+
thickness_groundfloor: float

Ground floor thickness [m]

+
+
depth_ground: float

Depth of ground considered for calculating QF,B to ground [m]

+
+
thickness_window: float

Thickness of all windows [m]

+
+
conv_coeff_intwallroof: float

Internal convection coefficient for walls and roof [W m-2 K-1]

+
+
conv_coeff_indoormass: float

Convection coefficient for internal mass [W m-2 K-1]

+
+
conv_coeff_intgroundfloor: float

Convection coefficient for floors [W m-2 K-1]

+
+
conv_coeff_intwindow: float

Convection coefficient for internal window surface [W m-2 K-1]

+
+
conv_coeff_extwallroof: float

Initial convection coefficient for walls and roof [W m-2 K-1]

+
+
conv_coeff_extwindow: float

Initial convection coefficient for external surface of windows +[W m-2 K-1]

+
+
conductivity_wallroof: float

Effective conductivity of walls and roofs, calculated as +Ltotal / (Ln / kn) for n components of the wall/roof [W m-1 K-1]

+
+
conductivity_groundfloor: float

Effective conductivity of the ground floor, calculated as +Ltotal / (Ln / kn) for n components of the wall/roof [W m-1 K-1]

+
+
conductivity_window: float

Effective conductivity of windows, calculated as +Ltotal / (Ln / kn) for n components of the wall/roof [W m-1 K-1]

+
+
conductivity_ground: float

Conductivity of external ground [W m-1 K-1]

+
+
density_wallroof: float

Density of the walls and roof [kg m-3]

+
+
density_groundfloor: float

Density of the ground floor [kg m-3]

+
+
density_window: float

Density of the windows [kg m-3]

+
+
density_indoormass: float

Density of the internal mass [kg m-3]

+
+
density_air_ind: float

Density of the indoor air [kg m-3]

+
+
cp_wallroof: float

Specific heat capacity of walls and roof [J K-1 kg-1]

+
+
cp_groundfloor: float

Specific heat capacity of ground floor [J K-1 kg-1]

+
+
cp_window: float

Specific heat capacity of windows [J K-1 kg-1]

+
+
cp_indoormass: float

Specific heat capacity of the internal mass [J K-1 kg-1]

+
+
cp_air_ind: float

Specific heat capacity of indoor air [J K-1 kg-1]

+
+
emissivity_extwallroof: float

Emissivity of walls and roof external surface

+
+
emissivity_intwallroof: float

Emissivity of walls and roof internal surface

+
+
emissivity_indoormass: float

Emissivity of internal mass surface

+
+
emissivity_extwindow: float

Emissivity of windows external surface

+
+
emissivity_intwindow: float

Emissivity of windows internal surface

+
+
windowTransmissivity: float

Transmissivity of windows

+
+
windowAbsorbtivity: float

Absorbtivity of windows

+
+
windowReflectivity: float

Reflectivity of windows

+
+
wallTransmisivity: float

Transmissivity of walls

+
+
wallAbsorbtivity: float

Absorbtivity of walls

+
+
wallReflectivity: float

Reflectivity of walls

+
+
BVF_extwall: float

Building view factor of external walls

+
+
GVF_extwall: float

Ground view factor of external walls

+
+
SVF_extwall: float

Sky view factor of external walls

+
+
occupants: float

Number of occupants present in building

+
+
metabolic_rate: float

Metabolic rate of building occupants [W]

+
+
ratio_metabolic_latent_sensible: float

Latent-to-sensible ratio of metabolic energy release of occupants

+
+
appliance_power_rating: float

Power demand of single appliance [W]

+
+
appliance_totalnumber: int

Number of appliances present

+
+
appliance_usage_factor: float

Number of appliances in use

+
+
maxheatingpower_air: float

Maximum power demand of heating system [W]

+
+
heating_efficiency_air: float

Efficiency of heating system

+
+
maxcoolingpower_air: float

Maximum power demand of cooling system [W]

+
+
coeff_performance_cooling: float

Coefficient of performance of cooling system

+
+
Vair_ind: float

Volume of air (volume of building multiplied by factor that +accounts for internal mass [m3]

+
+
ventilation_rate: float

Ventilation rate (air changes per second) [m3 s-1]

+
+
Awallroof: float

Area of walls [m2]

+
+
Vwallroof: float

Volume of walls [m2]

+
+
Vgroundfloor: float

Volume of ground floor [m3]

+
+
Awindow: float

Total area of windows [m2]

+
+
Vwindow: float

Total volume of windows [m3]

+
+
Vindoormass: float

Total volume of internal mass [m3]

+
+
Aindoormass: float

Total surface area of internal mass, assuming that internal mass is +a cube [m3]

+
+
h_i: list

Internal convection coefficients, in order: wall and roof, internal +mass, floor, windows [W m-2 K-1]

+
+
h_o: list

External convection coefficients, in order: wall and roof, +window [W m-2 K-1]

+
+
k_eff: list

Effective conductivities, in order: wall and roof, ground floor, +windows, external ground [W m-1 K-1]

+
+
rho: list

Densities, in order: wall and roof, ground floor, windows, internal +mass [kg m-3]

+
+
Cp: list

Specific heat capacities, in order: wall and roof, ground floor, +windows, internal mass, indoor air [J K-1 kg-1]

+
+
emis: list

Emissivities, in order: external wall and roof surfaces, internal wall +and roof surfaces, internal mass, external window surface, internal +window surface

+
+
wiTAR: list

Window properties, in order: transmissivity, absorbtivity, reflectivity

+
+
waTAR: list

Wall properties, in order: transmissivity, absorbtivity, reflectivity

+
+
viewFactors: list

View factors, in order: building, ground, sky

+
+
occupantData: list

Occupant data, in order: number of occupants, metabolic rate [W], +latent-to-sensible ratio

+
+
Tair_ind: float

Indoor air temperature [K]

+
+
Tindoormass: float

Indoor mass temperature [K]

+
+
Tintwallroof: float

Wall indoor surface temperature [K]

+
+
Textwallroof: float

Wall outdoor surface temperature [K]

+
+
Tintwindow: float

Window indoor surface temperature [K]

+
+
Textwindow: float

Window outdoor surface temperature [K]

+
+
Tintgroundfloor: float

Ground floor indoor surface temperature [K]

+
+
Textgroundfloor: float

Ground floor outdoor surface temperature [K]

+
+
Ts: list

Heating and Cooling setpoint temperatures, respectively [K]

+
+
initTs:list

Initial heating and cooling setpoint temperatures, respecitively [K]

+
+
HTsAverage: np.ndarray

Heating set points from current and two previous time steps [K]

+
+
HWTsAverage: np.ndarray

Hot water set points from current and two previous time steps [K]

+
+
Twater_tank: float

Water temperature in hot water tank [K]

+
+
Tintwall_tank: float

Hot water tank internal wall temperature [K]

+
+
Textwall_tank: float

Hot water tank external wall temperature [K]

+
+
thickness_tankwall: float

Hot water tank wall thickness (m)

+
+
Tincomingwater_tank: float

Temperature of water coming into the water tank [K]

+
+
Vwater_tank: float

Volume of water in hot water tank [m3]

+
+
Asurf_tank: float

Surface area of hot water tank (cylinder h= 1.5) [m2]

+
+
Vwall_tank: float

Wall volume of hot water tank [m2]

+
+
setTwater_tank: float

Water Tank setpoint temperature [K]

+
+
init_wtTs: float

Initial water tank setpoint temperature [K]

+
+
Twater_vessel: float

Water temperature of water held in use in building [K]

+
+
Tintwall_vessel: float

Hot water vessel internal wall temperature [K]

+
+
Textwall_vessel: float

Hot water vessel external wall temperature [K]

+
+
thickness_wall_vessel: float

Hot water vessel wall thickness [m]

+
+
Vwater_vessel: float

Volume of water held in use in building [m3]

+
+
Awater_vessel: float

Surface area of hot water in vessels in building [m2]

+
+
Vwall_vessel: float

Wall volume of hot water vessels in building [m3]

+
+
flowrate_water_supply: float

Hot water flow rate from tank to vessel [m3 s-1]

+
+
flowrate_water_drain: float

Flow rate of hot water held in building to drain [m3 s-1]

+
+
single_flowrate_water_supply: float

Hot water flow rate for a single use fo hot water [m3 s-1]

+
+
single_flowrate_water_supply: float

Flow rate of hot water draining held in building to drain for +a single use of hot water [m3 s-1]

+
+
cp_water: float

Specific heat capacity of hot water [J kg-1 K-1]

+
+
cp_wall_tank: float

Specific heat capacity of hot water tank wall [J kg-1 K-1]

+
+
cp_wall_vessel: float

Specific heat capacity of vessels containing hot water in use in +building [J K-1 kg-1]

+
+
density_water: float

Density of hot water in use [kg m-3]

+
+
density_wall_tank: float

Density of hot water tank wall [kg m-3]

+
+
density_wall_vessel: float

Density of vessels containing hot water in use [kg m-3]

+
+
BVF_tank: float

Water tank - building wall view factor

+
+
MVF_tank: float

Water tank - building internal mass view factor

+
+
conductivity_wall_tank: float

Effective wall conductivity of the hot water tank [W m-1 K-1]

+
+
conv_coeff_intwall_tank: float

Effective internal wall convection coefficient of the hot water +tank [W m-2 K-1]

+
+
conv_coeff_extwall_tank: float

Effective external wall convection coefficient of the hot water +tank [W m-2 K-1]

+
+
emissivity_extwall_tank: float

Effective external wall emissivity of the hot water tank

+
+
conductivity_wall_vessel: float

Effective conductivity of vessels containing hot water in use in +building [W m-1 K-1]

+
+
conv_coeff_intwall_vessel: float

Effective internal wall convection coefficient of the vessels holding +hot water in use in building [W m-2 K-1]

+
+
conv_coeff_extwall_vessel: float

Effective external wall convection coefficient of the vessels holding +hot water in use in building [W m-2 K-1]

+
+
emissivity_extwall_vessel: float

Effective external wall emissivity of hot water being used within +building

+
+
maxheatingpower_water: float

Maximum power demand for water haeting system [W]

+
+
heating_efficiency_water: float

Efficiency of hot water system

+
+
minVwater_vessel: float

Minimum volume of hot water in use [m3]

+
+
minHeatingPower_DHW: float

Minimum power demand of hot water system [W]

+
+
HeatingPower_DHW: float

Current power demand of water heating system [W]

+
+
HWPowerAverage: np.ndarray

Water heating set points from current and two previous time steps [K]

+
+
+
+
+HWflowrate_change(users: float, resolution: int)
+

Changes the flow rates from hot water tank to the vessel and the vessel +to the drain [m3 s-1] by the number of hot water users

+
+

Parameters

+
+
usersfloat

Number of hot water users

+
+
resolutionint

Seconds in time step [s]

+
+
+
+
+ +
+
+additionalSystemCoolingEnergy(q_cooling, COP)
+

Calculates the additional heat from the cooling system due to +system COP [W]

+
+

Parameters

+

q_cooling +COP

+
+
+

Returns

+
+
float

coolwcop: additional heat from the cooling system due to +system COP [W]

+
+
+
+
+ +
+
+additionalSystemHeatingEnergy(q_heating, epsilon)
+

Calculates the additional heat from the heating system due to system +efficiency [W]

+
+

Parameters

+
+
q_heatingfloat

Heat injected into building by heating system [W]

+
+
epsilonfloat

Rated efficiency of the total heating system

+
+
+
+
+

Returns

+
+
float

qH_additional: additional heat from the heating system due to +system efficiency [W]

+
+
+
+
+ +
+
+cooling(Ts, Ti, COP, P)
+

Heat ejected from the buliding by the cooling system [W]

+

Designed to ramp power exponentially according to temperature +difference. +Parameters +———- +Ts : float

+
+

Set point temperature for cooling load [K]

+
+
+
Tifloat

Indoor air node temperature [K]

+
+
COPfloat

Rated efficiency of the total heating system

+
+
Pfloat

Maximum power rating of the total heating system [W]

+
+
+
+

Returns

+
+
float

q_cooling: Heat ejected from the buliding by the cooling system [W]

+
+
+
+
+ +
+
+getAll()
+

Get all building attributes (list)

+
+ +
+
+getAllDHW()
+

Print all hot water attributes

+
+ +
+
+getHTsAverage()
+

Get heating set points from current and two previous time steps [K] +(np.ndarray)

+
+ +
+
+getHWTsAverage()
+

Get hot water set points from current and two previous time steps [K] +(np.ndarray)

+
+ +
+
+getIndoorAirTemperature()
+

Get indoor air temperature [K] (float)

+
+ +
+
+getIndoorFloorTemperature()
+

Get indoor floor temperature [K] (float)

+
+ +
+
+getIndoorMassTemperature()
+

Get indoor mass temperature [K] (float)

+
+ +
+
+getIndoorWallTemperature()
+

Get indoor wall temperature [K] (float)

+
+ +
+
+getIndoorWindowTemperature()
+

Get indoor window temperature [K] (float)

+
+ +
+
+getOutdoorFloorTemperature()
+

Get outdoor floor temperature [K] (float)

+
+ +
+
+getOutdoorWallTemperature()
+

Get outdoor wall temperature [K] (float)

+
+ +
+
+getOutdoorWindowTemperature()
+

Get outdoor window temperature [K] (float)

+
+ +
+
+getTimestepEnergyExchanges()
+

Get all surface energy exchanges of the timestep calculation +In order: +Transmitted insolation through window [W] (Qsw_transmitted_window) +Absorbed insolation by window (Qsw_absorbed_window) [W] +Absorbed insolation by wall (Qsw_absorbed_wallroof) [W] +Convective heat transfer indoor air and internal mass (Qconv_indair_to_indoormass) [W] +Indoor wall surfaces radiative exchange (Qlw_net_intwallroof_to_allotherindoorsurfaces) +Indoor window surface radiative exchange (Qlw_net_intwindow_to_allotherindoorsurfaces) +Ground floor internal radiative exchange (Qlw_net_intgroundfloor_to_allotherindoorsurfaces) +Internal appliance gains (Q_appliance) [W] +Ventilation heat transfer (Q_ventilation) [W] +Indoor wall convective heat transfer (Qconv_indair_to_intwallroof) [W] +Indoor window convective heat transfer (Qconv_indair_to_intwindow) [W] +Indoor floor convective heat transfer (Qconv_indair_to_intgroundfloor) [W] +Additional system Heating Energy - loss due to efficiency (Qloss_efficiency_heating_air) [W] +Wall heat conduction, inside to outside (Qcond_wallroof) [W] +Window heat conduction, inside to outside (Qcond_window) [W] +Floor heat conduction, inside to outside (Qcond_groundfloor) [W] +Conducted heat to the ground (Qcond_ground) [W] +Outside wall radiative heat transfer (Qlw_net_extwallroof_to_outair) [W] +Outside window radiative heat transfer (Qlw_net_extwindow_to_outair) [W] +Outside wall convective heat transfer (Qconv_extwallroof_to_outair) [W] +Outside window convective heat transfer (Qconv_extwindow_to_outair) [W] +Heat and associated system energy ejected by cooling system +of building [W] +Heat storage flux (QS), [W] +Heat storage flux of fabric (QS_fabric), [W] +Heat storage flux of indoor air (QS_air), [W]

+
+ +
+
+heating(Ts, Ti, epsilon, P)
+

Heat injected into building by heating system [W]

+

Designed to ramp power exponentially according to temperature +difference. +Parameters +———- +Ts : float

+
+

Set point temperature for heating load [K]

+
+
+
Tifloat

Indoor air node temperature [K]

+
+
epsilonfloat

Rated efficiency of the total heating system

+
+
Pfloat

Maximum power rating of the total heating system [W]

+
+
+
+

Returns

+
+
float

q_heating: Heat injected into building by heating system [W]

+
+
+
+
+ +
+
+indoorConvectionHeatTransfer(h: float, A: float, Twi: float, Ti: float)
+

Indoor convection on wall surfaces: convective heat transfer between +air node and wall node(s) [W] +Parameters +———- +h : float

+
+

Convection coefficient for wall surface type (i.e. solid wall, +window) [W m-2 K-1]

+
+
+
Afloat

Total surface area of wall surface type [m2]

+
+
Twifloat

Wall surface temperature for surface [K]

+
+
Tifloat

Internal air temperature [K]

+
+
+
+

Returns

+
+
float

ind_cht: Indoor convection on wall surfaces

+
+
+
+
+ +
+
+indoorRadiativeHeatTransfer()
+

Indoor radiative exchange between wall surfaces and mass internal +object +Returns +——- +float

+
+

q: Indoor radiative exchange between wall surfaces and mass +internal object

+
+
+ +
+
+internalApplianceGains(P, f, n)
+

Calculates the internal gains [W] for total n appliances +of given Power, P, with usage factor, f

+
+

Parameters

+
+
Pfloat

Power rating of appliances [W]

+
+
ffloat

Usage factor of appliances

+
+
nint

Number of appliances

+
+
+
+
+

Returns

+
+
float

in_app_gain: Internal appliance heat gain [W]

+
+
+
+
+ +
+
+internalConvectionHeatTransfer(h: float, A: float, Tio: float, Ti: float)
+

Indoor convection on surfaces of objects and internal walls in building

+

These are considered together as a single mass object with equal +temperature [W] +Parameters +———- +h : float

+
+

Convection coefficient for wall surface type (i.e. solid wall, +window) [W m-2 K-1]

+
+
+
Afloat

Total surface area of wall surface type [m2]

+
+
Tiofloat

Surface temperature of internal objects [K]

+
+
Tifloat

Indoor air temperature [K]

+
+
+
+

Returns

+
+
float

int_cht : Indoor convection on surfaces of objects and internal +walls in building

+
+
+
+
+ +
+
+internalOccupancyGains(Occupants, metRate, LSR)
+

Calculates the internal gains from building occupants

+

Returns the latent heat and sensible heat from all occupants +Parameters +———- +Occupants : int

+
+

Number of occupants

+
+
+
metRatefloat

Metabolic rate of occupants [W]

+
+
LSRfloat

Latent to sensible ratio of metabolic heat release

+
+
+
+

Returns

+
+
float

occ_m: internal gains from building occupants [W]

+
+
+
+
+ +
+
+outdoorConvectionHeatTransfer(h, A, Two, Ta)
+

Outdoor convection on surfaces: convective heat transfer between +outside wall surface and ambient air node [W] +Parameters +———- +h : float

+
+

Convection coefficient for wall surface type (i.e. solid wall, +window) [W m-2 K-1]

+
+
+
Afloat

Total surface area of wall surface type [m2]

+
+
Twofloat

Wall outdoor-surface temperature [K]

+
+
Tafloat

Ambient air temperature (determined outside this model) [K]

+
+
+
+

Returns

+
+
float

out_cht: Outdoor convection on surfaces

+
+
+
+
+ +
+
+outdoorRadiativeHeatTransfer(f, A, emis, Two, Ts)
+

Outdoor radiation from outdoor surface

+
+

Parameters

+
+
ffloat

All view factors

+
+
Afloat

Building wall surface area for wall component [m2]

+
+
emisfloat

Emissivity of surface NOTE: Considered constant for all surfaces +here, not implemented as list

+
+
Twofloat

Outdoor surface temperatures for each wall component [K]

+
+
Tsfloat

Surface(or effective sky) temperatures for surface with which the wall +component has a view (i.e. corresponding list to f) [K]

+
+
+
+
+

Returns

+
+
float

q: Outdoor radiation from outdoor surface

+
+
+
+
+ +
+
+reinitialiseHC()
+

Reinitialises the total heating and cooling of the building object.

+

May want to call this each time an instance of class is called from +external program (i.e. to give Qf for urban building energy model +timestep)

+
+ +
+
+reinitialiseTemperatures(ti: float, tm: float, twi: float, two: float, twii: float, twio: float, tfi: float, tfo: float)
+

Reinitialise surface and mass temperatures for building

+
+

Parameters

+
+
tifloat

Indoor air temperature [K]

+
+
tmfloat

Indoor mass temperature [K]

+
+
twifloat

Indoor wall surface temperature [K]

+
+
twofloat

Outdoor wall surface temperature [K]

+
+
twiifloat

Indoor window surface temperature [K]

+
+
twiofloat

Outdoor window surface temperature [K]

+
+
tfifloat

Indoor ground floor surface temperature [K]

+
+
tfofloat

Outdoor ground floor surface temperature [K]

+
+
+
+
+ +
+
+setAirAndMassVolume(f: float)
+

Sets air and internal mass volumes [m3] of building with new air to +mass volume ratio

+
+

Parameters

+
+
ffloat

Total volume of building [m3]

+
+
+
+
+ +
+
+setApplianceData(a: float)
+

Sets appliance data for building, in order: appliance power rating [W], +total number of appliances, appliance usage factor +Parameters +———- +a : float

+
+

Appliance data for building, in order: appliance power rating [W], +total number of appliances, appliance usage factor

+
+
+ +
+
+setConvectionCoefficients(hi=None, ho=None)
+

Sets convective heat transfer coefficients of building [W m-1 K-1]

+
+

Parameters

+
+
hilist

Internal convective heat transfer coefficients, indoor: wall and +roof, internal mass, floor, windows [W m-2 K-1]

+
+
holist

External convection coefficients, in order: wall and roof, +window [W m-2 K-1]

+
+
+
+
+ +
+
+setCoolingSystem(c: float)
+

Sets building cooling system maximum cooling power [W] +Parameters +———- +c : float

+
+

Maximum cooling power demand [W]

+
+
+ +
+
+setDHWDrainageVolumeFlowRate(V: float)
+

Sets hot water drainage flow rate [m3 s-1] +Parameters +———- +V : float

+
+

Hot water drainage flow rate [m3 s-1]

+
+
+ +
+
+setDHWHeatingSetpoint(Ts: float)
+

Sets hot water heating setpoint temperature [K]

+
+

Parameters

+
+
Tsfloat

Hot water heating setpoint temperature [K]

+
+
+
+
+ +
+
+setDHWUsageVolume(V: float)
+

Set volume of hot water in use volume [m3] +Parameters +———- +V : float

+
+

Volume of hot water in use [m3]

+
+
+ +
+
+setDHWUsageVolumeFlowRate(V: float)
+

Sets hot water usage flow rate [m3 s-1] +Parameters +———- +V : float

+
+

Hot water usage flow rate [m3 s-1]

+
+
+ +
+
+setDepth(d: float)
+

Sets depth (y-axis) of building [m]

+
+

Parameters

+
+
dfloat

Depth of building [m]

+
+
+
+
+ +
+
+setEffectiveConductivity(k: list)
+

Sets effective conductivity of building components, in order: wall +and roof, ground floor, windows, external ground [W m-1 K-1] +Parameters +———- +k : list

+
+

Effective conductivities, in order: wall and roof, ground floor, +windows, external ground [W m-1 K-1]

+
+
+ +
+
+setEmissivity(e: list)
+

Sets emissivities of building components, in order: external wall and +roof, internal wall and roof, internal mass, external windows, internal +windows

+
+

Parameters

+
+
elist

Emissivities of building components, in order: external wall and +roof, internal wall and roof, internal mass, external windows, +internal windows

+
+
+
+
+ +
+
+setFloorArea()
+

Sets building floor plan area [m2]

+
+ +
+
+setFloorThickness(t: float)
+

Sets building ground floor thickness [m]

+
+

Parameters

+
+
tfloat

Thickness of ground floor [m]

+
+
+
+
+ +
+
+setFloorVolume()
+

Sets building ground floor volume [m3]

+
+ +
+
+setGVFactor(s)
+

Sets sky view factor from ground and buildings

+
+

Parameters

+
+
sfloat

Sky view factor from ground and buildings

+
+
+
+
+ +
+
+setHTsAverage(c: list)
+

Sets the heating set points from current and two previous time steps +(in order) [K]

+

Value only retrieved to calculate for next, not directly used in +calculations.

+
+

Parameters

+
+
clist

Heating set points from current and two previous time steps +(in order) [K]

+
+
+
+
+ +
+
+setHWTMaxPower(no_holds: float)
+

Sets the maximum heating power for the hot water tank [W]

+
+

Parameters

+
+
no_holdsfloat

Number of households in the buliding

+
+
+
+
+ +
+
+setHWTPower(p)
+

Sets current hot water tank power demand [W] +Parameters +———- +p : float

+
+

Current hot water tank power demand [W]

+
+
+ +
+
+setHWTPowerAverage(c: ndarray)
+

Sets the hot water set points from current and two previous time steps +(in order) [K] +Parameters +———- +c : np.ndarray

+
+

Hot water set points from current and two previous time steps [K]

+
+
+ +
+
+setHWTdims(volumes: ndarray)
+

Sets the dimensions of the hot water tank (volume, surface area, +volume of hot water tank walls, minimum and maximum volumes of hot +water vessel.

+
+

Parameters

+
+
volumesnp.ndarray

Volumes of hot water tanks for household groups [m3]

+
+
+
+
+ +
+
+setHWTsAverage(c: list)
+

Sets the hot water set points from current and two previous time steps +(in order) [K]

+

Value only retrieved to calculate for next, not directly used in +calculations.

+
+

Parameters

+
+
clist

Hot water set points from current and two previous time steps +(in order) [K]

+
+
+
+
+ +
+
+setHWflowrate(from_tank: float, from_vessel: float)
+

Sets flow rates from the hot water tank and from the hot water vessel +[m3 s-1]

+
+

Parameters

+
+
from_tankfloat

Flow rate from the hot water tank to the hot water vessel [m3 s-1]

+
+
from_vesselfloat

Flow rate from the hot water vessel to the drain [m3 s-1]

+
+
+
+
+ +
+
+setHeatingCoolingSetpoint(Th: float, Tc: float)
+

Sets heating and cooling set point temperatures [K]

+
+

Parameters

+
+
Thfloat

Heating set point temperature [K}

+
+
Tcfloat

Cooling set point temperature [K]

+
+
+
+
+ +
+
+setHeatingSystem(h: list)
+

Sets heating system parameters for building, in order: maximum power +[W], system efficiency +Parameters +———- +h : list

+
+

Heating system parameters for building, in order: maximum power +[W], system efficiency

+
+
+ +
+
+setHeight(h: float)
+

Sets height_building (z-axis) of building [m]

+
+

Parameters

+
+
hfloat

Height of building [m]

+
+
+
+
+ +
+
+setInternalMassArea(a: float)
+

Sets internal mass surface area in building [m3] +Parameters +———- +a : float

+
+

Internal mass surface area

+
+
+ +
+
+setLSR(l: float)
+

Sets the latent to sensible heat ratio of occupants +Parameters +———- +l : float

+
+

Latent to sensible heat ratio of occupant metabolism

+
+
+ +
+
+setMaxHeatingPower(h: float)
+

Sets building heating system maximum heating power [W] +Parameters +———- +h : float

+
+

Maximum heating power demand [W]

+
+
+ +
+
+setMetabolicRate(m: float)
+

Sets the metabolic rate of building occupants [W} +Parameters +———- +m : float

+
+

Metabolic rate of building occupants [W]

+
+
+ +
+
+setOccupancyNumber(o: int)
+

Sets the number of occupants in the building +Parameters +———- +o : int

+
+

Number of occupants in the building

+
+
+ +
+
+setOccupantData(o: list)
+

Sets occupant data for building, in order: number occupants, metabolic +rate [W], latent to sensible heat ratio +Parameters +———- +o : list

+
+

Occupant data for building, in order: number occupants [W], +metabolic rate, latent to sensible heat ratio

+
+
+ +
+
+setSHC(c: list)
+

Sets specific heat capacities of buliding components, in order: wall +and roof, ground floor, windows, internal mass, indoor air [J K-1 kg-1]

+
+

Parameters

+
+
c: list

Specific heat capacities of buliding components, in order: wall and +roof, ground floor, windows, internal mass, indoor air [J K-1 kg-1]

+
+
+
+
+ +
+
+setSVFactor(s)
+

Sets sky view factor from ground and buildings

+
+

Parameters

+
+
sfloat

Sky view factor from ground and buildings

+
+
+
+
+ +
+
+setVentilationRate(VR: float)
+

Sets ventilation rate [m3 s-1] +Parameters +———- +VR : float

+
+

Ventilation rate [m3 s-1]

+
+
+ +
+
+setViewFactors()
+

Resets view factors

+
+ +
+
+setWTsetpoint(s: float)
+

Sets hot water setpoint [K]

+
+

Parameters

+
+
sfloat

Hot water set point [K]

+
+
+
+
+ +
+
+setWWR(wwr: float)
+

Sets building window to wall ratio +Parameters +———- +wwr : float

+
+

Window to wall ratio

+
+
+ +
+
+setWallArea()
+

Sets wall area of building [m2]

+
+ +
+
+setWallTAR(t: list)
+

Sets (in order) transmissivity, absorbtivity and reflectivity of +building walls

+
+

Parameters

+
+
tlist

Transmissivity, absorbtivity and reflectivity of building walls

+
+
+
+
+ +
+
+setWallThickness(t: float)
+

Sets thickeness of building walls [m] +Parameters +———- +t : float

+
+

Building wall thickness [m]

+
+
+ +
+
+setWallVolume()
+

Sets wall volume of building [m3]

+
+ +
+
+setWidth(w: float)
+

Set width (x-axis) of building [m] +Parameters +———- +w : float

+
+

Width of building [m]

+
+
+ +
+
+setWindowArea()
+

Sets total window area of building [m2]

+
+ +
+
+setWindowTAR(t: list)
+

Sets (in order) transmissivity, absorbtivity and reflectivity of +building windows

+
+

Parameters

+
+
tlist

Transmissivity, absorbtivity and reflectivity of building +windows

+
+
+
+
+ +
+
+setWindowThickness(t: float)
+

Set thickness of windows in building [m] +Parameters +———- +t : float

+
+

Thickness of windows in buliding [m]

+
+
+ +
+
+setWindowVolume()
+

Sets building window volume [m3]

+
+ +
+
+setdensity(r: list)
+

Sets the density of building components, in order: wall and roof, +ground floor, windows, internal mass and indoor air [kg m-3] +Parameters +———- +r : list

+
+

Densities, in order: wall and roof, ground floor, windows, internal +mass and indoor air [kg m-3]

+
+
+ +
+
+timeStepCalculation_c(Tair_out, Tground_deep, Tsurf, Tsky, density_air_out, cp_air_out, Qsw_dn_extroof, Qsw_dn_extwall, Qlw_dn_extwall, Qlw_dn_extroof, timestep, resolution)
+

Simulates energy exchanges between all building component, using +environmental and behavioural inputs, giving QF,B as output

+

Wrapper for STEBBS C code

+
+

Parameters

+
+
Tair_outfloat

Outdoor air temperature [K]

+
+
Tground_deepfloat

Deep ground temperature [K]

+
+
Tsurffloat

Surface temperature [K]

+
+
Tskyfloat

Effective sky temperature [K]

+
+
density_air_outfloat

Density of outdoor air [kg m-3]

+
+
cp_air_outfloat

Specific heat capacity of outdoor air [J K-1 kg-1]

+
+
Qsw_dn_extrooffloat

Solar irradiance [W m-2] on horizontal surfaces (e.g. roof)

+
+
Qsw_dn_extwallfloat

Solar irradiance [W m-2] on vertical surfaces (e.g. wall, windows)

+
+
timestepint

Time step

+
+
resolutionint

Resolution of time step [s]

+
+
+
+
+

Returns

+
+
+ +
+
+ventilationHeatTransfer(rho, Cp, V, To, Ti)
+

Building ventilation rate heat transfer (i.e. not recirculated air) [W]

+

Return the heat flux resulting in the building (that outside the +building is just the inverse sign of this value - energy balance) +Parameters +———- +rho : float

+
+

Air density [kg m-3]

+
+
+
Cpfloat

Specific heat capacity of air at constant pressure [ J K-1 kg-1]

+
+
Vfloat

Volumetric flow rate [m3 s-1]

+
+
Tofloat

Outdoor temperature [K]

+
+
Tifloat

Indoor temperature [K]

+
+
+
+

Returns

+
+
float

q_in: Building ventilation rate heat transfer

+
+
+
+
+ +
+
+wallConduction(k_eff, A, Twi, Two, L)
+

Conduction through component, assuming 1D conduction +(can be floor/roof/wall/window) [W] +Parameters +———- +k_eff : float

+
+

Effective conductivity of lumped component [W m-1 K-1]

+
+
+
Afloat

Total surface area of component [m2]

+
+
Twifloat

Indoor component surface temperature [K]

+
+
Twofloat

Outdoor component surface temperature [K]

+
+
Lfloat

Thickness of component [m]

+
+
+
+

Returns

+
+
float

wall_con: Conduction though component [W]

+
+
+
+
+ +
+
+wallInsolation(Irr, Ab, A)
+

Solar insolation through wall surface [W m-2] +Parameters +———- +Irr : float

+
+

Irradiance incident on window [W m-2]

+
+
+
Abfloat

Effective absorptance of surface

+
+
A: float

Area [m2]

+
+
+
+

Returns

+
+
float

wa_in: Solar insolation through wall surface [W]

+
+
+

#Modified by Yiqing Liu +1) wa_in has considered the area of wall, the unit become Watt to match the surface energy balance +2)irr could be iether horizontal Kdown or vertical Qsw_dn_extwall from BEERs model

+
+
+ +
+
+windowConduction(k_eff, A, Twi, Two, L)
+

Conduction through component, assuming 1D conduction +(can be floor/roof/wall/window) [W] +Parameters +———- +k_eff : float

+
+

Effective conductivity of lumped component [W m-1 K-1]

+
+
+
Afloat

Total surface area of component [m2]

+
+
Twifloat

Indoor component surface temperature [K]

+
+
Twofloat

Outdoor component surface temperature [K]

+
+
Lfloat

Thickness of component [m]

+
+
+
+

Returns

+
+
float

win_con: Conduction though component [W]

+
+
+
+
+ +
+
+windowInsolation(Irr, Tr, A)
+

Solar insolation through window component [W m-2]

+
+

Parameters

+
+
Irrfloat

Irradiance incident on window [W m-2]

+
+
Trfloat

Effective transmissivity

+
+
A: float

Area [m2]

+
+
+
+
+

Returns

+
+
float

wi: Solar insolation on window component [W]

+
+
+

#Modified by Yiqing Liu +1)wi_in has considered the area of windows, the unit become Watt to match the surface energy balance equation +2) irr could be iether horizontal Kdown or vertical Qsw_dn_extwall from BEERs model

+
+
+ +
+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/SolveGraph.html b/docs/build/html/SolveGraph.html new file mode 100644 index 0000000..1239d4c --- /dev/null +++ b/docs/build/html/SolveGraph.html @@ -0,0 +1,119 @@ + + + + + + + + SolveGraph module — DAVE documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

SolveGraph module

+
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/build/html/_sources/Citizen.rst.txt b/docs/build/html/_sources/Citizen.rst.txt new file mode 100644 index 0000000..828e31b --- /dev/null +++ b/docs/build/html/_sources/Citizen.rst.txt @@ -0,0 +1,7 @@ +Citizen module +============== + +.. automodule:: Citizen + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/EnergyCalc.rst.txt b/docs/build/html/_sources/EnergyCalc.rst.txt new file mode 100644 index 0000000..2eb2f4b --- /dev/null +++ b/docs/build/html/_sources/EnergyCalc.rst.txt @@ -0,0 +1,7 @@ +EnergyCalc module +================= + +.. automodule:: EnergyCalc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/Initialise.rst.txt b/docs/build/html/_sources/Initialise.rst.txt new file mode 100644 index 0000000..b52a753 --- /dev/null +++ b/docs/build/html/_sources/Initialise.rst.txt @@ -0,0 +1,7 @@ +Initialise module +================= + +.. automodule:: Initialise + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/Initialise_nhoods.rst.txt b/docs/build/html/_sources/Initialise_nhoods.rst.txt new file mode 100644 index 0000000..a64be29 --- /dev/null +++ b/docs/build/html/_sources/Initialise_nhoods.rst.txt @@ -0,0 +1,7 @@ +Initialise\_nhoods module +========================= + +.. automodule:: Initialise_nhoods + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/Main_run.rst.txt b/docs/build/html/_sources/Main_run.rst.txt new file mode 100644 index 0000000..06c629a --- /dev/null +++ b/docs/build/html/_sources/Main_run.rst.txt @@ -0,0 +1,7 @@ +Main\_run module +================ + +.. automodule:: Main_run + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/Movement.rst.txt b/docs/build/html/_sources/Movement.rst.txt new file mode 100644 index 0000000..92c3d80 --- /dev/null +++ b/docs/build/html/_sources/Movement.rst.txt @@ -0,0 +1,7 @@ +Movement module +=============== + +.. automodule:: Movement + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/Nhood.rst.txt b/docs/build/html/_sources/Nhood.rst.txt new file mode 100644 index 0000000..0307323 --- /dev/null +++ b/docs/build/html/_sources/Nhood.rst.txt @@ -0,0 +1,7 @@ +Nhood module +============ + +.. automodule:: Nhood + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/Profile.rst.txt b/docs/build/html/_sources/Profile.rst.txt new file mode 100644 index 0000000..1d493bf --- /dev/null +++ b/docs/build/html/_sources/Profile.rst.txt @@ -0,0 +1,7 @@ +Profile module +============== + +.. automodule:: Profile + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/STEBBS.rst.txt b/docs/build/html/_sources/STEBBS.rst.txt new file mode 100644 index 0000000..db1ea87 --- /dev/null +++ b/docs/build/html/_sources/STEBBS.rst.txt @@ -0,0 +1,7 @@ +STEBBS module +============= + +.. automodule:: STEBBS + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/SolveGraph.rst.txt b/docs/build/html/_sources/SolveGraph.rst.txt new file mode 100644 index 0000000..d999565 --- /dev/null +++ b/docs/build/html/_sources/SolveGraph.rst.txt @@ -0,0 +1,7 @@ +SolveGraph module +================= + +.. automodule:: SolveGraph + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt new file mode 100644 index 0000000..d3a3d9d --- /dev/null +++ b/docs/build/html/_sources/index.rst.txt @@ -0,0 +1,26 @@ +.. DAVE documentation master file, created by + sphinx-quickstart on Tue Nov 7 22:01:50 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +BIG DAVE +================================ +.. toctree:: + :maxdepth: 4 + + Citizen + EnergyCalc + Initialise + Initialise_nhoods + Main_run + Movement + Nhood + Profile + STEBBS + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/build/html/_sources/load_solved_graphs.rst.txt b/docs/build/html/_sources/load_solved_graphs.rst.txt new file mode 100644 index 0000000..308559f --- /dev/null +++ b/docs/build/html/_sources/load_solved_graphs.rst.txt @@ -0,0 +1,7 @@ +load\_solved\_graphs module +=========================== + +.. automodule:: load_solved_graphs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/modules.rst.txt b/docs/build/html/_sources/modules.rst.txt new file mode 100644 index 0000000..2624ec9 --- /dev/null +++ b/docs/build/html/_sources/modules.rst.txt @@ -0,0 +1,15 @@ +DAVE-03 +======= + +.. toctree:: + :maxdepth: 4 + + Citizen + EnergyCalc + Initialise + Initialise_nhoods + Main_run + Movement + Nhood + Profile + STEBBS diff --git a/docs/build/html/_sources/multi_processing.rst.txt b/docs/build/html/_sources/multi_processing.rst.txt new file mode 100644 index 0000000..0cf728f --- /dev/null +++ b/docs/build/html/_sources/multi_processing.rst.txt @@ -0,0 +1,7 @@ +multi\_processing module +======================== + +.. automodule:: multi_processing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/plotting.rst.txt b/docs/build/html/_sources/plotting.rst.txt new file mode 100644 index 0000000..16b6fbb --- /dev/null +++ b/docs/build/html/_sources/plotting.rst.txt @@ -0,0 +1,7 @@ +plotting module +=============== + +.. automodule:: plotting + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_sources/serialize_travel_graphs.rst.txt b/docs/build/html/_sources/serialize_travel_graphs.rst.txt new file mode 100644 index 0000000..98c733b --- /dev/null +++ b/docs/build/html/_sources/serialize_travel_graphs.rst.txt @@ -0,0 +1,7 @@ +serialize\_travel\_graphs module +================================ + +.. automodule:: serialize_travel_graphs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js b/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8141580 --- /dev/null +++ b/docs/build/html/_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/docs/build/html/_static/alabaster.css b/docs/build/html/_static/alabaster.css new file mode 100644 index 0000000..517d0b2 --- /dev/null +++ b/docs/build/html/_static/alabaster.css @@ -0,0 +1,703 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Make nested-list/multi-paragraph items look better in Releases changelog + * pages. Without this, docutils' magical list fuckery causes inconsistent + * formatting between different release sub-lists. + */ +div#changelog > div.section > ul > li > p:only-child { + margin-bottom: 0; +} + +/* Hide fugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css new file mode 100644 index 0000000..30fee9d --- /dev/null +++ b/docs/build/html/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 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/docs/build/html/_static/css/badge_only.css b/docs/build/html/_static/css/badge_only.css new file mode 100644 index 0000000..c718cee --- /dev/null +++ b/docs/build/html/_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/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/build/html/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/build/html/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/docs/build/html/_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/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff b/docs/build/html/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold-italic.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff b/docs/build/html/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff2 b/docs/build/html/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff b/docs/build/html/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal-italic.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff b/docs/build/html/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff2 b/docs/build/html/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal.woff2 differ diff --git a/docs/build/html/_static/css/theme.css b/docs/build/html/_static/css/theme.css new file mode 100644 index 0000000..19a446a --- /dev/null +++ b/docs/build/html/_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/docs/build/html/_static/custom.css b/docs/build/html/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/docs/build/html/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/docs/build/html/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 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/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js new file mode 100644 index 0000000..7e4c114 --- /dev/null +++ b/docs/build/html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + 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/docs/build/html/_static/file.png b/docs/build/html/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/docs/build/html/_static/file.png differ diff --git a/docs/build/html/_static/jquery.js b/docs/build/html/_static/jquery.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/docs/build/html/_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/docs/build/html/_static/js/html5shiv.min.js b/docs/build/html/_static/js/html5shiv.min.js new file mode 100644 index 0000000..cd1c674 --- /dev/null +++ b/docs/build/html/_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/docs/build/html/_static/js/theme.js b/docs/build/html/_static/js/theme.js new file mode 100644 index 0000000..1fddb6e --- /dev/null +++ b/docs/build/html/_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/docs/build/html/_static/minus.png b/docs/build/html/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/docs/build/html/_static/minus.png differ diff --git a/docs/build/html/_static/plus.png b/docs/build/html/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/docs/build/html/_static/plus.png differ diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css new file mode 100644 index 0000000..6fb2eb0 --- /dev/null +++ b/docs/build/html/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height_building: 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/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js new file mode 100644 index 0000000..7918c3f --- /dev/null +++ b/docs/build/html/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 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) + ); + // 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.` + ); +}; +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); +}; + +/** + * 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) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you 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); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + 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; + + // 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]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + 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] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((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; + }); + + // 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; + }, []); + + results = results.reverse(); + + // 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); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], 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.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [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) => { + const text = Search.htmlToText(htmlText); + 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/docs/build/html/_static/sphinx_highlight.js b/docs/build/html/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/docs/build/html/_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( + '" + ) + ); + }, + + /** + * 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/docs/build/html/genindex.html b/docs/build/html/genindex.html new file mode 100644 index 0000000..111d125 --- /dev/null +++ b/docs/build/html/genindex.html @@ -0,0 +1,880 @@ + + + + + + Index — DAVE documentation + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | F + | G + | H + | I + | J + | K + | L + | M + | N + | O + | P + | Q + | R + | S + | T + | U + | V + | W + | Z + +
+

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
    +
  • + EnergyCalc + +
  • +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

J

+ + +
+ +

K

+ + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

Q

+ + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + +
+ +

V

+ + +
+ +

W

+ + + +
+ +

Z

+ + +
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html new file mode 100644 index 0000000..e8520f4 --- /dev/null +++ b/docs/build/html/index.html @@ -0,0 +1,403 @@ + + + + + + + BIG DAVE — DAVE documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

BIG DAVE

+
+ +
+
+
+

Indices and tables

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/load_solved_graphs.html b/docs/build/html/load_solved_graphs.html new file mode 100644 index 0000000..af8e336 --- /dev/null +++ b/docs/build/html/load_solved_graphs.html @@ -0,0 +1,286 @@ + + + + + + + + load_solved_graphs module — DAVE documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

load_solved_graphs module

+
+
+class load_solved_graphs.Grid(name: str, journeys: list[load_solved_graphs.Journey], stations: list[str])
+

Bases: object

+
+
+classmethod from_dict(d)
+
+ +
+
+journeys: list[Journey]
+
+ +
+
+name: str
+
+ +
+
+stations: list[str]
+
+ +
+ +
+
+class load_solved_graphs.Journey(destination: int, time: int, mode: Profile.Subarea)
+

Bases: object

+
+
+destination: int
+
+ +
+
+classmethod from_dict(d)
+
+ +
+
+mode: Subarea
+
+ +
+
+time: int
+
+ +
+ +
+
+class load_solved_graphs.SolvedGraph(grids: dict[int, load_solved_graphs.SolvedGraphGrid])
+

Bases: object

+
+
+find_route(start, end)
+
+ +
+
+classmethod from_dict(d)
+
+ +
+
+grids: dict[int, SolvedGraphGrid]
+
+ +
+ +
+
+class load_solved_graphs.SolvedGraphGrid(grid: int, nodes: dict[int, load_solved_graphs.SolvedGraphNode])
+

Bases: object

+
+
+find_route(end)
+
+ +
+
+classmethod from_dict(start_grid, d)
+
+ +
+
+grid: int
+
+ +
+
+nodes: dict[int, SolvedGraphNode]
+
+ +
+ +
+
+class load_solved_graphs.SolvedGraphNode(previous: int, journey: load_solved_graphs.Journey, time: float, valid: bool)
+

Bases: object

+
+
+classmethod from_dict(d)
+
+ +
+
+journey: Journey
+
+ +
+
+previous: int
+
+ +
+
+time: float
+
+ +
+
+valid: bool
+
+ +
+ +
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html new file mode 100644 index 0000000..1ba6f08 --- /dev/null +++ b/docs/build/html/modules.html @@ -0,0 +1,392 @@ + + + + + + + DAVE-03 — DAVE documentation + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

DAVE-03

+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/multi_processing.html b/docs/build/html/multi_processing.html new file mode 100644 index 0000000..8573fce --- /dev/null +++ b/docs/build/html/multi_processing.html @@ -0,0 +1,160 @@ + + + + + + + + multi_processing module — DAVE documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

multi_processing module

+
+
+class multi_processing.Process(queue)
+

Bases: Process

+

A single multiprocessing process

+
+
+calculate(params)
+
+ +
+
+run()
+

Method to be run in sub-process; can be overridden in sub-class

+
+ +
+ +
+
+class multi_processing.Stop
+

Bases: object

+
+ +
+
+multi_processing.calculate(queue, PROCESSES=32)
+

Calculate the Mie spectra for all permuations of the parameters, +using a multiprocessing pool of (by default) 32 processes.

+

PROCESSES=25: int, number of processes to spawn

+
+ +
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv new file mode 100644 index 0000000..997b95b Binary files /dev/null and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/plotting.html b/docs/build/html/plotting.html new file mode 100644 index 0000000..cb54e6b --- /dev/null +++ b/docs/build/html/plotting.html @@ -0,0 +1,129 @@ + + + + + + + + plotting module — DAVE documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

plotting module

+

Plotting functions.

+

Megan McGrory - 2023

+
+
+plotting.plot_subareas_heatmap(ts_sa)
+
+ +
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html new file mode 100644 index 0000000..24822f7 --- /dev/null +++ b/docs/build/html/py-modindex.html @@ -0,0 +1,194 @@ + + + + + + Python Module Index — DAVE documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ c | + e | + i | + m | + n | + p | + s +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ c
+ Citizen +
 
+ e
+ EnergyCalc +
 
+ i
+ Initialise +
+ Initialise_nhoods +
 
+ m
+ Main_run +
+ Movement +
 
+ n
+ Nhood +
 
+ p
+ Profile +
 
+ s
+ STEBBS +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html new file mode 100644 index 0000000..5cdd051 --- /dev/null +++ b/docs/build/html/search.html @@ -0,0 +1,127 @@ + + + + + + Search — DAVE documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js new file mode 100644 index 0000000..20f08bc --- /dev/null +++ b/docs/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["Citizen", "EnergyCalc", "Initialise", "Initialise_nhoods", "Main_run", "Movement", "Nhood", "Profile", "STEBBS", "index", "modules"], "filenames": ["Citizen.rst", "EnergyCalc.rst", "Initialise.rst", "Initialise_nhoods.rst", "Main_run.rst", "Movement.rst", "Nhood.rst", "Profile.rst", "STEBBS.rst", "index.rst", "modules.rst"], "titles": ["Citizen module", "EnergyCalc module", "Initialise module", "Initialise_nhoods module", "Main_run module", "Movement module", "Nhood module", "Profile module", "STEBBS module", "BIG DAVE", "DAVE-03"], "terms": {"index": 9, "modul": [9, 10], "search": 9, "page": 9, "citizen": [2, 3, 5, 9, 10], "energycalc": [9, 10], "initialis": [0, 3, 9, 10], "initialise_nhood": [9, 10], "main_run": [9, 10], "movement": [0, 9, 10], "nhood": [0, 1, 2, 3, 5, 9, 10], "profil": [0, 2, 9, 10], "stebb": [9, 10], "solvegraph": [], "load_solved_graph": [], "multi_process": [], "plot": [], "serialize_travel_graph": [], "qf_simpl": [1, 9, 10], "t2": 1, "heat": [1, 8, 9, 10], "cool": [1, 8, 9, 10], "emiss": [1, 8], "residenti": 1, "level": 1, "either": 1, "np": [1, 8], "ndarrai": [1, 8], "indoor": [1, 7, 8, 9, 10], "temperatur": [1, 8], "qf_re": 1, "due": [1, 8], "alter_dom_set_point": [1, 9, 10], "use_factor": 1, "heat_min": 1, "float": [1, 6, 7, 8], "heat_max": 1, "av_sp_t3": 1, "provid": 1, "new": [0, 1, 8], "set": [1, 8], "point": [1, 8], "domest": [1, 6, 8], "build": [0, 1, 6, 8, 9, 10], "base": [0, 1, 2, 5, 6, 7, 8], "activ": [0, 1], "occup": [1, 8], "arrai": 1, "three": 1, "one": [0, 1], "two": [1, 8], "previou": [1, 8], "time": [0, 1, 2, 8], "step": [0, 1, 8], "can": [1, 8], "averag": 1, "smoothli": 1, "reset": [1, 8], "ratio": [1, 8], "total": [0, 1, 8], "popul": [0, 1], "minimum": [1, 8], "maximum": [1, 8], "current": [0, 1, 8], "past": 1, "alter_heating_hdd": [1, 9, 10], "hdd": 1, "tupl": 1, "bool": [0, 1, 7, 8], "truth": 1, "valu": [0, 1, 6, 7, 8], "breach": 1, "threshold": 1, "first": 1, "look": 1, "monthli": 1, "second": [1, 8], "5": [1, 6, 7, 8], "dai": 1, "roll": 1, "If": [0, 1], "i": [0, 1, 8], "lower": 1, "than": 1, "both": 1, "true": 1, "mean": 1, "night": 1, "ar": [1, 8], "us": [0, 1, 5, 8], "name": [1, 2, 6, 9, 10], "ext_conv_coeff": [1, 9, 10], "wind_spe": 1, "calcul": [1, 8], "extern": [1, 8], "convect": [1, 8], "coeffici": [1, 8], "eq": 1, "11": [1, 6, 7], "cole": 1, "sturrock": 1, "1977": 1, "wind": 1, "speed": 1, "m": [1, 8], "": [1, 6, 7, 8], "1": [0, 1, 6, 7, 8], "hc": 1, "feed_dom_energi": [1, 9, 10], "t": [0, 1, 5, 7, 8, 9, 10], "int": [0, 1, 5, 6, 7, 8], "object": [0, 1, 2, 3, 5, 6, 7, 8], "tair": 1, "tsurf": [1, 8], "irradi": [1, 8], "tground": 1, "windspe": 1, "kwall": 1, "tsky": [1, 8], "ldown": 1, "lwall": 1, "feed": 1, "applianc": [0, 1, 8], "power": [1, 8], "demand": [1, 8], "environment": [1, 8], "variabl": 1, "bem": 1, "prompt": 1, "simul": [1, 8], "qf": [1, 8], "outdoor": [1, 7, 8, 9, 10], "environ": 1, "air": [1, 8], "c": [1, 8], "surfac": [1, 8], "w": [1, 8], "2": [1, 6, 7, 8], "deep": [1, 8], "soil": 1, "qfb_dom_air": 1, "sensibl": [1, 8], "energi": [0, 1, 8], "output": [1, 8], "from": [0, 1, 2, 5, 6, 8], "each": [0, 1, 8], "an": [1, 6, 7, 8], "qfb_dom_gr": 1, "ground": [1, 8], "qfm_dom": 1, "metabol": [0, 1, 8], "sourc": 1, "qheat_dom": 1, "qcool_dom": 1, "avindtemp": 1, "k": [1, 8], "qfb_dom_fabr": 1, "fabric": [1, 8], "qhw_dom": 1, "water": [0, 1, 8], "floor_plan": [1, 9, 10], "height": [1, 8], "footprint": 1, "floor": [1, 8], "plan": [1, 8], "area": [1, 8], "forcing_suew": [1, 9, 10], "forcing_dai": 1, "coupled_forc": 1, "fals": [0, 1, 7], "relev": 1, "meteorolog": 1, "featur": 1, "list": [0, 1, 6, 7, 8], "start": [1, 5], "end": [1, 5], "date": 1, "d": [1, 8], "y": [1, 8], "run": 1, "figur": 1, "suew": 1, "avail": 1, "2012": 1, "onli": [1, 8], "so": 1, "inquir": 1, "neighbourhood": [1, 6], "qf_ext": 1, "pd": 1, "core": 1, "seri": 1, "simpl": 1, "estim": 1, "initi": [1, 8], "dict_forc": 1, "dict": [1, 2, 6], "timestep": [0, 1, 8], "kei": [0, 1, 7, 9, 10], "dict_stat": 1, "spatial": 1, "grid": [0, 1, 2, 5, 9, 10], "state": [0, 1, 7, 9, 10], "tstamp": 1, "timestamp": 1, "format": 1, "qft": [], "vehicle_count": [], "distanc": [], "mode": [0, 2, 5], "given": [0, 5, 8], "run_suews_t": [1, 9, 10], "env": 1, "day_count": 1, "compon": [1, 8], "inidividu": 1, "forcing_tstamp": 1, "The": 1, "which": [1, 5, 8], "progress": 1, "count": 1, "being": [1, 8], "spin": 1, "up": 1, "ha": [0, 1, 8], "normal": 1, "0": [0, 1, 7, 8], "ten": 1, "minut": 1, "slot": 1, "4": [1, 6, 7, 8], "am": 1, "includ": 1, "rang": [0, 1], "144": 1, "e": [1, 8], "g": [1, 8], "correspond": [1, 8], "00": 1, "10": [1, 6, 7], "20": [1, 7], "str": [0, 1, 6, 7, 8], "h": [1, 8], "case_qf": 1, "kdn": 1, "total_qft": [], "function": [2, 3], "megan": [2, 3], "mcgrori": [2, 3], "feb": [2, 3], "2023": [2, 3], "class": [0, 2, 5, 6, 7, 8], "journei": [0, 2, 9, 10], "station": 2, "destin": 2, "assign_all_school_work_plac": [2, 9, 10], "all_citizen": [0, 2, 3], "all_nhood": 2, "assign_school_work_plac": [2, 9, 10], "assign": [2, 8], "school": [0, 2, 6, 9, 10], "work": [0, 2, 7, 9, 10], "depend": 2, "ag": [0, 2, 7, 9, 10], "group": [0, 2, 8], "create_all_citizen": [2, 9, 10], "creat": [0, 2, 3, 6], "dictionari": [0, 2, 3], "classifi": 2, "create_all_profil": [2, 9, 10], "all_energy_profil": 2, "input": [0, 2, 8], "file": [2, 5, 6, 8], "assign_household": [3, 9, 10], "create_all_nhood": [3, 9, 10], "all": [0, 3, 8], "order_fil": [3, 9, 10], "filenam": [3, 5], "reorder": 3, "match": [3, 8], "nhood_list": 3, "movementcontrol": 5, "py": 5, "thi": [0, 5, 8], "contain": [0, 5, 8], "store": [5, 8], "rule": 5, "travel_from": 5, "travel_to": 5, "exchang": [5, 8], "between": [5, 8], "subarea": [0, 5, 6, 7, 9, 10], "choose_mod": [5, 9, 10], "start_cap": 5, "end_cap": 5, "choos": 5, "travel": [0, 5], "remov": 5, "capac": [5, 8], "zero": [5, 6, 9, 10], "find_rout": [5, 9, 10], "graph_index": 5, "get_capac": [5, 9, 10], "get": [5, 8], "get_mode_us": [5, 9, 10], "current_grid": [0, 5, 9, 10], "return": 5, "number": [0, 5, 8], "peopl": [0, 5, 8], "grids_in_t": [5, 9, 10], "leg_times_cumsum": 5, "grids_travelled_through": [5, 9, 10], "tss": 5, "next": [0, 5, 7, 8, 9, 10], "move": [0, 5], "along": 5, "rout": [0, 5], "load_saved_graph": [5, 9, 10], "buildingarchetyp": [6, 9, 10], "lbm": [6, 8, 9, 10], "household": [0, 6, 8, 9, 10], "hold": [0, 6, 8], "attribut": 6, "archetyp": [0, 6, 8, 9, 10], "household_s": [0, 6, 7, 9, 10], "work_pop": [6, 9, 10], "shop_pop": [6, 9, 10], "primary_pop": [6, 9, 10], "secondary_pop": [6, 9, 10], "nhood_area": [6, 9, 10], "sso_area": [6, 9, 10], "sso": [6, 9, 10], "industrial_modifi": [6, 9, 10], "gravity_weight": [6, 9, 10], "subarea_pop": [6, 9, 10], "domestic_build": [6, 9, 10], "commercial_build": [6, 9, 10], "data": [6, 8], "its": 6, "workplac": 6, "primari": 6, "secondari": 6, "shop": 6, "other": [0, 6], "classmethod": [0, 6, 7], "from_grid_fil": [6, 9, 10], "grid_fil": 6, "reset_subarea_popul": [6, 9, 10], "select_grid_for_subarea": [6, 9, 10], "enum": [6, 7], "enumer": [6, 7], "cultur": [6, 7, 9, 10], "highent": [6, 9, 10], "highst": [6, 9, 10], "3": [6, 7, 8], "hospit": [6, 7, 9, 10], "lowshop": [6, 9, 10], "othermid": [6, 9, 10], "6": [6, 7], "restaur": [6, 9, 10], "7": [6, 7], "8": [6, 7], "supermarket": [6, 9, 10], "9": [6, 7], "univers": [6, 7, 9, 10], "from_str": [6, 7, 9, 10], "adult": [0, 7, 9, 10], "child": [0, 7, 9, 10], "infant": [0, 7, 9, 10], "senior": [0, 7, 9, 10], "teenag": [7, 9, 10], "daytyp": [0, 7, 9, 10], "weekdai": [7, 9, 10], "weekend": [0, 7, 9, 10], "day_typ": [7, 9, 10], "initial_subarea": [7, 9, 10], "final_subarea": [7, 9, 10], "initial_st": [7, 9, 10], "final_st": [7, 9, 10], "appliance_energi": [7, 9, 10], "metabolic_energi": [7, 9, 10], "light_us": [7, 9, 10], "water_us": [7, 9, 10], "room": [0, 7, 9, 10], "finish": [7, 9, 10], "from_row": [0, 7, 9, 10], "row": [0, 7], "asleep": [0, 7, 9, 10], "awak": [0, 7, 9, 10], "bu": [7, 9, 10], "16": 7, "cycl": [7, 9, 10], "19": 7, "drive": [7, 9, 10], "healthcar": [7, 9, 10], "home": [0, 7, 9, 10], "12": 7, "hotel": [7, 9, 10], "largeshop": [7, 9, 10], "primary_school": [7, 9, 10], "secondary_school": [7, 9, 10], "smallshop": [7, 9, 10], "13": 7, "tempr": [7, 9, 10], "train": [7, 9, 10], "18": 7, "tube": [7, 9, 10], "17": 7, "14": 7, "wait": [7, 9, 10], "21": 7, "walk": [7, 9, 10], "15": 7, "namelistfil": 8, "none": [0, 8], "namelist": 8, "commerci": 8, "simplifi": 8, "thermal": 8, "balanc": 8, "scheme": 8, "f90nml": 8, "nml": 8, "path": 8, "width": 8, "x": 8, "axi": 8, "z": 8, "depth": 8, "note": 8, "flux": 8, "IN": 8, "watt": 8, "TO": 8, "BE": 8, "divid": 8, "BY": 8, "later": 8, "qf_sen": [], "qf_lat": [], "latent": 8, "qheat": 8, "need": 8, "split": 8, "qcool": 8, "qsensiblemet": [], "qlatentmet": [], "qhwttot": [], "qhwtdrain": 8, "drain": 8, "sewer": 8, "applianceload": [], "occupantload": [], "respect": 8, "energyexchang": 8, "allow": 8, "b": 8, "q": 8, "In": 8, "order": 8, "transmit": 8, "insol": 8, "through": 8, "window": 8, "qwii": [], "absorb": 8, "qwia": [], "wall": 8, "qwi": [], "transfer": 8, "intern": 8, "mass": 8, "qmc": [], "radi": 8, "qir": [], "qirw": [], "qirf": [], "gain": 8, "qia": [], "ventil": 8, "qvr": [], "qwc": [], "qwic": [], "qfc": [], "addit": 8, "system": 8, "loss": 8, "effici": 8, "qha": [], "conduct": 8, "insid": 8, "outsid": 8, "qwcon": [], "qwicon": [], "qfcon": [], "qgcon": [], "qwor": [], "qwior": [], "qwoc": [], "qwioc": [], "associ": 8, "eject": 8, "storag": 8, "qs_fabric": 8, "qs_air": 8, "sigma": 8, "stefan": 8, "boltzmann": 8, "constant": 8, "floorarea": [], "bulid": 8, "m2": 8, "wallexternalarea": 8, "ratiointernalvolum": 8, "volum": 8, "wwr": 8, "wallthick": [], "roof": 8, "thick": 8, "separ": 8, "floorthick": [], "grounddepth": [], "consid": 8, "windowthick": [], "wallroofinternalconvectioncoeffici": [], "internalmassconvectioncoeffici": [], "floorinternalconvectioncoeffici": [], "windowinternalconvectioncoeffici": [], "wallroofexternalconvectioncoeffici": [], "windowexternalconvectioncoeffici": [], "wallroofeffectiveconduct": [], "effect": 8, "ltotal": 8, "ln": 8, "kn": 8, "n": 8, "groundflooreffectiveconduct": [], "windoweffectiveconduct": [], "externalgroundconduct": [], "wallroofdens": [], "densiti": 8, "kg": 8, "groundfloordens": [], "windowdens": [], "internalmassdens": [], "indoorairdens": [], "wallroofshc": [], "specif": 8, "j": 8, "groundfloorshc": [], "windowshc": [], "internalmassshc": [], "indoorairshc": [], "wallroofexternalemiss": [], "wallroofinternalemiss": [], "internalmassemiss": [], "windowexternalemiss": [], "windowinternalemiss": [], "windowtransmiss": 8, "transmiss": 8, "windowabsorbt": 8, "absorbt": 8, "windowreflect": 8, "reflect": 8, "walltransmis": 8, "wallabsorbt": 8, "wallreflect": 8, "outdoorwallbvf": [], "view": 8, "factor": 8, "outdoorwallgvf": [], "outdoorwallsvf": [], "sky": 8, "present": 8, "metrat": 8, "rate": 8, "lsr": 8, "releas": 8, "appliancer": [], "singl": 8, "totalappli": [], "applianceusagefactor": [], "maxheatingpow": [], "heatingeffici": [], "maxcoolingpow": [], "coolingcop": [], "perform": 8, "airvolum": [], "multipli": 8, "account": 8, "m3": 8, "ventilationr": [], "chang": 8, "per": 8, "wallarea": [], "wallvolum": [], "floorvolum": [], "windowarea": [], "windowvolum": [], "internalmassvolum": [], "internalmassarea": [], "assum": 8, "cube": 8, "h_i": 8, "h_o": 8, "k_eff": 8, "rho": 8, "cp": 8, "emi": 8, "witar": 8, "properti": 8, "watar": 8, "viewfactor": 8, "occupantdata": 8, "ti": 8, "tm": 8, "twi": 8, "twii": 8, "twio": 8, "tfi": 8, "tfo": 8, "setpoint": 8, "initt": 8, "respecit": 8, "htsaverag": 8, "hwtsaverag": 8, "hot": 8, "twt": [], "tank": 8, "twt_wallin": [], "twt_wallext": [], "hwtthick": [], "twt_in": [], "come": 8, "vwt": [], "awt": [], "cylind": 8, "wvwt": [], "wtt": [], "init_wtt": 8, "tdhw": [], "held": 8, "tdhw_wallin": [], "vessel": 8, "tdhw_wallext": [], "dhwthick": [], "vdhw": [], "adhw": [], "wvdhw": [], "vwtflowrat": [], "flow": 8, "vdhwflowrat": [], "sing_vwtflowr": [], "fo": 8, "sing_vdhwflowr": [], "dhw_shc": [], "hwt_shc": [], "vhw_shc": [], "dhw_densiti": [], "hwt_densiti": [], "vhw_densiti": [], "wtbvf": [], "wtmvf": [], "hotwatertankwallconduct": [], "hotwatertankwallconvectioncoefficient_intern": [], "hotwatertankwallconvectioncoefficient_extern": [], "hotwatertankwallemissivity_extern": [], "domestichotwaterconduct": [], "domestichotwatervesselsconvectioncoefficient_intern": [], "domestichotwatervesselsconvectioncoefficient_extern": [], "domestichotwatervesselsemissivity_extern": [], "within": 8, "maxheatingpower_dhw": [], "haet": 8, "dhw_heatingeffici": [], "minvdhw": [], "minheatingpower_dhw": 8, "heatingpower_dhw": 8, "hwpoweraverag": 8, "hwflowrate_chang": [8, 9, 10], "user": [0, 8], "resolut": 8, "additionalsystemcoolingenergi": [8, 9, 10], "q_cool": 8, "cop": 8, "coolwcop": 8, "additionalsystemheatingenergi": [8, 9, 10], "q_heat": 8, "epsilon": 8, "inject": 8, "qh_addit": 8, "p": 8, "design": 8, "ramp": 8, "exponenti": 8, "accord": 8, "differ": 8, "load": 8, "node": 8, "getal": [8, 9, 10], "getalldhw": [8, 9, 10], "print": 8, "gethtsaverag": [8, 9, 10], "gethwtsaverag": [8, 9, 10], "getindoorairtemperatur": [8, 9, 10], "getindoorfloortemperatur": [8, 9, 10], "getindoormasstemperatur": [8, 9, 10], "getindoorwalltemperatur": [8, 9, 10], "getindoorwindowtemperatur": [8, 9, 10], "getlatentqf": [], "getoutdoorfloortemperatur": [8, 9, 10], "getoutdoorwalltemperatur": [8, 9, 10], "getoutdoorwindowtemperatur": [8, 9, 10], "getsensibleqfair": [], "getsensibleqfground": [], "gettimestepenergyexchang": [8, 9, 10], "indoorconvectionheattransf": [8, 9, 10], "A": 8, "type": 8, "solid": 8, "ind_cht": 8, "indoorradiativeheattransf": [8, 9, 10], "internalappliancegain": [8, 9, 10], "f": 8, "usag": 8, "in_app_gain": 8, "internalconvectionheattransf": [8, 9, 10], "tio": 8, "These": 8, "togeth": 8, "equal": 8, "int_cht": 8, "internaloccupancygain": [8, 9, 10], "occ_m": 8, "outdoorconvectionheattransf": [8, 9, 10], "ta": 8, "ambient": 8, "determin": 8, "model": 8, "out_cht": 8, "outdoorradiativeheattransf": [8, 9, 10], "radiat": 8, "here": 8, "implement": 8, "reinitialiseappload": [], "reinitialis": 8, "mai": 8, "want": 8, "call": 8, "instanc": 8, "program": 8, "give": 8, "urban": 8, "reinitialisehc": [8, 9, 10], "reinitialiseoccload": [], "reinitialiseqf": [], "reinitialisetemperatur": [8, 9, 10], "setairandmassvolum": [8, 9, 10], "setappliancedata": [8, 9, 10], "setconvectioncoeffici": [8, 9, 10], "hi": 8, "ho": 8, "setcoolingsystem": [8, 9, 10], "setdhwdrainagevolumeflowr": [8, 9, 10], "v": 8, "drainag": 8, "setdhwheatingsetpoint": [8, 9, 10], "setdhwusagevolum": [8, 9, 10], "setdhwusagevolumeflowr": [8, 9, 10], "setdepth": [8, 9, 10], "seteffectiveconduct": [8, 9, 10], "setemiss": [8, 9, 10], "setfloorarea": [8, 9, 10], "setfloorthick": [8, 9, 10], "setfloorvolum": [8, 9, 10], "setgvfactor": [8, 9, 10], "sethtsaverag": [8, 9, 10], "retriev": 8, "directli": 8, "sethwtmaxpow": [8, 9, 10], "no_hold": 8, "sethwtpow": [8, 9, 10], "sethwtpoweraverag": [8, 9, 10], "sethwtdim": [8, 9, 10], "dimens": 8, "sethwtsaverag": [8, 9, 10], "sethwflowr": [8, 9, 10], "from_tank": 8, "from_vessel": 8, "setheatingcoolingsetpoint": [8, 9, 10], "th": 8, "tc": 8, "setheatingsystem": [8, 9, 10], "setheight": [8, 9, 10], "setinternalmassarea": [8, 9, 10], "setlsr": [8, 9, 10], "l": 8, "setmaxheatingpow": [8, 9, 10], "setmetabolicr": [8, 9, 10], "setoccupancynumb": [8, 9, 10], "o": 8, "setoccupantdata": [8, 9, 10], "setshc": [8, 9, 10], "setsvfactor": [8, 9, 10], "setventilationr": [8, 9, 10], "vr": 8, "setviewfactor": [8, 9, 10], "setwtsetpoint": [8, 9, 10], "setwwr": [8, 9, 10], "setwallarea": [8, 9, 10], "setwalltar": [8, 9, 10], "setwallthick": [8, 9, 10], "setwallvolum": [8, 9, 10], "setwidth": [8, 9, 10], "setwindowarea": [8, 9, 10], "setwindowtar": [8, 9, 10], "setwindowthick": [8, 9, 10], "setwindowvolum": [8, 9, 10], "setdens": [8, 9, 10], "r": 8, "timestepcalculation_c": [8, 9, 10], "tg": [], "rho_outsideair": [], "cp_outsideair": [], "irr": 8, "lroof": [], "behaviour": 8, "wrapper": 8, "code": 8, "solar": 8, "horizont": 8, "vertic": 8, "ventilationheattransf": [8, 9, 10], "To": 8, "recircul": 8, "result": 8, "just": 8, "invers": 8, "sign": 8, "pressur": 8, "volumetr": 8, "q_in": 8, "wallconduct": [8, 9, 10], "1d": 8, "lump": 8, "wall_con": 8, "though": 8, "wallinsol": [8, 9, 10], "ab": 8, "incid": 8, "absorpt": 8, "wa_in": 8, "modifi": 8, "yiqe": 8, "liu": 8, "unit": 8, "becom": 8, "could": 8, "iether": 8, "kdown": 8, "beer": 8, "windowconduct": [8, 9, 10], "win_con": 8, "windowinsol": [8, 9, 10], "tr": 8, "wi": 8, "wi_in": 8, "equat": 8, "from_dict": [], "solvedgraph": [], "solvedgraphgrid": [], "solvedgraphnod": [], "valid": [], "process": [], "stop": [], "plot_subareas_heatmap": [], "start_grid": [], "queue": [], "multiprocess": [], "param": [], "method": [], "sub": [], "overridden": [], "32": [], "mie": [], "spectra": [], "permuat": [], "paramet": [], "pool": [], "default": [], "25": [], "spawn": [], "ts_sa": [], "dave": 0, "03": 0, "household_num": [0, 9, 10], "occupant_num": [0, 9, 10], "age_group": [0, 9, 10], "household_id": [0, 9, 10], "work_grid": [0, 9, 10], "school_grid": [0, 9, 10], "commute_mode_index": [0, 9, 10], "outside_test_area": [0, 9, 10], "add_to_dict": [0, 9, 10], "check": 0, "add": 0, "create_new_destin": [0, 9, 10], "current_rout": [0, 9, 10], "grid_nam": 0, "panda": 0, "datafram": 0, "get_household_memb": [0, 9, 10], "find": 0, "who": 0, "share": 0, "hh_members_in_same_room": [0, 9, 10], "household_memb": 0, "member": 0, "same": 0, "increase_subarea_tot": [0, 9, 10], "increas": 0, "extract": 0, "select_profil": [0, 9, 10], "randomli": 0, "select": 0, "correct": 0, "relative_path_to_absolute_path": [2, 3, 5, 9, 10], "relative_path": [2, 3, 5], "live": 0, "uniqu": 0, "identifi": 0, "occcup": 0, "locat": 0, "workdai": 0, "where": 0, "goe": 0, "citzen": 0, "travellign": 0, "citizn": 0, "acit": 0, "do": 0, "inform": 0, "about": 0, "transport": 0, "commut": 0, "memeb": 0, "in_same_room": 0, "height_build": [1, 8], "qmetabolic_sens": 8, "qmetabolic_lat": 8, "qtotal_water_tank": 8, "qsw_transmitted_window": 8, "qsw_absorbed_window": 8, "qsw_absorbed_wallroof": 8, "qconv_indair_to_indoormass": 8, "qlw_net_intwallroof_to_allotherindoorsurfac": 8, "qlw_net_intwindow_to_allotherindoorsurfac": 8, "qlw_net_intgroundfloor_to_allotherindoorsurfac": 8, "q_applianc": 8, "q_ventil": 8, "qconv_indair_to_intwallroof": 8, "qconv_indair_to_intwindow": 8, "qconv_indair_to_intgroundfloor": 8, "qloss_efficiency_heating_air": 8, "qcond_wallroof": 8, "qcond_window": 8, "qcond_groundfloor": 8, "qcond_ground": 8, "qlw_net_extwallroof_to_outair": 8, "qlw_net_extwindow_to_outair": 8, "qconv_extwallroof_to_outair": 8, "qconv_extwindow_to_outair": 8, "afootprint": 8, "ratio_window_wal": 8, "thickness_wallroof": 8, "thickness_groundfloor": 8, "depth_ground": 8, "thickness_window": 8, "conv_coeff_intwallroof": 8, "conv_coeff_indoormass": 8, "conv_coeff_intgroundfloor": 8, "conv_coeff_intwindow": 8, "conv_coeff_extwallroof": 8, "conv_coeff_extwindow": 8, "conductivity_wallroof": 8, "conductivity_groundfloor": 8, "conductivity_window": 8, "conductivity_ground": 8, "density_wallroof": 8, "density_groundfloor": 8, "density_window": 8, "density_indoormass": 8, "density_air_ind": 8, "cp_wallroof": 8, "cp_groundfloor": 8, "cp_window": 8, "cp_indoormass": 8, "cp_air_ind": 8, "emissivity_extwallroof": 8, "emissivity_intwallroof": 8, "emissivity_indoormass": 8, "emissivity_extwindow": 8, "emissivity_intwindow": 8, "bvf_extwal": 8, "gvf_extwal": 8, "svf_extwal": 8, "metabolic_r": 8, "ratio_metabolic_latent_sens": 8, "appliance_power_r": 8, "appliance_totalnumb": 8, "appliance_usage_factor": 8, "maxheatingpower_air": 8, "heating_efficiency_air": 8, "maxcoolingpower_air": 8, "coeff_performance_cool": 8, "vair_ind": 8, "ventilation_r": 8, "awallroof": 8, "vwallroof": 8, "vgroundfloor": 8, "awindow": 8, "vwindow": 8, "vindoormass": 8, "aindoormass": 8, "tair_ind": 8, "tindoormass": 8, "tintwallroof": 8, "textwallroof": 8, "tintwindow": 8, "textwindow": 8, "tintgroundfloor": 8, "textgroundfloor": 8, "twater_tank": 8, "tintwall_tank": 8, "textwall_tank": 8, "thickness_tankwal": 8, "tincomingwater_tank": 8, "vwater_tank": 8, "asurf_tank": 8, "vwall_tank": 8, "settwater_tank": 8, "twater_vessel": 8, "tintwall_vessel": 8, "textwall_vessel": 8, "thickness_wall_vessel": 8, "vwater_vessel": 8, "awater_vessel": 8, "vwall_vessel": 8, "flowrate_water_suppli": 8, "flowrate_water_drain": 8, "single_flowrate_water_suppli": 8, "cp_water": 8, "cp_wall_tank": 8, "cp_wall_vessel": 8, "density_wat": 8, "density_wall_tank": 8, "density_wall_vessel": 8, "bvf_tank": 8, "mvf_tank": 8, "conductivity_wall_tank": 8, "conv_coeff_intwall_tank": 8, "conv_coeff_extwall_tank": 8, "emissivity_extwall_tank": 8, "conductivity_wall_vessel": 8, "conv_coeff_intwall_vessel": 8, "conv_coeff_extwall_vessel": 8, "emissivity_extwall_vessel": 8, "maxheatingpower_wat": 8, "heating_efficiency_wat": 8, "minvwater_vessel": 8, "tair_out": 8, "tground_deep": 8, "density_air_out": 8, "cp_air_out": 8, "qsw_dn_extroof": 8, "qsw_dn_extwal": 8, "qlw_dn_extwal": 8, "qlw_dn_extroof": 8}, "objects": {"": [[0, 0, 0, "-", "Citizen"], [1, 0, 0, "-", "EnergyCalc"], [2, 0, 0, "-", "Initialise"], [3, 0, 0, "-", "Initialise_nhoods"], [4, 0, 0, "-", "Main_run"], [5, 0, 0, "-", "Movement"], [6, 0, 0, "-", "Nhood"], [7, 0, 0, "-", "Profile"], [8, 0, 0, "-", "STEBBS"]], "Citizen": [[0, 1, 1, "", "Citizen"]], "Citizen.Citizen": [[0, 2, 1, "", "add_to_dict"], [0, 3, 1, "", "age_group"], [0, 3, 1, "", "archetype"], [0, 3, 1, "", "commute_mode_index"], [0, 2, 1, "", "create_new_destination"], [0, 3, 1, "", "current_grid"], [0, 3, 1, "", "current_route"], [0, 3, 1, "", "daytype"], [0, 2, 1, "", "from_row"], [0, 2, 1, "", "get_household_members"], [0, 2, 1, "", "hh_members_in_same_room"], [0, 3, 1, "", "home"], [0, 3, 1, "", "household_id"], [0, 3, 1, "", "household_num"], [0, 3, 1, "", "household_size"], [0, 2, 1, "", "increase_subarea_total"], [0, 3, 1, "", "movement"], [0, 2, 1, "", "next"], [0, 3, 1, "", "occupant_num"], [0, 3, 1, "", "outside_test_area"], [0, 3, 1, "", "profile"], [0, 3, 1, "", "school_grid"], [0, 2, 1, "", "select_profile"], [0, 3, 1, "", "state"], [0, 3, 1, "", "subarea"], [0, 3, 1, "", "work_grid"]], "EnergyCalc": [[1, 4, 1, "", "QF_simple"], [1, 4, 1, "", "alter_dom_set_points"], [1, 4, 1, "", "alter_heating_HDD"], [1, 4, 1, "", "ext_conv_coeff"], [1, 4, 1, "", "feed_dom_energy"], [1, 4, 1, "", "floor_plan"], [1, 4, 1, "", "forcing_SUEWS"], [1, 4, 1, "", "run_SUEWS_ts"]], "Initialise": [[2, 1, 1, "", "Grid"], [2, 1, 1, "", "Journey"], [2, 4, 1, "", "assign_all_school_work_places"], [2, 4, 1, "", "assign_school_work_place"], [2, 4, 1, "", "create_all_citizens"], [2, 4, 1, "", "create_all_profiles"], [2, 4, 1, "", "relative_path_to_absolute_path"]], "Initialise_nhoods": [[3, 4, 1, "", "assign_households"], [3, 4, 1, "", "create_all_nhoods"], [3, 4, 1, "", "order_files"], [3, 4, 1, "", "relative_path_to_absolute_path"]], "Movement": [[5, 1, 1, "", "Movement"], [5, 4, 1, "", "load_saved_graph"], [5, 4, 1, "", "relative_path_to_absolute_path"]], "Movement.Movement": [[5, 2, 1, "", "choose_mode"], [5, 2, 1, "", "find_route"], [5, 2, 1, "", "get_capacities"], [5, 2, 1, "", "get_capacity"], [5, 2, 1, "", "get_mode_users"], [5, 2, 1, "", "grids_in_ts"], [5, 2, 1, "", "grids_travelled_through"], [5, 2, 1, "", "next"]], "Nhood": [[6, 1, 1, "", "BuildingArchetype"], [6, 1, 1, "", "Nhood"], [6, 1, 1, "", "SSO"]], "Nhood.BuildingArchetype": [[6, 3, 1, "", "building"], [6, 3, 1, "", "households"], [6, 3, 1, "", "name"]], "Nhood.Nhood": [[6, 3, 1, "", "commercial_buildings"], [6, 3, 1, "", "domestic_buildings"], [6, 2, 1, "", "from_grid_file"], [6, 3, 1, "", "gravity_weights"], [6, 3, 1, "", "household_sizes"], [6, 3, 1, "", "households"], [6, 3, 1, "", "industrial_modifiers"], [6, 3, 1, "", "name"], [6, 3, 1, "", "nhood_area"], [6, 3, 1, "", "primary_pop"], [6, 2, 1, "", "reset_subarea_populations"], [6, 3, 1, "", "secondary_pop"], [6, 2, 1, "", "select_grid_for_subarea"], [6, 3, 1, "", "shop_pop"], [6, 3, 1, "", "sso_areas"], [6, 3, 1, "", "subarea_pops"], [6, 3, 1, "", "work_pop"]], "Nhood.SSO": [[6, 3, 1, "", "CULTURAL"], [6, 3, 1, "", "HIGHENT"], [6, 3, 1, "", "HIGHST"], [6, 3, 1, "", "HOSPITAL"], [6, 3, 1, "", "LOWSHOPS"], [6, 3, 1, "", "OTHERMID"], [6, 3, 1, "", "RESTAURANT"], [6, 3, 1, "", "SCHOOL"], [6, 3, 1, "", "SUPERMARKET"], [6, 3, 1, "", "UNIVERSITY"], [6, 3, 1, "", "ZERO"], [6, 2, 1, "", "from_string"]], "Profile": [[7, 1, 1, "", "Age"], [7, 1, 1, "", "DayType"], [7, 1, 1, "", "Profile"], [7, 1, 1, "", "State"], [7, 1, 1, "", "Subarea"]], "Profile.Age": [[7, 3, 1, "", "ADULT"], [7, 3, 1, "", "CHILD"], [7, 3, 1, "", "INFANT"], [7, 3, 1, "", "SENIOR"], [7, 3, 1, "", "TEENAGER"], [7, 2, 1, "", "from_string"]], "Profile.DayType": [[7, 3, 1, "", "WEEKDAY"], [7, 3, 1, "", "WEEKEND"], [7, 2, 1, "", "from_string"]], "Profile.Profile": [[7, 3, 1, "", "age"], [7, 3, 1, "", "appliance_energy"], [7, 3, 1, "", "day_type"], [7, 3, 1, "", "final_state"], [7, 3, 1, "", "final_subarea"], [7, 3, 1, "", "finished"], [7, 2, 1, "", "from_row"], [7, 3, 1, "", "household_size"], [7, 3, 1, "", "initial_state"], [7, 3, 1, "", "initial_subarea"], [7, 2, 1, "", "key"], [7, 3, 1, "", "light_use"], [7, 3, 1, "", "metabolic_energy"], [7, 2, 1, "", "next"], [7, 3, 1, "", "rooms"], [7, 3, 1, "", "ts"], [7, 3, 1, "", "water_use"]], "Profile.State": [[7, 3, 1, "", "ASLEEP"], [7, 3, 1, "", "AWAKE"], [7, 2, 1, "", "from_string"]], "Profile.Subarea": [[7, 3, 1, "", "BUS"], [7, 3, 1, "", "CULTURAL"], [7, 3, 1, "", "CYCLING"], [7, 3, 1, "", "DRIVING"], [7, 3, 1, "", "HEALTHCARE"], [7, 3, 1, "", "HOME"], [7, 3, 1, "", "HOSPITALITY"], [7, 3, 1, "", "HOTEL"], [7, 3, 1, "", "INDOORENT"], [7, 3, 1, "", "LARGESHOP"], [7, 3, 1, "", "OUTDOOR"], [7, 3, 1, "", "OUTDOORENT"], [7, 3, 1, "", "PRIMARY_SCHOOL"], [7, 3, 1, "", "SECONDARY_SCHOOL"], [7, 3, 1, "", "SMALLSHOP"], [7, 3, 1, "", "TEMPRES"], [7, 3, 1, "", "TRAIN"], [7, 3, 1, "", "TUBE"], [7, 3, 1, "", "UNIVERSITY"], [7, 3, 1, "", "WAIT"], [7, 3, 1, "", "WALKING"], [7, 3, 1, "", "WORK"], [7, 2, 1, "", "from_string"]], "STEBBS": [[8, 1, 1, "", "LBM"]], "STEBBS.LBM": [[8, 2, 1, "", "HWflowrate_change"], [8, 2, 1, "", "additionalSystemCoolingEnergy"], [8, 2, 1, "", "additionalSystemHeatingEnergy"], [8, 2, 1, "", "cooling"], [8, 2, 1, "", "getAll"], [8, 2, 1, "", "getAllDHW"], [8, 2, 1, "", "getHTsAverage"], [8, 2, 1, "", "getHWTsAverage"], [8, 2, 1, "", "getIndoorAirTemperature"], [8, 2, 1, "", "getIndoorFloorTemperature"], [8, 2, 1, "", "getIndoorMassTemperature"], [8, 2, 1, "", "getIndoorWallTemperature"], [8, 2, 1, "", "getIndoorWindowTemperature"], [8, 2, 1, "", "getOutdoorFloorTemperature"], [8, 2, 1, "", "getOutdoorWallTemperature"], [8, 2, 1, "", "getOutdoorWindowTemperature"], [8, 2, 1, "", "getTimestepEnergyExchanges"], [8, 2, 1, "", "heating"], [8, 2, 1, "", "indoorConvectionHeatTransfer"], [8, 2, 1, "", "indoorRadiativeHeatTransfer"], [8, 2, 1, "", "internalApplianceGains"], [8, 2, 1, "", "internalConvectionHeatTransfer"], [8, 2, 1, "", "internalOccupancyGains"], [8, 2, 1, "", "outdoorConvectionHeatTransfer"], [8, 2, 1, "", "outdoorRadiativeHeatTransfer"], [8, 2, 1, "", "reinitialiseHC"], [8, 2, 1, "", "reinitialiseTemperatures"], [8, 2, 1, "", "setAirAndMassVolume"], [8, 2, 1, "", "setApplianceData"], [8, 2, 1, "", "setConvectionCoefficients"], [8, 2, 1, "", "setCoolingSystem"], [8, 2, 1, "", "setDHWDrainageVolumeFlowRate"], [8, 2, 1, "", "setDHWHeatingSetpoint"], [8, 2, 1, "", "setDHWUsageVolume"], [8, 2, 1, "", "setDHWUsageVolumeFlowRate"], [8, 2, 1, "", "setDepth"], [8, 2, 1, "", "setEffectiveConductivity"], [8, 2, 1, "", "setEmissivity"], [8, 2, 1, "", "setFloorArea"], [8, 2, 1, "", "setFloorThickness"], [8, 2, 1, "", "setFloorVolume"], [8, 2, 1, "", "setGVFactor"], [8, 2, 1, "", "setHTsAverage"], [8, 2, 1, "", "setHWTMaxPower"], [8, 2, 1, "", "setHWTPower"], [8, 2, 1, "", "setHWTPowerAverage"], [8, 2, 1, "", "setHWTdims"], [8, 2, 1, "", "setHWTsAverage"], [8, 2, 1, "", "setHWflowrate"], [8, 2, 1, "", "setHeatingCoolingSetpoint"], [8, 2, 1, "", "setHeatingSystem"], [8, 2, 1, "", "setHeight"], [8, 2, 1, "", "setInternalMassArea"], [8, 2, 1, "", "setLSR"], [8, 2, 1, "", "setMaxHeatingPower"], [8, 2, 1, "", "setMetabolicRate"], [8, 2, 1, "", "setOccupancyNumber"], [8, 2, 1, "", "setOccupantData"], [8, 2, 1, "", "setSHC"], [8, 2, 1, "", "setSVFactor"], [8, 2, 1, "", "setVentilationRate"], [8, 2, 1, "", "setViewFactors"], [8, 2, 1, "", "setWTsetpoint"], [8, 2, 1, "", "setWWR"], [8, 2, 1, "", "setWallArea"], [8, 2, 1, "", "setWallTAR"], [8, 2, 1, "", "setWallThickness"], [8, 2, 1, "", "setWallVolume"], [8, 2, 1, "", "setWidth"], [8, 2, 1, "", "setWindowArea"], [8, 2, 1, "", "setWindowTAR"], [8, 2, 1, "", "setWindowThickness"], [8, 2, 1, "", "setWindowVolume"], [8, 2, 1, "", "setdensity"], [8, 2, 1, "", "timeStepCalculation_c"], [8, 2, 1, "", "ventilationHeatTransfer"], [8, 2, 1, "", "wallConduction"], [8, 2, 1, "", "wallInsolation"], [8, 2, 1, "", "windowConduction"], [8, 2, 1, "", "windowInsolation"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "function", "Python function"]}, "titleterms": {"welcom": [], "dave": [9, 10], "": [], "document": [], "indic": 9, "tabl": 9, "big": 9, "citizen": 0, "modul": [0, 1, 2, 3, 4, 5, 6, 7, 8], "energycalc": 1, "initialis": 2, "initialise_nhood": 3, "main_run": 4, "movement": 5, "nhood": 6, "profil": 7, "stebb": 8, "solvegraph": [], "load_solved_graph": [], "03": 10, "multi_process": [], "plot": [], "serialize_travel_graph": [], "paramet": [0, 1, 5, 8], "return": [0, 1, 2, 8], "attribut": [5, 8], "arg": []}, "envversion": {"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, "sphinx": 60}, "alltitles": {"BIG DAVE": [[9, "big-dave"]], "Indices and tables": [[9, "indices-and-tables"]], "DAVE-03": [[10, "dave-03"]], "Initialise_nhoods module": [[3, "module-Initialise_nhoods"]], "Parameters": [[8, "parameters"], [8, "id1"], [8, "id2"], [8, "id3"], [8, "id8"], [8, "id13"], [8, "id15"], [8, "id16"], [8, "id17"], [8, "id18"], [8, "id19"], [8, "id20"], [8, "id21"], [8, "id22"], [8, "id23"], [8, "id24"], [8, "id25"], [8, "id26"], [8, "id27"], [8, "id28"], [8, "id29"], [8, "id30"], [8, "id31"], [8, "id32"], [8, "id33"], [8, "id34"], [8, "id35"], [8, "id41"], [0, "parameters"], [0, "id1"], [0, "id2"], [0, "id3"], [0, "id4"], [1, "parameters"], [1, "id1"], [1, "id2"], [1, "id4"], [1, "id6"], [1, "id8"], [1, "id10"], [5, "parameters"]], "Returns": [[8, "returns"], [8, "id4"], [8, "id5"], [8, "id6"], [8, "id7"], [8, "id9"], [8, "id10"], [8, "id11"], [8, "id12"], [8, "id14"], [8, "id36"], [8, "id37"], [8, "id38"], [8, "id39"], [8, "id40"], [8, "id42"], [0, "returns"], [1, "returns"], [1, "id3"], [1, "id5"], [1, "id7"], [2, "returns"]], "Attributes": [[8, "attributes"], [5, "attributes"]], "STEBBS module": [[8, "module-STEBBS"]], "Citizen module": [[0, "module-Citizen"]], "EnergyCalc module": [[1, "module-EnergyCalc"]], "Return": [[1, "return"], [1, "id9"], [1, "id11"]], "Initialise module": [[2, "module-Initialise"]], "Main_run module": [[4, "module-Main_run"]], "Movement module": [[5, "module-Movement"]], "Nhood module": [[6, "module-Nhood"]], "Profile module": [[7, "module-Profile"]]}, "indexentries": {"citizen": [[0, "module-Citizen"]], "citizen (class in citizen)": [[0, "Citizen.Citizen"]], "add_to_dict() (citizen.citizen method)": [[0, "Citizen.Citizen.add_to_dict"]], "age_group (citizen.citizen attribute)": [[0, "Citizen.Citizen.age_group"]], "archetype (citizen.citizen attribute)": [[0, "Citizen.Citizen.archetype"]], "commute_mode_index (citizen.citizen attribute)": [[0, "Citizen.Citizen.commute_mode_index"]], "create_new_destination() (citizen.citizen method)": [[0, "Citizen.Citizen.create_new_destination"]], "current_grid (citizen.citizen attribute)": [[0, "Citizen.Citizen.current_grid"]], "current_route (citizen.citizen attribute)": [[0, "Citizen.Citizen.current_route"]], "daytype (citizen.citizen attribute)": [[0, "Citizen.Citizen.daytype"]], "from_row() (citizen.citizen class method)": [[0, "Citizen.Citizen.from_row"]], "get_household_members() (citizen.citizen method)": [[0, "Citizen.Citizen.get_household_members"]], "hh_members_in_same_room() (citizen.citizen method)": [[0, "Citizen.Citizen.hh_members_in_same_room"]], "home (citizen.citizen attribute)": [[0, "Citizen.Citizen.home"]], "household_id (citizen.citizen attribute)": [[0, "Citizen.Citizen.household_id"]], "household_num (citizen.citizen attribute)": [[0, "Citizen.Citizen.household_num"]], "household_size (citizen.citizen attribute)": [[0, "Citizen.Citizen.household_size"]], "increase_subarea_total() (citizen.citizen method)": [[0, "Citizen.Citizen.increase_subarea_total"]], "module": [[0, "module-Citizen"], [1, "module-EnergyCalc"], [2, "module-Initialise"], [4, "module-Main_run"], [5, "module-Movement"], [6, "module-Nhood"], [7, "module-Profile"]], "movement (citizen.citizen attribute)": [[0, "Citizen.Citizen.movement"]], "next() (citizen.citizen method)": [[0, "Citizen.Citizen.next"]], "occupant_num (citizen.citizen attribute)": [[0, "Citizen.Citizen.occupant_num"]], "outside_test_area (citizen.citizen attribute)": [[0, "Citizen.Citizen.outside_test_area"]], "profile (citizen.citizen attribute)": [[0, "Citizen.Citizen.profile"]], "school_grid (citizen.citizen attribute)": [[0, "Citizen.Citizen.school_grid"]], "select_profile() (citizen.citizen method)": [[0, "Citizen.Citizen.select_profile"]], "state (citizen.citizen attribute)": [[0, "Citizen.Citizen.state"]], "subarea (citizen.citizen attribute)": [[0, "Citizen.Citizen.subarea"]], "work_grid (citizen.citizen attribute)": [[0, "Citizen.Citizen.work_grid"]], "energycalc": [[1, "module-EnergyCalc"]], "qf_simple() (in module energycalc)": [[1, "EnergyCalc.QF_simple"]], "alter_dom_set_points() (in module energycalc)": [[1, "EnergyCalc.alter_dom_set_points"]], "alter_heating_hdd() (in module energycalc)": [[1, "EnergyCalc.alter_heating_HDD"]], "ext_conv_coeff() (in module energycalc)": [[1, "EnergyCalc.ext_conv_coeff"]], "feed_dom_energy() (in module energycalc)": [[1, "EnergyCalc.feed_dom_energy"]], "floor_plan() (in module energycalc)": [[1, "EnergyCalc.floor_plan"]], "forcing_suews() (in module energycalc)": [[1, "EnergyCalc.forcing_SUEWS"]], "run_suews_ts() (in module energycalc)": [[1, "EnergyCalc.run_SUEWS_ts"]], "grid (class in initialise)": [[2, "Initialise.Grid"]], "initialise": [[2, "module-Initialise"]], "journey (class in initialise)": [[2, "Initialise.Journey"]], "assign_all_school_work_places() (in module initialise)": [[2, "Initialise.assign_all_school_work_places"]], "assign_school_work_place() (in module initialise)": [[2, "Initialise.assign_school_work_place"]], "create_all_citizens() (in module initialise)": [[2, "Initialise.create_all_citizens"]], "create_all_profiles() (in module initialise)": [[2, "Initialise.create_all_profiles"]], "relative_path_to_absolute_path() (in module initialise)": [[2, "Initialise.relative_path_to_absolute_path"]], "main_run": [[4, "module-Main_run"]], "movement": [[5, "module-Movement"]], "movement (class in movement)": [[5, "Movement.Movement"]], "choose_mode() (movement.movement method)": [[5, "Movement.Movement.choose_mode"]], "find_route() (movement.movement method)": [[5, "Movement.Movement.find_route"]], "get_capacities() (movement.movement method)": [[5, "Movement.Movement.get_capacities"]], "get_capacity() (movement.movement method)": [[5, "Movement.Movement.get_capacity"]], "get_mode_users() (movement.movement method)": [[5, "Movement.Movement.get_mode_users"]], "grids_in_ts() (movement.movement method)": [[5, "Movement.Movement.grids_in_ts"]], "grids_travelled_through() (movement.movement method)": [[5, "Movement.Movement.grids_travelled_through"]], "load_saved_graph() (in module movement)": [[5, "Movement.load_saved_graph"]], "next() (movement.movement method)": [[5, "Movement.Movement.next"]], "relative_path_to_absolute_path() (in module movement)": [[5, "Movement.relative_path_to_absolute_path"]], "buildingarchetype (class in nhood)": [[6, "Nhood.BuildingArchetype"]], "cultural (nhood.sso attribute)": [[6, "Nhood.SSO.CULTURAL"]], "highent (nhood.sso attribute)": [[6, "Nhood.SSO.HIGHENT"]], "highst (nhood.sso attribute)": [[6, "Nhood.SSO.HIGHST"]], "hospital (nhood.sso attribute)": [[6, "Nhood.SSO.HOSPITAL"]], "lowshops (nhood.sso attribute)": [[6, "Nhood.SSO.LOWSHOPS"]], "nhood": [[6, "module-Nhood"]], "nhood (class in nhood)": [[6, "Nhood.Nhood"]], "othermid (nhood.sso attribute)": [[6, "Nhood.SSO.OTHERMID"]], "restaurant (nhood.sso attribute)": [[6, "Nhood.SSO.RESTAURANT"]], "school (nhood.sso attribute)": [[6, "Nhood.SSO.SCHOOL"]], "sso (class in nhood)": [[6, "Nhood.SSO"]], "supermarket (nhood.sso attribute)": [[6, "Nhood.SSO.SUPERMARKET"]], "university (nhood.sso attribute)": [[6, "Nhood.SSO.UNIVERSITY"]], "zero (nhood.sso attribute)": [[6, "Nhood.SSO.ZERO"]], "building (nhood.buildingarchetype attribute)": [[6, "Nhood.BuildingArchetype.building"]], "commercial_buildings (nhood.nhood attribute)": [[6, "Nhood.Nhood.commercial_buildings"]], "domestic_buildings (nhood.nhood attribute)": [[6, "Nhood.Nhood.domestic_buildings"]], "from_grid_file() (nhood.nhood class method)": [[6, "Nhood.Nhood.from_grid_file"]], "from_string() (nhood.sso class method)": [[6, "Nhood.SSO.from_string"]], "gravity_weights (nhood.nhood attribute)": [[6, "Nhood.Nhood.gravity_weights"]], "household_sizes (nhood.nhood attribute)": [[6, "Nhood.Nhood.household_sizes"]], "households (nhood.buildingarchetype attribute)": [[6, "Nhood.BuildingArchetype.households"]], "households (nhood.nhood attribute)": [[6, "Nhood.Nhood.households"]], "industrial_modifiers (nhood.nhood attribute)": [[6, "Nhood.Nhood.industrial_modifiers"]], "name (nhood.buildingarchetype attribute)": [[6, "Nhood.BuildingArchetype.name"]], "name (nhood.nhood attribute)": [[6, "Nhood.Nhood.name"]], "nhood_area (nhood.nhood attribute)": [[6, "Nhood.Nhood.nhood_area"]], "primary_pop (nhood.nhood attribute)": [[6, "Nhood.Nhood.primary_pop"]], "reset_subarea_populations() (nhood.nhood method)": [[6, "Nhood.Nhood.reset_subarea_populations"]], "secondary_pop (nhood.nhood attribute)": [[6, "Nhood.Nhood.secondary_pop"]], "select_grid_for_subarea() (nhood.nhood method)": [[6, "Nhood.Nhood.select_grid_for_subarea"]], "shop_pop (nhood.nhood attribute)": [[6, "Nhood.Nhood.shop_pop"]], "sso_areas (nhood.nhood attribute)": [[6, "Nhood.Nhood.sso_areas"]], "subarea_pops (nhood.nhood attribute)": [[6, "Nhood.Nhood.subarea_pops"]], "work_pop (nhood.nhood attribute)": [[6, "Nhood.Nhood.work_pop"]], "adult (profile.age attribute)": [[7, "Profile.Age.ADULT"]], "asleep (profile.state attribute)": [[7, "Profile.State.ASLEEP"]], "awake (profile.state attribute)": [[7, "Profile.State.AWAKE"]], "age (class in profile)": [[7, "Profile.Age"]], "bus (profile.subarea attribute)": [[7, "Profile.Subarea.BUS"]], "child (profile.age attribute)": [[7, "Profile.Age.CHILD"]], "cultural (profile.subarea attribute)": [[7, "Profile.Subarea.CULTURAL"]], "cycling (profile.subarea attribute)": [[7, "Profile.Subarea.CYCLING"]], "driving (profile.subarea attribute)": [[7, "Profile.Subarea.DRIVING"]], "daytype (class in profile)": [[7, "Profile.DayType"]], "healthcare (profile.subarea attribute)": [[7, "Profile.Subarea.HEALTHCARE"]], "home (profile.subarea attribute)": [[7, "Profile.Subarea.HOME"]], "hospitality (profile.subarea attribute)": [[7, "Profile.Subarea.HOSPITALITY"]], "hotel (profile.subarea attribute)": [[7, "Profile.Subarea.HOTEL"]], "indoorent (profile.subarea attribute)": [[7, "Profile.Subarea.INDOORENT"]], "infant (profile.age attribute)": [[7, "Profile.Age.INFANT"]], "largeshop (profile.subarea attribute)": [[7, "Profile.Subarea.LARGESHOP"]], "outdoor (profile.subarea attribute)": [[7, "Profile.Subarea.OUTDOOR"]], "outdoorent (profile.subarea attribute)": [[7, "Profile.Subarea.OUTDOORENT"]], "primary_school (profile.subarea attribute)": [[7, "Profile.Subarea.PRIMARY_SCHOOL"]], "profile": [[7, "module-Profile"]], "profile (class in profile)": [[7, "Profile.Profile"]], "secondary_school (profile.subarea attribute)": [[7, "Profile.Subarea.SECONDARY_SCHOOL"]], "senior (profile.age attribute)": [[7, "Profile.Age.SENIOR"]], "smallshop (profile.subarea attribute)": [[7, "Profile.Subarea.SMALLSHOP"]], "state (class in profile)": [[7, "Profile.State"]], "subarea (class in profile)": [[7, "Profile.Subarea"]], "teenager (profile.age attribute)": [[7, "Profile.Age.TEENAGER"]], "tempres (profile.subarea attribute)": [[7, "Profile.Subarea.TEMPRES"]], "train (profile.subarea attribute)": [[7, "Profile.Subarea.TRAIN"]], "tube (profile.subarea attribute)": [[7, "Profile.Subarea.TUBE"]], "university (profile.subarea attribute)": [[7, "Profile.Subarea.UNIVERSITY"]], "wait (profile.subarea attribute)": [[7, "Profile.Subarea.WAIT"]], "walking (profile.subarea attribute)": [[7, "Profile.Subarea.WALKING"]], "weekday (profile.daytype attribute)": [[7, "Profile.DayType.WEEKDAY"]], "weekend (profile.daytype attribute)": [[7, "Profile.DayType.WEEKEND"]], "work (profile.subarea attribute)": [[7, "Profile.Subarea.WORK"]], "age (profile.profile attribute)": [[7, "Profile.Profile.age"]], "appliance_energy (profile.profile attribute)": [[7, "Profile.Profile.appliance_energy"]], "day_type (profile.profile attribute)": [[7, "Profile.Profile.day_type"]], "final_state (profile.profile attribute)": [[7, "Profile.Profile.final_state"]], "final_subarea (profile.profile attribute)": [[7, "Profile.Profile.final_subarea"]], "finished (profile.profile attribute)": [[7, "Profile.Profile.finished"]], "from_row() (profile.profile class method)": [[7, "Profile.Profile.from_row"]], "from_string() (profile.age class method)": [[7, "Profile.Age.from_string"]], "from_string() (profile.daytype class method)": [[7, "Profile.DayType.from_string"]], "from_string() (profile.state class method)": [[7, "Profile.State.from_string"]], "from_string() (profile.subarea class method)": [[7, "Profile.Subarea.from_string"]], "household_size (profile.profile attribute)": [[7, "Profile.Profile.household_size"]], "initial_state (profile.profile attribute)": [[7, "Profile.Profile.initial_state"]], "initial_subarea (profile.profile attribute)": [[7, "Profile.Profile.initial_subarea"]], "key() (profile.profile method)": [[7, "Profile.Profile.key"]], "light_use (profile.profile attribute)": [[7, "Profile.Profile.light_use"]], "metabolic_energy (profile.profile attribute)": [[7, "Profile.Profile.metabolic_energy"]], "next() (profile.profile method)": [[7, "Profile.Profile.next"]], "rooms (profile.profile attribute)": [[7, "Profile.Profile.rooms"]], "ts (profile.profile attribute)": [[7, "Profile.Profile.ts"]], "water_use (profile.profile attribute)": [[7, "Profile.Profile.water_use"]]}}) \ No newline at end of file diff --git a/docs/build/html/serialize_travel_graphs.html b/docs/build/html/serialize_travel_graphs.html new file mode 100644 index 0000000..c0e01d7 --- /dev/null +++ b/docs/build/html/serialize_travel_graphs.html @@ -0,0 +1,117 @@ + + + + + + + + serialize_travel_graphs module — DAVE documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

serialize_travel_graphs module

+
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/source/Citizen.rst b/docs/source/Citizen.rst new file mode 100644 index 0000000..828e31b --- /dev/null +++ b/docs/source/Citizen.rst @@ -0,0 +1,7 @@ +Citizen module +============== + +.. automodule:: Citizen + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/EnergyCalc.rst b/docs/source/EnergyCalc.rst new file mode 100644 index 0000000..2eb2f4b --- /dev/null +++ b/docs/source/EnergyCalc.rst @@ -0,0 +1,7 @@ +EnergyCalc module +================= + +.. automodule:: EnergyCalc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/Initialise.rst b/docs/source/Initialise.rst new file mode 100644 index 0000000..b52a753 --- /dev/null +++ b/docs/source/Initialise.rst @@ -0,0 +1,7 @@ +Initialise module +================= + +.. automodule:: Initialise + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/Initialise_nhoods.rst b/docs/source/Initialise_nhoods.rst new file mode 100644 index 0000000..a64be29 --- /dev/null +++ b/docs/source/Initialise_nhoods.rst @@ -0,0 +1,7 @@ +Initialise\_nhoods module +========================= + +.. automodule:: Initialise_nhoods + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/Main_run.rst b/docs/source/Main_run.rst new file mode 100644 index 0000000..06c629a --- /dev/null +++ b/docs/source/Main_run.rst @@ -0,0 +1,7 @@ +Main\_run module +================ + +.. automodule:: Main_run + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/Movement.rst b/docs/source/Movement.rst new file mode 100644 index 0000000..92c3d80 --- /dev/null +++ b/docs/source/Movement.rst @@ -0,0 +1,7 @@ +Movement module +=============== + +.. automodule:: Movement + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/Nhood.rst b/docs/source/Nhood.rst new file mode 100644 index 0000000..0307323 --- /dev/null +++ b/docs/source/Nhood.rst @@ -0,0 +1,7 @@ +Nhood module +============ + +.. automodule:: Nhood + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/Profile.rst b/docs/source/Profile.rst new file mode 100644 index 0000000..1d493bf --- /dev/null +++ b/docs/source/Profile.rst @@ -0,0 +1,7 @@ +Profile module +============== + +.. automodule:: Profile + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/STEBBS.rst b/docs/source/STEBBS.rst new file mode 100644 index 0000000..db1ea87 --- /dev/null +++ b/docs/source/STEBBS.rst @@ -0,0 +1,7 @@ +STEBBS module +============= + +.. automodule:: STEBBS + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/SuPy.log b/docs/source/SuPy.log new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..18cdeca --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,183 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../../')) + +# force inports in a particular order +import Initialise +import Initialise_nhoods +import Profile +import plotting +import EnergyCalc + +# -- Project information ----------------------------------------------------- + +project = 'DAVE' +copyright = '2023, Megan McGrory' +author = 'Megan McGrory' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "en" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'DAVEdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'DAVE.tex', 'DAVE Documentation', + 'Megan McGrory', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'dave', 'DAVE Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'DAVE', 'DAVE Documentation', + author, 'DAVE', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- diff --git a/docs/source/flat_purpose/1SetUp.txt b/docs/source/flat_purpose/1SetUp.txt new file mode 100644 index 0000000..b6c5af8 --- /dev/null +++ b/docs/source/flat_purpose/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=flat_purpose +BuildingName=1 +Height=19.4 +FootprintArea=2203.4 +RatioInternalVolume=0.1 +GroundDepth=2.0 +ratio_window_wall=0.25 +WallThickness=0.277 +FloorThickness=0.279 +WindowThickness=0.0269 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.402 +GroundFloorEffectiveConductivity=0.253 +WindowEffectiveConductivity=0.079 +ExternalGroundConductivity=1.28 +WallDensity=1674.5 +Wallx1=0.5 +GroundFloorDensity=1305.8 +WindowDensity=923.9 +InternalMassDensity=632.4 +IndoorAirDensity=1.225 +WallCp=898.4 +GroundFloorCp=1080.0 +WindowCp=842.0 +InternalMassCp=1483.5 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.909 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.419 +WallReflectivity=0.581 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=1908055.9 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=38471.364 +VentilationRate=0.6 +WallArea=4603.700000000001 +WallVolume=1275.2249000000004 +FloorArea=2203.4 +FloorVolume=614.7486000000001 +WindowArea=800.1 +WindowVolume=21.52269 +InternalMassVolume=3847.1364000000003 +InternalMassArea=1473.1364429159382 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=20.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=12.465 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=1908055.9 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0 diff --git a/docs/source/house_detached/1SetUp.txt b/docs/source/house_detached/1SetUp.txt new file mode 100644 index 0000000..e002f24 --- /dev/null +++ b/docs/source/house_detached/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=house_detached +BuildingName=1 +Height=14.0 +FootprintArea=299.9 +RatioInternalVolume=0.1 +GroundDepth=2.0 +ratio_window_wall=0.25 +WallThickness=0.261 +FloorThickness=0.238 +WindowThickness=0.005 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.607 +GroundFloorEffectiveConductivity=0.717 +WindowEffectiveConductivity=0.985 +ExternalGroundConductivity=1.28 +WallDensity=1386.5 +Wallx1=0.5 +GroundFloorDensity=1524.1 +WindowDensity=2402.8 +InternalMassDensity=999.1 +IndoorAirDensity=1.225 +WallCp=857.8 +GroundFloorCp=1017.4 +WindowCp=846.5 +InternalMassCp=1290.3 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.9 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.619 +WallReflectivity=0.381 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=279653.7 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=3778.74 +VentilationRate=0.6 +WallArea=832.4 +WallVolume=217.2564 +FloorArea=299.9 +FloorVolume=71.3762 +WindowArea=177.5 +WindowVolume=0.8875000000000001 +InternalMassVolume=377.874 +InternalMassArea=313.60472031053956 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=20.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=3.01 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=279653.7 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0 diff --git a/docs/source/house_unspecific/1SetUp.txt b/docs/source/house_unspecific/1SetUp.txt new file mode 100644 index 0000000..3b19f87 --- /dev/null +++ b/docs/source/house_unspecific/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=house_unspecific +BuildingName=1 +Height=15.3 +FootprintArea=774.6 +RatioInternalVolume=0.1 +GroundDepth=2.0 +ratio_window_wall=0.25 +WallThickness=0.252 +FloorThickness=0.235 +WindowThickness=0.004 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.689 +GroundFloorEffectiveConductivity=0.752 +WindowEffectiveConductivity=1.05 +ExternalGroundConductivity=1.28 +WallDensity=1477.2 +Wallx1=0.5 +GroundFloorDensity=1540.4 +WindowDensity=2500.0 +InternalMassDensity=1056.6 +IndoorAirDensity=1.225 +WallCp=831.8 +GroundFloorCp=1012.8 +WindowCp=840.0 +InternalMassCp=1276.0 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.9 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.625 +WallReflectivity=0.375 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=6589192.0 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=10666.242000000002 +VentilationRate=0.6 +WallArea=1492.35 +WallVolume=376.07219999999995 +FloorArea=774.6 +FloorVolume=182.031 +WindowArea=239.25 +WindowVolume=0.9570000000000001 +InternalMassVolume=1066.6242000000002 +InternalMassArea=626.3621973387853 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=20.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=77.325 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=6589192.0 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0 diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..d3a3d9d --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,26 @@ +.. DAVE documentation master file, created by + sphinx-quickstart on Tue Nov 7 22:01:50 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +BIG DAVE +================================ +.. toctree:: + :maxdepth: 4 + + Citizen + EnergyCalc + Initialise + Initialise_nhoods + Main_run + Movement + Nhood + Profile + STEBBS + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..2624ec9 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,15 @@ +DAVE-03 +======= + +.. toctree:: + :maxdepth: 4 + + Citizen + EnergyCalc + Initialise + Initialise_nhoods + Main_run + Movement + Nhood + Profile + STEBBS diff --git a/docs/source/semi_detached/1SetUp.txt b/docs/source/semi_detached/1SetUp.txt new file mode 100644 index 0000000..bbf5200 --- /dev/null +++ b/docs/source/semi_detached/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=semi_detached +BuildingName=1 +Height=14.4 +FootprintArea=209.5 +RatioInternalVolume=0.1 +GroundDepth=2.0 +ratio_window_wall=0.25 +WallThickness=0.286 +FloorThickness=0.24 +WindowThickness=0.006 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.398 +GroundFloorEffectiveConductivity=0.69 +WindowEffectiveConductivity=0.927 +ExternalGroundConductivity=1.28 +WallDensity=1038.9 +Wallx1=0.5 +GroundFloorDensity=1511.3 +WindowDensity=2317.0 +InternalMassDensity=953.9 +IndoorAirDensity=1.225 +WallCp=930.5 +GroundFloorCp=1021.1 +WindowCp=852.2 +InternalMassCp=1301.6 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.903 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.55 +WallReflectivity=0.45 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=27000.0 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=2715.1200000000003 +VentilationRate=0.6 +WallArea=838.1500000000001 +WallVolume=239.7109 +FloorArea=209.5 +FloorVolume=50.28 +WindowArea=209.55 +WindowVolume=1.2573 +InternalMassVolume=271.51200000000006 +InternalMassArea=251.58067012921646 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=20.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=0.135 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=27000.0 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0 diff --git a/docs/source/shared_house/1SetUp.txt b/docs/source/shared_house/1SetUp.txt new file mode 100644 index 0000000..62f72e2 --- /dev/null +++ b/docs/source/shared_house/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=shared_house +BuildingName=1 +Height=13.0 +FootprintArea=3229.1 +RatioInternalVolume=0.1 +GroundDepth=2.0 +ratio_window_wall=0.25 +WallThickness=0.252 +FloorThickness=0.235 +WindowThickness=0.004 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.689 +GroundFloorEffectiveConductivity=0.752 +WindowEffectiveConductivity=1.05 +ExternalGroundConductivity=1.28 +WallDensity=1477.2 +Wallx1=0.5 +GroundFloorDensity=1540.4 +WindowDensity=2500.0 +InternalMassDensity=1056.6 +IndoorAirDensity=1.225 +WallCp=831.8 +GroundFloorCp=1012.8 +WindowCp=840.0 +InternalMassCp=1276.0 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.9 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.625 +WallReflectivity=0.375 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=24000.0 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=37780.469999999994 +VentilationRate=0.6 +WallArea=6853.175 +WallVolume=1727.0001 +FloorArea=3229.1 +FloorVolume=758.8385 +WindowArea=1208.025 +WindowVolume=4.8321000000000005 +InternalMassVolume=3778.0469999999996 +InternalMassArea=1455.4461935779523 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=20.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=0.12 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=24000.0 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0 diff --git a/docs/source/shed_garage/1SetUp.txt b/docs/source/shed_garage/1SetUp.txt new file mode 100644 index 0000000..85642f3 --- /dev/null +++ b/docs/source/shed_garage/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=shed_garage +BuildingName=1 +Height=3.7 +FootprintArea=21.6 +RatioInternalVolume=0.0 +GroundDepth=2.0 +ratio_window_wall=0.0 +WallThickness=0.252 +FloorThickness=0.235 +WindowThickness=0.004 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.689 +GroundFloorEffectiveConductivity=0.752 +WindowEffectiveConductivity=1.05 +ExternalGroundConductivity=1.28 +WallDensity=1477.2 +Wallx1=0.5 +GroundFloorDensity=1540.4 +WindowDensity=2500.0 +InternalMassDensity=1056.6 +IndoorAirDensity=1.225 +WallCp=831.8 +GroundFloorCp=1012.8 +WindowCp=840.0 +InternalMassCp=1276.0 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.9 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.625 +WallReflectivity=0.375 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=0.0 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=79.92000000000002 +VentilationRate=0.6 +WallArea=69.4 +WallVolume=17.4888 +FloorArea=21.6 +FloorVolume=5.076 +WindowArea=0.0 +WindowVolume=0.0 +InternalMassVolume=0.0 +InternalMassArea=0.0 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=20.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=0.0 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=0.0 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0 diff --git a/docs/source/terraced/1SetUp.txt b/docs/source/terraced/1SetUp.txt new file mode 100644 index 0000000..6107fab --- /dev/null +++ b/docs/source/terraced/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=terraced +BuildingName=1 +Height=14.0 +FootprintArea=91.1 +RatioInternalVolume=0.1 +GroundDepth=2.0 +ratio_window_wall=0.25 +WallThickness=0.253 +FloorThickness=0.235 +WindowThickness=0.0042 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.679 +GroundFloorEffectiveConductivity=0.751 +WindowEffectiveConductivity=1.039 +ExternalGroundConductivity=1.28 +WallDensity=1464.7 +Wallx1=0.5 +GroundFloorDensity=1539.9 +WindowDensity=2483.3 +InternalMassDensity=1050.6 +IndoorAirDensity=1.225 +WallCp=834.2 +GroundFloorCp=1012.9 +WindowCp=841.1 +InternalMassCp=1276.4 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.9 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.623 +WallReflectivity=0.377 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=1719192.7 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=1147.86 +VentilationRate=0.6 +WallArea=236.9 +WallVolume=59.935700000000004 +FloorArea=91.1 +FloorVolume=21.408499999999997 +WindowArea=48.6 +WindowVolume=0.20412 +InternalMassVolume=114.786 +InternalMassArea=141.7132740410612 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=20.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=12.68 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=1719192.7 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0 diff --git a/docs/source/unoccupied_flat/1SetUp.txt b/docs/source/unoccupied_flat/1SetUp.txt new file mode 100644 index 0000000..1f2901c --- /dev/null +++ b/docs/source/unoccupied_flat/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=unoccupied_flat +BuildingName=1 +Height=15.9 +FootprintArea=694.7 +RatioInternalVolume=0.1 +GroundDepth=2.0 +ratio_window_wall=0.25 +WallThickness=0.28 +FloorThickness=0.285 +WindowThickness=0.028 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.375 +GroundFloorEffectiveConductivity=0.182 +WindowEffectiveConductivity=0.034 +ExternalGroundConductivity=1.28 +WallDensity=1692.9 +Wallx1=0.5 +GroundFloorDensity=1272.8 +WindowDensity=850.1 +InternalMassDensity=572.8 +IndoorAirDensity=1.225 +WallCp=904.6 +GroundFloorCp=1089.5 +WindowCp=842.1 +InternalMassCp=1512.7 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.91 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.4 +WallReflectivity=0.6 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=28000.0 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=9941.157000000001 +VentilationRate=0.6 +WallArea=2067.7250000000004 +WallVolume=578.9630000000002 +FloorArea=694.7 +FloorVolume=197.9895 +WindowArea=457.675 +WindowVolume=12.8149 +InternalMassVolume=994.1157000000002 +InternalMassArea=597.6439656099105 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=12.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=0.135 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=28000.0 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0 diff --git a/docs/source/unoccupied_house/1SetUp.txt b/docs/source/unoccupied_house/1SetUp.txt new file mode 100644 index 0000000..13e94de --- /dev/null +++ b/docs/source/unoccupied_house/1SetUp.txt @@ -0,0 +1,112 @@ +BuildingType=unoccupied_house +BuildingName=1 +Height=13.7 +FootprintArea=79.8 +RatioInternalVolume=0.1 +GroundDepth=2.0 +ratio_window_wall=0.25 +WallThickness=0.272 +FloorThickness=0.235 +WindowThickness=0.0073 +WallInternalConvectionCoefficient=3.0 +InternalMassConvectionCoefficient=3.0 +FloorInternalConvectionCoefficient=2.8 +WindowInternalConvectionCoefficient=3.0 +WallExternalConvectionCoefficient=21.72 +WindowExternalConvectionCoefficient=21.72 +WallEffectiveConductivity=0.558 +GroundFloorEffectiveConductivity=0.752 +WindowEffectiveConductivity=0.845 +ExternalGroundConductivity=1.28 +WallDensity=1287.4 +Wallx1=0.5 +GroundFloorDensity=1540.4 +WindowDensity=2195.4 +InternalMassDensity=963.1 +IndoorAirDensity=1.225 +WallCp=863.1 +GroundFloorCp=1012.8 +WindowCp=860.4 +InternalMassCp=1275.8 +IndoorAirCp=1005.0 +WallExternalEmissivity=0.902 +WallInternalEmissivity=0.91 +InternalMassEmissivity=0.91 +WindowExternalEmissivity=0.88 +WindowInternalEmissivity=0.88 +WindowTransmissivity=0.8 +WindowAbsorbtivity=0.15 +WindowReflectivity=0.05 +WallTransmissivity=0.0 +WallAbsorbtivity=0.584 +WallReflectivity=0.416 +WallBuildingViewFactor=0.4 +WallGroundViewFactor=0.2 +WallSkyViewFactor=0.4 +occupants=0 +MetabolicRate=70.0 +LatentSensibleRatio=0.43 +appliance_power_rating=100 +TotalNumberofAppliances=1 +ApplianceUsageFactor=1 +MaxHeatingPower=24000.0 +HeatingSystemEfficiency=0.9 +MaxCoolingPower=3000 +CoolingSystemCOP=2.0 +AirVolume=983.934 +VentilationRate=0.6 +WallArea=257.325 +WallVolume=69.9924 +FloorArea=79.8 +FloorVolume=18.752999999999997 +WindowArea=59.175 +WindowVolume=0.43197749999999996 +InternalMassVolume=98.3934 +InternalMassArea=127.87782147129568 +IndoorAirStartTemperature=15.0 +IndoorMassStartTemperature=20.0 +WallIndoorSurfaceTemperature=20.0 +WallOutdoorSurfaceTemperature=20.0 +WindowIndoorSurfaceTemperature=20.0 +WindowOutdoorSurfaceTemperature=20.0 +GroundFloorIndoorSurfaceTemperature=20.0 +GroundFloorOutdoorSurfaceTemperature=20.0 +HeatingSetpointTemperature=12.0 +CoolingSetpointTemperature=27.0 +WaterTankTemperature=30.0 +InternalWallWaterTankTemperature=30.0 +ExternalWallWaterTankTemperature=30.0 +WaterTankWallThickness=0.055 +MainsWaterTemperature=10.0 +WaterTankWaterVolume=0.12 +WaterTankSurfaceArea=8.8 +HotWaterTankWallVolume=0.48400000000000004 +HotWaterHeatingSetpointTemperature=60.0 +DomesticHotWaterTemperatureInUseInBuilding=40.0 +InternalWallDHWVesselTemperature=35.0 +ExternalWallDHWVesselTemperature=25.0 +DHWVesselWallThickness=0.0047 +DHWWaterVolume=10.0 +DHWSurfaceArea=1.7 +DHWVesselWallVolume=0.00799 +HotWaterFlowRate=0.000183 +DHWDrainFlowRate=0.00013725 +DHWSpecificHeatCapacity=4180.1 +HotWaterTankSpecificHeatCapacity=1380.0 +DHWVesselSpecificHeatCapacity=1380.0 +DHWDensity=1000.0 +HotWaterTankWallDensity=745.55 +DHWVesselDensity=1380.0 +HotWaterTankBuildingWallViewFactor=0.2 +HotWaterTankInternalMassViewFactor=0.8 +HotWaterTankWallConductivity=0.0275 +HotWaterTankInternalWallConvectionCoefficient=243.0 +HotWaterTankExternalWallConvectionCoefficient=3.0 +HotWaterTankWallEmissivity=0.9 +DHWVesselWallConductivity=0.16 +DHWVesselInternalWallConvectionCoefficient=243.0 +DHWVesselExternalWallConvectionCoefficient=3.0 +DHWVesselWallEmissivity=0.91 +MaximumHotWaterHeatingPower=24000.0 +HotWaterHeatingEfficiency=0.95 +MinimumVolumeOfDHWinUse=2.0