PyPES
Overview
README
Getting Started
JSON Representation
Advanced Features
Contribution Agreement
LICENSE
Class Hierarchy
connection
node
tag
JSON Parsing
parse_json
units
Miscellaneous
logbook
operations
utils
visualize
PyPES
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
add_connection() (pype_schema.node.Network method)
,
[1]
add_entry() (pype_schema.logbook.Logbook method)
,
[1]
add_node() (pype_schema.node.Network method)
,
[1]
add_tag() (pype_schema.connection.Connection method)
,
[1]
(pype_schema.node.Node method)
,
[1]
add_virtual_tags() (pype_schema.parse_json.JSONParser method)
,
[1]
Aeration (class in pype_schema.node)
,
[1]
Aerobic (pype_schema.utils.DigesterType attribute)
Air (pype_schema.utils.ContentsType attribute)
AirBlower (pype_schema.utils.PumpType attribute)
Anaerobic (pype_schema.utils.DigesterType attribute)
Antiscalant (pype_schema.utils.DosingType attribute)
Average (pype_schema.tag.DownsampleType attribute)
B
Battery (class in pype_schema.node)
,
[1]
bidirectional (pype_schema.connection.Connection attribute)
Biogas (pype_schema.utils.ContentsType attribute)
BOD (pype_schema.tag.TagType attribute)
Boiler (class in pype_schema.node)
,
[1]
Brine (pype_schema.utils.ContentsType attribute)
C
calculate_values() (pype_schema.tag.VirtualTag method)
,
[1]
calibration (pype_schema.tag.Tag property)
CaOH2 (pype_schema.utils.DosingType attribute)
charge_rate (pype_schema.node.Battery property)
check_type_compatibility() (pype_schema.tag.Tag method)
,
[1]
Chemical (pype_schema.utils.ContentsType attribute)
ChlorinatedSeawater (pype_schema.utils.ContentsType attribute)
Chlorination (class in pype_schema.node)
,
[1]
Clarification (class in pype_schema.node)
,
[1]
CO2 (pype_schema.utils.DosingType attribute)
Coagulant (pype_schema.utils.ContentsType attribute)
CoagulatedWater (pype_schema.utils.ContentsType attribute)
COD (pype_schema.tag.TagType attribute)
Cogeneration (class in pype_schema.node)
,
[1]
collect_virtual_tags() (pype_schema.parse_json.JSONParser method)
,
[1]
Concentration (pype_schema.tag.TagType attribute)
Conditioning (class in pype_schema.node)
,
[1]
Conductivity (pype_schema.tag.TagType attribute)
conn_to_dict() (pype_schema.parse_json.JSONParser static method)
,
[1]
Connection (class in pype_schema.connection)
,
[1]
Constant (pype_schema.utils.PumpType attribute)
contents (pype_schema.connection.Connection attribute)
ContentsType (class in pype_schema.utils)
,
[1]
ControlSignal (pype_schema.utils.ContentsType attribute)
count_args() (in module pype_schema.utils)
,
[1]
create_connection() (pype_schema.parse_json.JSONParser method)
,
[1]
create_node() (pype_schema.parse_json.JSONParser method)
,
[1]
Critical (pype_schema.logbook.LogCode attribute)
D
DataTransfer (pype_schema.utils.ContentsType attribute)
Decimation (pype_schema.tag.DownsampleType attribute)
default() (pype_schema.epyt_utils.NpEncoder method)
del_calibration() (pype_schema.tag.Tag method)
del_charge_rate() (pype_schema.node.Battery method)
del_design_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
del_design_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
del_design_pressure() (pype_schema.connection.Pipe method)
del_dosing_area() (pype_schema.node.UVSystem method)
del_dosing_rate() (pype_schema.node.Disinfection method)
(pype_schema.node.Filtration method)
(pype_schema.node.Reactor method)
del_downsample_method() (pype_schema.tag.Tag method)
del_efficiency() (pype_schema.node.Pump method)
del_energy_capacity() (pype_schema.node.Battery method)
del_leakage() (pype_schema.node.Battery method)
del_manufacturer() (pype_schema.tag.Tag method)
del_max_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
del_max_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
del_max_pressure() (pype_schema.connection.Pipe method)
del_measure_freq() (pype_schema.tag.Tag method)
del_min_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
del_min_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
del_min_pressure() (pype_schema.connection.Pipe method)
del_num_units() (pype_schema.node.Tank method)
del_power_rating() (pype_schema.node.Pump method)
del_report_freq() (pype_schema.tag.Tag method)
del_residence_time() (pype_schema.node.Disinfection method)
del_rte() (pype_schema.node.Battery method)
Delivery (class in pype_schema.connection)
,
[1]
Deodorant (pype_schema.utils.ContentsType attribute)
design_flow (pype_schema.connection.Pipe property)
(pype_schema.node.Node property)
design_gen (pype_schema.node.Boiler property)
(pype_schema.node.Cogeneration property)
design_pressure (pype_schema.connection.Pipe property)
destination (pype_schema.connection.Connection attribute)
DigesterType (class in pype_schema.utils)
,
[1]
Digestion (class in pype_schema.node)
,
[1]
Disinfectant (pype_schema.utils.ContentsType attribute)
DisinfectedEffluent (pype_schema.utils.ContentsType attribute)
Disinfection (class in pype_schema.node)
,
[1]
dosing_area (pype_schema.node.UVSystem property)
dosing_rate (pype_schema.node.Disinfection property)
(pype_schema.node.Filtration property)
(pype_schema.node.Reactor property)
dosing_to_dict() (pype_schema.parse_json.JSONParser static method)
,
[1]
DosingType (class in pype_schema.utils)
,
[1]
downsample_method (pype_schema.tag.Tag property)
DownsampleType (class in pype_schema.tag)
,
[1]
draw_graph() (in module pype_schema.visualize)
,
[1]
DrinkingWater (pype_schema.utils.ContentsType attribute)
E
efficiency (pype_schema.node.Pump property)
Efficiency (pype_schema.tag.TagType attribute)
Electricity (pype_schema.utils.ContentsType attribute)
energy_capacity (pype_schema.node.Battery property)
entry_point (pype_schema.connection.Connection attribute)
epyt2pypes() (in module pype_schema.epyt_utils)
ERD (pype_schema.utils.PumpType attribute)
Error (pype_schema.logbook.LogCode attribute)
exit_point (pype_schema.connection.Connection attribute)
extend_node() (pype_schema.parse_json.JSONParser method)
,
[1]
F
Facility (class in pype_schema.node)
,
[1]
FatOilGrease (pype_schema.utils.ContentsType attribute)
FeCl3 (pype_schema.utils.DosingType attribute)
FilterBackwash (pype_schema.utils.ContentsType attribute)
Filtrate (pype_schema.utils.ContentsType attribute)
Filtration (class in pype_schema.node)
,
[1]
Flaring (class in pype_schema.node)
,
[1]
Flow (pype_schema.tag.TagType attribute)
FoodWaste (pype_schema.utils.ContentsType attribute)
Frequency (pype_schema.tag.TagType attribute)
G
GasBlend (pype_schema.utils.ContentsType attribute)
get_all_connections() (pype_schema.node.Node method)
,
[1]
get_all_connections_from() (pype_schema.node.Node method)
,
[1]
get_all_connections_to() (pype_schema.node.Node method)
,
[1]
get_all_nodes() (pype_schema.node.Node method)
,
[1]
get_all_tags() (pype_schema.node.Node method)
,
[1]
get_calibration() (pype_schema.tag.Tag method)
get_capacities() (pype_schema.node.Node method)
,
[1]
get_change() (in module pype_schema.operations)
,
[1]
get_charge_rate() (pype_schema.node.Battery method)
get_connection() (pype_schema.node.Node method)
,
[1]
get_design_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
get_design_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
get_design_pressure() (pype_schema.connection.Pipe method)
get_dest_id() (pype_schema.connection.Connection method)
,
[1]
get_dest_node() (pype_schema.connection.Connection method)
,
[1]
get_dosing_area() (pype_schema.node.UVSystem method)
get_dosing_rate() (pype_schema.node.Disinfection method)
(pype_schema.node.Filtration method)
(pype_schema.node.Reactor method)
get_downsample_method() (pype_schema.tag.Tag method)
get_efficiencies() (pype_schema.node.Node method)
,
[1]
get_efficiency() (pype_schema.node.Pump method)
get_energy_capacity() (pype_schema.node.Battery method)
get_entry_point() (pype_schema.connection.Connection method)
,
[1]
get_exit_point() (pype_schema.connection.Connection method)
,
[1]
get_leakage() (pype_schema.node.Battery method)
get_list_of_type() (pype_schema.node.Network method)
,
[1]
get_manufacturer() (pype_schema.tag.Tag method)
get_max_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
get_max_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
get_max_pressure() (pype_schema.connection.Pipe method)
get_measure_freq() (pype_schema.tag.Tag method)
get_min_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
get_min_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
get_min_pressure() (pype_schema.connection.Pipe method)
get_module_version() (in module pype_schema)
get_node() (pype_schema.node.Node method)
,
[1]
get_node_or_connection() (pype_schema.node.Node method)
,
[1]
get_num_dest_units() (pype_schema.connection.Connection method)
,
[1]
get_num_source_units() (pype_schema.connection.Connection method)
,
[1]
get_num_units() (pype_schema.node.Tank method)
get_parent() (pype_schema.node.Node method)
,
[1]
get_parent_from_tag() (pype_schema.node.Node method)
,
[1]
get_power_rating() (pype_schema.node.Pump method)
get_report_freq() (pype_schema.tag.Tag method)
get_residence_time() (pype_schema.node.Disinfection method)
get_rte() (pype_schema.node.Battery method)
get_source_id() (pype_schema.connection.Connection method)
,
[1]
get_source_node() (pype_schema.connection.Connection method)
,
[1]
get_tag() (pype_schema.connection.Connection method)
,
[1]
(pype_schema.node.Node method)
,
[1]
get_tag_contents() (pype_schema.parse_json.JSONParser static method)
,
[1]
get_tag_sum_lambda_func() (in module pype_schema.utils)
,
[1]
Grease (pype_schema.utils.ContentsType attribute)
Groundwater (pype_schema.utils.ContentsType attribute)
H
Heat (pype_schema.utils.ContentsType attribute)
I
id (pype_schema.connection.Connection attribute)
(pype_schema.node.Node attribute)
IndustrialWastewater (pype_schema.utils.ContentsType attribute)
InFlow (pype_schema.tag.TagType attribute)
Info (pype_schema.logbook.LogCode attribute)
initialize_network() (pype_schema.parse_json.JSONParser method)
,
[1]
input_contents (pype_schema.node.Node attribute)
J
Joint (class in pype_schema.node)
,
[1]
JSONParser (class in pype_schema.parse_json)
,
[1]
L
leakage (pype_schema.node.Battery property)
Level (pype_schema.tag.TagType attribute)
load_entries() (pype_schema.logbook.Logbook method)
,
[1]
Logbook (class in pype_schema.logbook)
,
[1]
LogCode (class in pype_schema.logbook)
,
[1]
LogEntry (class in pype_schema.logbook)
,
[1]
M
manufacturer (pype_schema.tag.Tag property)
max_flow (pype_schema.connection.Pipe property)
(pype_schema.node.Node property)
max_gen (pype_schema.node.Boiler property)
(pype_schema.node.Cogeneration property)
max_pressure (pype_schema.connection.Pipe property)
measure_freq (pype_schema.tag.Tag property)
merge_network() (pype_schema.parse_json.JSONParser method)
,
[1]
min_flow (pype_schema.connection.Pipe property)
(pype_schema.node.Node property)
min_gen (pype_schema.node.Boiler property)
(pype_schema.node.Cogeneration property)
min_max_design_to_dict() (pype_schema.parse_json.JSONParser static method)
,
[1]
min_pressure (pype_schema.connection.Pipe property)
ModularUnit (class in pype_schema.node)
,
[1]
module
pype_schema
pype_schema.connection
pype_schema.data
pype_schema.epyt_utils
pype_schema.logbook
,
[1]
pype_schema.node
,
[1]
pype_schema.operations
,
[1]
pype_schema.parse_json
pype_schema.tag
,
[1]
pype_schema.units
,
[1]
pype_schema.utils
,
[1]
pype_schema.visualize
MunicipalWastewater (pype_schema.utils.ContentsType attribute)
N
NaOCl (pype_schema.utils.DosingType attribute)
NaturalGas (pype_schema.utils.ContentsType attribute)
NetFlow (pype_schema.tag.TagType attribute)
Network (class in pype_schema.node)
,
[1]
next_entry_id() (pype_schema.logbook.Logbook method)
,
[1]
Node (class in pype_schema.node)
,
[1]
node_to_dict() (pype_schema.parse_json.JSONParser static method)
,
[1]
NonpotableReuse (pype_schema.utils.ContentsType attribute)
NpEncoder (class in pype_schema.epyt_utils)
num_units (pype_schema.node.Tank property)
O
Oil (pype_schema.utils.ContentsType attribute)
OrthoPolyphosphate (pype_schema.utils.DosingType attribute)
OutFlow (pype_schema.tag.TagType attribute)
output_contents (pype_schema.node.Node attribute)
P
parse_contents() (pype_schema.parse_json.JSONParser method)
,
[1]
parse_dosing_rate() (pype_schema.parse_json.JSONParser static method)
,
[1]
parse_heating_values() (pype_schema.parse_json.JSONParser static method)
,
[1]
parse_min_max_design() (pype_schema.parse_json.JSONParser static method)
,
[1]
parse_quantity() (in module pype_schema.utils)
,
[1]
parse_tag() (pype_schema.parse_json.JSONParser static method)
,
[1]
parse_unit_val_dict() (pype_schema.parse_json.JSONParser static method)
,
[1]
parse_units() (in module pype_schema.utils)
,
[1]
parse_virtual_tag() (pype_schema.parse_json.JSONParser static method)
,
[1]
pH (pype_schema.tag.TagType attribute)
Pipe (class in pype_schema.connection)
Polymer (pype_schema.utils.DosingType attribute)
PotableReuse (pype_schema.utils.ContentsType attribute)
power_rating (pype_schema.node.Pump property)
pprint() (pype_schema.logbook.LogEntry method)
,
[1]
prefix_children() (pype_schema.parse_json.JSONParser static method)
,
[1]
Pressure (pype_schema.tag.TagType attribute)
PretreatedWater (pype_schema.utils.ContentsType attribute)
PrimaryEffluent (pype_schema.utils.ContentsType attribute)
PrimarySludge (pype_schema.utils.ContentsType attribute)
print_query() (pype_schema.logbook.Logbook method)
,
[1]
process_ops() (pype_schema.tag.VirtualTag method)
,
[1]
ProductWater (pype_schema.utils.ContentsType attribute)
Pump (class in pype_schema.node)
,
[1]
PumpType (class in pype_schema.utils)
,
[1]
pype_schema
module
pype_schema.connection
module
pype_schema.data
module
pype_schema.epyt_utils
module
pype_schema.logbook
module
,
[1]
pype_schema.node
module
,
[1]
pype_schema.operations
module
,
[1]
pype_schema.parse_json
module
pype_schema.tag
module
,
[1]
pype_schema.units
module
,
[1]
pype_schema.utils
module
,
[1]
pype_schema.visualize
module
Q
query() (pype_schema.logbook.Logbook method)
,
[1]
R
Reactor (class in pype_schema.node)
,
[1]
recursive_get() (in module pype_schema.utils)
,
[1]
remove_connection() (pype_schema.node.Network method)
,
[1]
remove_entry() (pype_schema.logbook.Logbook method)
,
[1]
remove_node() (pype_schema.node.Network method)
,
[1]
remove_tag() (pype_schema.connection.Connection method)
,
[1]
(pype_schema.node.Node method)
,
[1]
report_freq (pype_schema.tag.Tag property)
Reservoir (class in pype_schema.node)
,
[1]
(pype_schema.tag.DownsampleType attribute)
residence_time (pype_schema.node.Disinfection property)
ROMembrane (class in pype_schema.node)
,
[1]
Rotation (pype_schema.tag.TagType attribute)
rte (pype_schema.node.Battery property)
RunStatus (pype_schema.tag.TagType attribute)
RunTime (pype_schema.tag.TagType attribute)
S
save_query() (pype_schema.logbook.Logbook method)
,
[1]
SBS (pype_schema.utils.DosingType attribute)
Screening (class in pype_schema.node)
,
[1]
Scum (pype_schema.utils.ContentsType attribute)
Seawater (pype_schema.utils.ContentsType attribute)
SecondaryEffluent (pype_schema.utils.ContentsType attribute)
select_objs() (pype_schema.node.Node method)
,
[1]
select_objs_helper() (in module pype_schema.utils)
,
[1]
select_tags() (pype_schema.node.Node method)
,
[1]
select_virtual_tags() (pype_schema.node.Node method)
,
[1]
set_calibration() (pype_schema.tag.Tag method)
set_charge_rate() (pype_schema.node.Battery method)
set_contents() (pype_schema.node.Node method)
,
[1]
set_design_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
set_design_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
set_design_pressure() (pype_schema.connection.Pipe method)
set_dosing() (pype_schema.node.Node method)
,
[1]
set_dosing_area() (pype_schema.node.UVSystem method)
set_dosing_rate() (pype_schema.node.Disinfection method)
(pype_schema.node.Filtration method)
(pype_schema.node.Reactor method)
set_downsample_method() (pype_schema.tag.Tag method)
set_efficiency() (pype_schema.node.Pump method)
set_electrical_efficiency() (pype_schema.node.Cogeneration method)
,
[1]
set_energy_capacity() (pype_schema.node.Battery method)
set_flow_rate() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
,
[1]
set_gen_capacity() (pype_schema.node.Boiler method)
,
[1]
(pype_schema.node.Cogeneration method)
,
[1]
set_heating_values() (pype_schema.connection.Pipe method)
set_leakage() (pype_schema.node.Battery method)
set_manufacturer() (pype_schema.tag.Tag method)
set_max_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
set_max_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
set_max_pressure() (pype_schema.connection.Pipe method)
set_measure_freq() (pype_schema.tag.Tag method)
set_min_flow() (pype_schema.connection.Pipe method)
(pype_schema.node.Node method)
set_min_gen() (pype_schema.node.Boiler method)
(pype_schema.node.Cogeneration method)
set_min_pressure() (pype_schema.connection.Pipe method)
set_num_units() (pype_schema.node.Tank method)
set_power_rating() (pype_schema.node.Pump method)
set_pressure() (pype_schema.connection.Pipe method)
set_pump_curve() (pype_schema.node.Pump method)
,
[1]
set_report_freq() (pype_schema.tag.Tag method)
set_residence_time() (pype_schema.node.Disinfection method)
set_rte() (pype_schema.node.Battery method)
set_sig_figs() (in module pype_schema.units)
,
[1]
set_thermal_efficiency() (pype_schema.node.Boiler method)
,
[1]
(pype_schema.node.Cogeneration method)
,
[1]
SetPoint (pype_schema.tag.TagType attribute)
SludgeBlend (pype_schema.utils.ContentsType attribute)
SolidWaste (pype_schema.utils.ContentsType attribute)
source (pype_schema.connection.Connection attribute)
Speed (pype_schema.tag.TagType attribute)
StateOfCharge (pype_schema.tag.TagType attribute)
StaticMixer (class in pype_schema.node)
,
[1]
Stormwater (pype_schema.utils.ContentsType attribute)
SurfaceWater (pype_schema.utils.ContentsType attribute)
T
Tag (class in pype_schema.tag)
,
[1]
tag_to_dict() (pype_schema.parse_json.JSONParser static method)
,
[1]
tags (pype_schema.connection.Connection attribute)
(pype_schema.node.Node attribute)
TagType (class in pype_schema.tag)
,
[1]
Tank (class in pype_schema.node)
,
[1]
TDS (pype_schema.tag.TagType attribute)
Temperature (pype_schema.tag.TagType attribute)
TertiaryEffluent (pype_schema.utils.ContentsType attribute)
ThickenedSludgeBlend (pype_schema.utils.ContentsType attribute)
Thickening (class in pype_schema.node)
,
[1]
to_csv() (pype_schema.logbook.Logbook method)
,
[1]
to_json() (pype_schema.logbook.Logbook method)
,
[1]
(pype_schema.parse_json.JSONParser static method)
,
[1]
TPS (pype_schema.utils.ContentsType attribute)
TreatedSewage (pype_schema.utils.ContentsType attribute)
TSS (pype_schema.tag.TagType attribute)
Turbidity (pype_schema.tag.TagType attribute)
TWAS (pype_schema.utils.ContentsType attribute)
U
unit_val_to_dict() (pype_schema.parse_json.JSONParser static method)
,
[1]
UntreatedSewage (pype_schema.utils.ContentsType attribute)
UVLight (pype_schema.utils.DosingType attribute)
UVSystem (class in pype_schema.node)
,
[1]
V
VFD (pype_schema.utils.PumpType attribute)
VirtualTag (class in pype_schema.tag)
,
[1]
Volume (pype_schema.tag.TagType attribute)
VSS (pype_schema.tag.TagType attribute)
W
Warning (pype_schema.logbook.LogCode attribute)
WasteActivatedSludge (pype_schema.utils.ContentsType attribute)
WFBS (pype_schema.utils.ContentsType attribute)
Wire (class in pype_schema.connection)
,
[1]
Wireless (class in pype_schema.connection)
,
[1]