Shyft: The Open Source Toolbox for Energy Markets
This document was last updated on 2023-11-25.
The open source SHyFT project contains four individual Python packages:
shyft.hydrology
which provides spatially distributed conceptual hydrological modelsshyft.energy-market
which provides elements to build an energy market modelshyft.time-series
which provides a high performance generic time-series frameworkshyft.dashboard
which provides web components to display time series using Bokeh.
Project
Time Series
- Installation
- Concepts
- Tutorials
- Examples
- API Documentation
- Time
- Function utctime_now
- Function deltahours
- Function deltaminutes
- Class time
- Class YMDhms
- Class YWdhms
- Class TzInfo
- Class Calendar
Calendar
Calendar.DAY
Calendar.HOUR
Calendar.MINUTE
Calendar.MONTH
Calendar.QUARTER
Calendar.RANGE
Calendar.SECOND
Calendar.TZ_RANGE
Calendar.WEEK
Calendar.YEAR
Calendar.__init__()
Calendar.add()
Calendar.calendar_units()
Calendar.calendar_week_units()
Calendar.day_of_year()
Calendar.diff_units()
Calendar.quarter()
Calendar.region_id_list()
Calendar.time()
Calendar.time_from_week()
Calendar.to_string()
Calendar.trim()
Calendar.tz_info
- Class UtcPeriod
- Class UtcTimeVector
- Time series
- Class TimeAxis
TimeAxis
TimeAxis.__call__()
TimeAxis.__init__()
TimeAxis.calendar_dt
TimeAxis.fixed_dt
TimeAxis.index_of()
TimeAxis.merge()
TimeAxis.open_range_index_of()
TimeAxis.period()
TimeAxis.point_dt
TimeAxis.size()
TimeAxis.slice()
TimeAxis.time()
TimeAxis.time_points
TimeAxis.time_points_double
TimeAxis.timeaxis_type
TimeAxis.total_period()
- Class TimeSeries
TimeSeries
TimeSeries.__call__()
TimeSeries.__init__()
TimeSeries.abs()
TimeSeries.accumulate()
TimeSeries.average()
TimeSeries.bind()
TimeSeries.bind_done()
TimeSeries.bucket_to_hourly()
TimeSeries.clone_expression()
TimeSeries.compress()
TimeSeries.compress_size()
TimeSeries.convolve_w()
TimeSeries.decode()
TimeSeries.derivative()
TimeSeries.deserialize()
TimeSeries.evaluate()
TimeSeries.extend()
TimeSeries.fill()
TimeSeries.find_ts_bind_info()
TimeSeries.get()
TimeSeries.get_krls_predictor()
TimeSeries.get_time_axis()
TimeSeries.ice_packing()
TimeSeries.ice_packing_recession()
TimeSeries.index_of()
TimeSeries.inside()
TimeSeries.integral()
TimeSeries.kling_gupta()
TimeSeries.krls_interpolation()
TimeSeries.log()
TimeSeries.lower_half()
TimeSeries.lower_half_mask()
TimeSeries.max()
TimeSeries.merge_points()
TimeSeries.min()
TimeSeries.min_max_check_linear_fill()
TimeSeries.min_max_check_ts_fill()
TimeSeries.nash_sutcliffe()
TimeSeries.needs_bind()
TimeSeries.partition_by()
TimeSeries.point_interpretation()
TimeSeries.pow()
TimeSeries.quality_and_self_correction()
TimeSeries.quality_and_ts_correction()
TimeSeries.rating_curve()
TimeSeries.repeat()
TimeSeries.scale_by()
TimeSeries.serialize()
TimeSeries.set()
TimeSeries.set_point_interpretation()
TimeSeries.set_ts_id()
TimeSeries.size()
TimeSeries.slice()
TimeSeries.stack()
TimeSeries.statistics()
TimeSeries.stringify()
TimeSeries.time()
TimeSeries.time_axis
TimeSeries.time_shift()
TimeSeries.total_period()
TimeSeries.transform()
TimeSeries.ts_id()
TimeSeries.unbind()
TimeSeries.upper_half()
TimeSeries.upper_half_mask()
TimeSeries.use_time_axis_from()
TimeSeries.v
TimeSeries.value()
TimeSeries.values
- Class TsVector
TsVector
TsVector.__init__()
TsVector.abs()
TsVector.accumulate()
TsVector.append()
TsVector.average()
TsVector.average_slice()
TsVector.clone_expression()
TsVector.derivative()
TsVector.evaluate()
TsVector.extend()
TsVector.extend_ts()
TsVector.extract_as_table()
TsVector.forecast_merge()
TsVector.inside()
TsVector.integral()
TsVector.log()
TsVector.max()
TsVector.min()
TsVector.nash_sutcliffe()
TsVector.percentiles()
TsVector.pow()
TsVector.repeat()
TsVector.size()
TsVector.slice()
TsVector.statistics()
TsVector.sum()
TsVector.time_shift()
TsVector.transform()
TsVector.use_time_axis_from()
TsVector.value_range()
TsVector.values_at()
TsVector.values_at_time()
- Class TimeAxis
- Time series expressions
- DTSS - The Distributed Time series System
- Class DtsServer
DtsServer
DtsServer.__init__()
DtsServer.add_auth_tokens()
DtsServer.alive_connections
DtsServer.auth_needed
DtsServer.auth_tokens()
DtsServer.cache()
DtsServer.cache_max_items
DtsServer.cache_memory_target
DtsServer.cache_stats
DtsServer.cache_ts_initial_size_estimate
DtsServer.cb
DtsServer.clear()
DtsServer.clear_cache_stats()
DtsServer.close()
DtsServer.default_geo_db_config
DtsServer.default_geo_db_type
DtsServer.find_cb
DtsServer.fire_cb()
DtsServer.flush_cache()
DtsServer.flush_cache_all()
DtsServer.geo_ts_read_cb
DtsServer.geo_ts_store_cb
DtsServer.get_container_names()
DtsServer.get_geo_db_ts_info()
DtsServer.get_listening_ip()
DtsServer.get_listening_port()
DtsServer.get_max_connections()
DtsServer.graceful_close_timeout_ms
DtsServer.is_running()
DtsServer.process_messages()
DtsServer.remove_auth_tokens()
DtsServer.remove_container()
DtsServer.remove_container_cb
DtsServer.set_auto_cache()
DtsServer.set_can_remove()
DtsServer.set_container()
DtsServer.set_geo_ts_db()
DtsServer.set_listening_ip()
DtsServer.set_listening_port()
DtsServer.set_master_slave_mode()
DtsServer.set_max_connections()
DtsServer.start_async()
DtsServer.start_server()
DtsServer.start_web_api()
DtsServer.stop_server()
DtsServer.stop_web_api()
DtsServer.store_ts_cb
- Class DtsClient
DtsClient
DtsClient.__init__()
DtsClient.add_geo_ts_db()
DtsClient.auto_connect
DtsClient.cache_flush()
DtsClient.cache_stats
DtsClient.close()
DtsClient.compress_expressions
DtsClient.connections
DtsClient.evaluate()
DtsClient.find()
DtsClient.geo_evaluate()
DtsClient.geo_store()
DtsClient.get_container_names()
DtsClient.get_geo_db_ts_info()
DtsClient.get_server_version()
DtsClient.get_ts_info()
DtsClient.merge_store_ts_points()
DtsClient.percentiles()
DtsClient.q_ack()
DtsClient.q_add()
DtsClient.q_get()
DtsClient.q_list()
DtsClient.q_maintain()
DtsClient.q_msg_info()
DtsClient.q_msg_infos()
DtsClient.q_put()
DtsClient.q_remove()
DtsClient.q_size()
DtsClient.remove()
DtsClient.remove_container()
DtsClient.remove_geo_ts_db()
DtsClient.reopen()
DtsClient.set_container()
DtsClient.store_ts()
DtsClient.total_clients
- Class TsInfo
- Class CacheStats
- Class DtsServer
- Geo-location Time series
- Class GeoPoint
- Class GeoTimeSeries
- Class GeoTimeSeriesVector
- Class GeoQuery
- Class GeoSlice
- Class GeoTsMatrix
- Class GeoMatrixShape
- Class GeoGridSpec
- Class GeoEvalArgs
- Class GeoTimeSeriesConfiguration
GeoTimeSeriesConfiguration
GeoTimeSeriesConfiguration.__init__()
GeoTimeSeriesConfiguration.bounding_box()
GeoTimeSeriesConfiguration.compute()
GeoTimeSeriesConfiguration.convex_hull()
GeoTimeSeriesConfiguration.create_geo_ts_matrix()
GeoTimeSeriesConfiguration.create_ts_matrix()
GeoTimeSeriesConfiguration.description
GeoTimeSeriesConfiguration.dt
GeoTimeSeriesConfiguration.find_geo_match_ix()
GeoTimeSeriesConfiguration.grid
GeoTimeSeriesConfiguration.n_ensembles
GeoTimeSeriesConfiguration.name
GeoTimeSeriesConfiguration.prefix
GeoTimeSeriesConfiguration.t0_time_axis
GeoTimeSeriesConfiguration.t0_times
GeoTimeSeriesConfiguration.variables
- Working with time series
- Policies
- Tools
- Hydrology
- Time
Hydrology
- Installation
- Concepts
- Tutorials
- Essential api classes
- Constructing a model using the Shyft API
- Introduction
- STEP 0.1: LOAD AND PLOT TEST DATA
- STEP 0.2 - Inspect data
- STEP 1: CHOOSE A MODEL
- STEP 2: DEFINE THE MODEL DOMAIN
- STEP 3: CONFIGURE THE MODEL
- STEP 4: CONSTRUCT THE REGION MODEL
- STEP 5: FEED FORCING DATA TO THE REGION MODEL BY CONSTRUCTING A REGION ENVIRONMENT
- STEP 6: RUNNING THE MODEL
- STEP 7: EXTRACTING SIMULATION RESULTS
- STEP 8: MODEL CALIBRATION
- Exercise
- The Shyft api
- Single method point simulation
- Part 1: Nidelva simulation with Shyft API
- Introduction
- 1. Loading required python modules and setting path to Shyft installation
- 2. Configuration of a Shyft simulation
- 3. Running a Shyft simulation
- 4. Post processing and data extraction
- Visualizing the distributed catchment data
- Visualing the Snow Cover Area of all cells for a certain point in time
- Part 2: Nidelva simulation with the Shyft API
- Running a calibration with Shyft
- Configured Shyft simulations
- Shyft simulation using Repositories
- Kalman filtering on time series
- Kalman filtering on gridded data
- 1. Loading required python modules and setting path to Shyft installation
- Setup: 1. Generate synthetic data for temperature observation time-series
- Setup 2. Transform observation with bias to grid using kriging
- Setup 3. Create 3 forecasts sets for the 1x1 km grid
- grid-pp: 1. Transform forecasts from grid to observation points (IDW)
- grid-pp: 2. Calculate the bias time-series using Kalman filter on the observation set
- grid-pp: 3. Spread the bias at observation points out to the grid using kriging
- Presentation&Test: 8. Finally, Transform corrected forecasts from grid to observation points to see if we did reach the goal of adjusting the forecast (IDW)
- 9. Plot the results
- Kalman filter and choice of parameters
- Grid post-processing of Met.no data using Shyft API
- 1. Loading required python modules and setting path to Shyft installation
- 2. Create synthetic data for observation time-series
- 3. Create synthetic data for forecast time-series
- 4. Calculate correction bias between observations and forecasts
- 5. Apply bias correction to forecast time-series
- 6. Plot the results
- Penman-Monteith Sensitivity
- Penman-Monteith Single Method Verification
- Sensitivity analysis of radiation routine
- Checking calculation of Radiation at Polar Region
- Radiation algorithm on the camels data
- Examples
- API Documentation
GeoCellDataServer
GeoCellDataServer.__init__()
GeoCellDataServer.get_listening_port()
GeoCellDataServer.get_max_connections()
GeoCellDataServer.is_running()
GeoCellDataServer.set_listening_ip()
GeoCellDataServer.set_listening_port()
GeoCellDataServer.set_max_connections()
GeoCellDataServer.start_server()
GeoCellDataServer.stop_server()
GeoCellDataClient
GeoCellDataClient.__init__()
GeoCellDataClient.close()
GeoCellDataClient.get_model_infos()
GeoCellDataClient.host_port
GeoCellDataClient.is_open
GeoCellDataClient.read_model()
GeoCellDataClient.read_models()
GeoCellDataClient.reconnect_count
GeoCellDataClient.remove_model()
GeoCellDataClient.store_model()
GeoCellDataClient.timeout_ms
GeoCellDataClient.update_model_info()
GeoCellDataModel
StateServer
StateClient
StateClient.__init__()
StateClient.close()
StateClient.get_model_infos()
StateClient.host_port
StateClient.is_open
StateClient.read_model()
StateClient.read_models()
StateClient.reconnect_count
StateClient.remove_model()
StateClient.store_model()
StateClient.timeout_ms
StateClient.update_model_info()
StateModel
ParameterServer
ParameterServer.__init__()
ParameterServer.get_listening_port()
ParameterServer.get_max_connections()
ParameterServer.is_running()
ParameterServer.set_listening_ip()
ParameterServer.set_listening_port()
ParameterServer.set_max_connections()
ParameterServer.start_server()
ParameterServer.stop_server()
ParameterClient
ParameterClient.__init__()
ParameterClient.close()
ParameterClient.get_model_infos()
ParameterClient.host_port
ParameterClient.is_open
ParameterClient.read_model()
ParameterClient.read_models()
ParameterClient.reconnect_count
ParameterClient.remove_model()
ParameterClient.store_model()
ParameterClient.timeout_ms
ParameterClient.update_model_info()
ParameterModel
parse_cf_time()
np_array()
StrGeoCellData()
ARegionEnvironment
ARegionEnvironment.__init__()
ARegionEnvironment.create_from_geo_ts_matrix()
ARegionEnvironment.deserialize()
ARegionEnvironment.precipitation
ARegionEnvironment.radiation
ARegionEnvironment.rel_hum
ARegionEnvironment.serialize()
ARegionEnvironment.temperature
ARegionEnvironment.variables
ARegionEnvironment.wind_speed
ActualEvapotranspirationCalculate_step()
ActualEvapotranspirationParameter
ActualEvapotranspirationResponse
BTKParameter
CatchmentPropertyType
CellEnvironment
CellStateId
FlowAdjustResult
GammaSnowCalculator
GammaSnowParameter
GammaSnowParameter.__init__()
GammaSnowParameter.calculate_iso_pot_energy
GammaSnowParameter.effective_snow_cv()
GammaSnowParameter.fast_albedo_decay_rate
GammaSnowParameter.glacier_albedo
GammaSnowParameter.initial_bare_ground_fraction
GammaSnowParameter.is_snow_season()
GammaSnowParameter.is_start_melt_season()
GammaSnowParameter.max_albedo
GammaSnowParameter.max_water
GammaSnowParameter.min_albedo
GammaSnowParameter.n_winter_days
GammaSnowParameter.slow_albedo_decay_rate
GammaSnowParameter.snow_cv
GammaSnowParameter.snow_cv_altitude_factor
GammaSnowParameter.snow_cv_forest_factor
GammaSnowParameter.snowfall_reset_depth
GammaSnowParameter.surface_magnitude
GammaSnowParameter.tx
GammaSnowParameter.wind_const
GammaSnowParameter.wind_scale
GammaSnowParameter.winter_end_day_of_year
GammaSnowResponse
GammaSnowState
GeoCellData
GeoCellData.__init__()
GeoCellData.area()
GeoCellData.aspect()
GeoCellData.catchment_id()
GeoCellData.epsg_id
GeoCellData.land_type_fractions_info()
GeoCellData.mid_point()
GeoCellData.radiation_slope_factor()
GeoCellData.routing_info
GeoCellData.set_catchment_id()
GeoCellData.set_land_type_fractions()
GeoCellData.set_tin_data()
GeoCellData.slope()
GeoCellData.surface_area()
GeoCellData.vertexes()
GeoCellDataVector
GeoPointSource
GeoPointSourceVector
GlacierMeltParameter
HbvActualEvapotranspirationParameter
HbvActualEvapotranspirationResponse
HbvActualEvapotranspirationCalculate_step()
HbvPhysicalSnowCalculator
HbvPhysicalSnowParameter
HbvPhysicalSnowParameter.__init__()
HbvPhysicalSnowParameter.calculate_iso_pot_energy
HbvPhysicalSnowParameter.cfr
HbvPhysicalSnowParameter.fast_albedo_decay_rate
HbvPhysicalSnowParameter.intervals
HbvPhysicalSnowParameter.lw
HbvPhysicalSnowParameter.max_albedo
HbvPhysicalSnowParameter.min_albedo
HbvPhysicalSnowParameter.s
HbvPhysicalSnowParameter.set_snow_quantiles()
HbvPhysicalSnowParameter.set_snow_redistribution_factors()
HbvPhysicalSnowParameter.slow_albedo_decay_rate
HbvPhysicalSnowParameter.snowfall_reset_depth
HbvPhysicalSnowParameter.surface_magnitude
HbvPhysicalSnowParameter.tx
HbvPhysicalSnowParameter.wind_const
HbvPhysicalSnowParameter.wind_scale
HbvPhysicalSnowResponse
HbvPhysicalSnowState
HbvSnowCalculator
HbvSnowParameter
HbvSnowResponse
HbvSnowState
HbvSoilCalculator
HbvSoilParameter
HbvSoilResponse
HbvSoilState
HbvTankCalculator
HbvTankParameter
HbvTankResponse
HbvTankState
SnowTilesParameter
IDWParameter
IDWPrecipitationParameter
IDWTemperatureParameter
InterpolationParameter
KalmanBiasPredictor
KalmanBiasPredictor.__init__()
KalmanBiasPredictor.compute_running_bias()
KalmanBiasPredictor.compute_running_bias_ts()
KalmanBiasPredictor.filter
KalmanBiasPredictor.state
KalmanBiasPredictor.update_with_forecast()
KalmanBiasPredictor.update_with_forecast_vector()
KalmanBiasPredictor.update_with_geo_forecast()
KalmanFilter
KalmanParameter
KalmanState
KirchnerCalculator
KirchnerParameter
KirchnerResponse
KirchnerState
LandTypeFractions
MethodStackParameter
OKCovarianceType
OKParameter
PenmanMonteithCalculator
PenmanMonteithParameter
PenmanMonteithResponse
PrecipitationCorrectionCalculator
PrecipitationCorrectionParameter
PrecipitationSource
PrecipitationSourceVector
PriestleyTaylorCalculator
PriestleyTaylorParameter
PriestleyTaylorResponse
RadiationCalculator
RadiationParameter
RadiationResponse
RadiationSource
RadiationSourceVector
RelHumSource
RelHumSourceVector
River
RiverNetwork
RoutingInfo
SkaugenCalculator
SkaugenParameter
SkaugenResponse
SkaugenState
TargetSpecCalcType
TargetSpecificationPts
TargetSpecificationPts.__init__()
TargetSpecificationPts.calc_mode
TargetSpecificationPts.catchment_indexes
TargetSpecificationPts.catchment_property
TargetSpecificationPts.river_id
TargetSpecificationPts.s_a
TargetSpecificationPts.s_b
TargetSpecificationPts.s_r
TargetSpecificationPts.scale_factor
TargetSpecificationPts.ts
TargetSpecificationPts.uid
TargetSpecificationVector
TemperatureSource
TemperatureSourceVector
TsTransform
UHGParameter
WindSpeedSource
WindSpeedSourceVector
bayesian_kriging_temperature()
compute_geo_ts_values_at_time()
create_precipitation_source_vector_from_np_array()
create_radiation_source_vector_from_np_array()
create_rel_hum_source_vector_from_np_array()
create_temperature_source_vector_from_np_array()
create_wind_speed_source_vector_from_np_array()
glacier_melt_step()
idw_precipitation()
idw_radiation()
idw_relative_humidity()
idw_temperature()
idw_wind_speed()
make_uhg_from_gamma()
ordinary_kriging()
stat_scope
version()
CalibrationOption
CalibrationOption.__init__()
CalibrationOption.bobyqa()
CalibrationOption.dream()
CalibrationOption.global_search()
CalibrationOption.max_iterations
CalibrationOption.method
CalibrationOption.sceua()
CalibrationOption.solver_epsilon
CalibrationOption.time_limit
CalibrationOption.tr_start
CalibrationOption.tr_stop
CalibrationOption.x_epsilon
CalibrationOption.y_epsilon
OptimizerMethod
CalibrationStatus
ParameterOptimizer
DrmClient
DrmClient.__init__()
DrmClient.adjust_q()
DrmClient.cancel_calibration()
DrmClient.check_calibration()
DrmClient.clone_model()
DrmClient.close()
DrmClient.copy_model()
DrmClient.create_model()
DrmClient.fx()
DrmClient.get_catchment_parameter()
DrmClient.get_charge()
DrmClient.get_description()
DrmClient.get_discharge()
DrmClient.get_geo_cell_data()
DrmClient.get_interpolation_parameter()
DrmClient.get_model_ids()
DrmClient.get_precipitation()
DrmClient.get_radiation()
DrmClient.get_region_env()
DrmClient.get_region_parameter()
DrmClient.get_rel_hum()
DrmClient.get_server_version()
DrmClient.get_snow_sca()
DrmClient.get_snow_swe()
DrmClient.get_state()
DrmClient.get_temperature()
DrmClient.get_time_axis()
DrmClient.get_wind_speed()
DrmClient.has_catchment_parameter()
DrmClient.host_port
DrmClient.is_calculated()
DrmClient.is_cell_env_ts_ok()
DrmClient.is_open
DrmClient.reconnect_count
DrmClient.remove_catchment_parameter()
DrmClient.remove_model()
DrmClient.rename_model()
DrmClient.revert_to_initial_state()
DrmClient.run_cells()
DrmClient.run_interpolation()
DrmClient.set_catchment_calculation_filter()
DrmClient.set_catchment_parameter()
DrmClient.set_cell_environment()
DrmClient.set_current_state_as_initial_state()
DrmClient.set_description()
DrmClient.set_region_parameter()
DrmClient.set_snow_sca_swe_collection()
DrmClient.set_state()
DrmClient.set_state_collection()
DrmClient.start_calibration()
DrmClient.timeout_ms
DrmClient.total_clients
DrmServer
DrmServer.__init__()
DrmServer.alive_connections
DrmServer.fx
DrmServer.get_listening_port()
DrmServer.get_max_connections()
DrmServer.get_model()
DrmServer.get_model_ids()
DrmServer.is_running()
DrmServer.set_listening_ip()
DrmServer.set_listening_port()
DrmServer.set_max_connections()
DrmServer.start_server()
DrmServer.stop_server()
RegionModelType
RegionModelType.PT_GS_K
RegionModelType.PT_GS_K_OPT
RegionModelType.PT_HPS_K
RegionModelType.PT_HPS_K_OPT
RegionModelType.PT_HS_K
RegionModelType.PT_HS_K_OPT
RegionModelType.PT_SS_K
RegionModelType.PT_SS_K_OPT
RegionModelType.PT_ST_HBV
RegionModelType.PT_ST_K
RegionModelType.PT_ST_K_HBV
RegionModelType.PT_ST_K_OPT
RegionModelType.R_PM_GS_K
RegionModelType.R_PM_GS_K_OPT
RegionModelType.R_PT_GS_K
RegionModelType.R_PT_GS_K_OPT
RegionModelType.names
RegionModelType.values
SnowTilesState
SnowTilesCalculator
SnowTilesResponse
percentiles()
Energy Market
- Installation
- Concepts
- Tutorials
- Examples
- API Documentation
- Core
Catchment
CatchmentList
Client
ConnectionRole
Gate
GateList
HydroComponent
HydroComponentList
HydroConnection
HydroConnectionList
HydroGraphTraversal
HydroPowerSystem
HydroPowerSystem.__init__()
HydroPowerSystem.aggregates
HydroPowerSystem.catchments
HydroPowerSystem.create_aggregate()
HydroPowerSystem.create_catchment()
HydroPowerSystem.create_gate()
HydroPowerSystem.create_power_plant()
HydroPowerSystem.create_power_station()
HydroPowerSystem.create_reservoir()
HydroPowerSystem.create_river()
HydroPowerSystem.create_tunnel()
HydroPowerSystem.create_unit()
HydroPowerSystem.created
HydroPowerSystem.equal_content()
HydroPowerSystem.equal_structure()
HydroPowerSystem.find_aggregate_by_id()
HydroPowerSystem.find_aggregate_by_name()
HydroPowerSystem.find_gate_by_id()
HydroPowerSystem.find_gate_by_name()
HydroPowerSystem.find_power_plant_by_id()
HydroPowerSystem.find_power_plant_by_name()
HydroPowerSystem.find_power_station_by_id()
HydroPowerSystem.find_power_station_by_name()
HydroPowerSystem.find_reservoir_by_id()
HydroPowerSystem.find_reservoir_by_name()
HydroPowerSystem.find_unit_by_id()
HydroPowerSystem.find_unit_by_name()
HydroPowerSystem.find_water_route_by_id()
HydroPowerSystem.find_water_route_by_name()
HydroPowerSystem.find_waterway_by_id()
HydroPowerSystem.find_waterway_by_name()
HydroPowerSystem.from_blob()
HydroPowerSystem.gates
HydroPowerSystem.id
HydroPowerSystem.model_area
HydroPowerSystem.name
HydroPowerSystem.obj
HydroPowerSystem.power_plants
HydroPowerSystem.power_stations
HydroPowerSystem.reservoirs
HydroPowerSystem.to_blob()
HydroPowerSystem.to_blob_ref()
HydroPowerSystem.units
HydroPowerSystem.water_routes
HydroPowerSystem.waterways
HydroPowerSystemBuilder
HydroPowerSystemBuilder.__init__()
HydroPowerSystemBuilder.create_aggregate()
HydroPowerSystemBuilder.create_catchment()
HydroPowerSystemBuilder.create_gate()
HydroPowerSystemBuilder.create_power_plant()
HydroPowerSystemBuilder.create_power_station()
HydroPowerSystemBuilder.create_reservoir()
HydroPowerSystemBuilder.create_river()
HydroPowerSystemBuilder.create_tunnel()
HydroPowerSystemBuilder.create_unit()
HydroPowerSystemBuilder.create_water_route()
HydroPowerSystemBuilder.create_waterway()
HydroPowerSystemDict
HydroPowerSystemList
IntStringDict
StringTimeSeriesDict
Model
ModelArea
ModelAreaDict
ModelBuilder
ModelInfo
ModelInfoVector
ModelList
Point
PointList
PowerLine
PowerLineList
PowerModule
PowerModuleDict
PowerPlant
PowerPlantList
Reservoir
ReservoirList
Run
RunClient
RunServer
RunVector
Server
TurbineCapability
TurbineDescription
TurbineOperatingZone
TurbineOperatingZoneList
Unit
UnitList
Waterway
WaterwayList
XyPointCurve
XyPointCurveList
XyPointCurveWithZ
XyPointCurveWithZList
XyPointCurveWithZList.__init__()
XyPointCurveWithZList.append()
XyPointCurveWithZList.evaluate()
XyPointCurveWithZList.extend()
XyPointCurveWithZList.x_max()
XyPointCurveWithZList.x_min()
XyPointCurveWithZList.y_max()
XyPointCurveWithZList.y_min()
XyPointCurveWithZList.z_max()
XyPointCurveWithZList.z_min()
XyzPointCurve
compressed_size()
points_from_x_y()
run_state
downstream_reservoirs()
downstream_units()
upstream_reservoirs()
upstream_units()
has_forward_capability()
has_backward_capability()
has_reversible_capability()
- STM
HydroPowerSystem
HydroPowerSystem.__init__()
HydroPowerSystem.create_aggregate()
HydroPowerSystem.create_gate()
HydroPowerSystem.create_power_plant()
HydroPowerSystem.create_power_station()
HydroPowerSystem.create_reservoir()
HydroPowerSystem.create_reservoir_aggregate()
HydroPowerSystem.create_river()
HydroPowerSystem.create_tunnel()
HydroPowerSystem.create_unit()
HydroPowerSystem.create_water_route()
HydroPowerSystem.create_waterway()
HydroPowerSystem.find_catchment_by_id()
HydroPowerSystem.find_catchment_by_name()
HydroPowerSystem.find_gate_by_id()
HydroPowerSystem.find_gate_by_name()
HydroPowerSystem.find_power_plant_by_id()
HydroPowerSystem.find_power_plant_by_name()
HydroPowerSystem.find_reservoir_aggregate_by_id()
HydroPowerSystem.find_reservoir_aggregate_by_name()
HydroPowerSystem.find_reservoir_by_id()
HydroPowerSystem.find_reservoir_by_name()
HydroPowerSystem.find_unit_by_id()
HydroPowerSystem.find_unit_by_name()
HydroPowerSystem.find_waterway_by_id()
HydroPowerSystem.find_waterway_by_name()
HydroPowerSystem.from_blob()
HydroPowerSystem.reservoir_aggregates
HydroPowerSystem.to_blob()
HydroPowerSystemList
StmSystem
StmSystem.__init__()
StmSystem.add_unit_group()
StmSystem.contract_portfolios
StmSystem.contracts
StmSystem.create_market_area()
StmSystem.create_network()
StmSystem.create_power_module()
StmSystem.create_wind_farm()
StmSystem.from_blob()
StmSystem.hydro_power_systems
StmSystem.id
StmSystem.json
StmSystem.market_areas
StmSystem.name
StmSystem.networks
StmSystem.patch()
StmSystem.power_modules
StmSystem.result_ts_urls()
StmSystem.run_parameters
StmSystem.summary
StmSystem.to_blob()
StmSystem.unit_groups
StmSystem.wind_farms
StmSystemList
StmPatchOperation
MarketArea
MarketArea.TsTripletResult
MarketArea.__init__()
MarketArea.busbars
MarketArea.buy
MarketArea.contracts
MarketArea.create_busbar_derived_unit_group()
MarketArea.custom
MarketArea.demand
MarketArea.flattened_attributes()
MarketArea.get_consumption()
MarketArea.get_export()
MarketArea.get_import()
MarketArea.get_production()
MarketArea.get_tsm_object()
MarketArea.id
MarketArea.json
MarketArea.load
MarketArea.max_buy
MarketArea.max_sale
MarketArea.name
MarketArea.price
MarketArea.production
MarketArea.remove_unit_group()
MarketArea.reserve_obligation_penalty
MarketArea.sale
MarketArea.supply
MarketArea.tag
MarketArea.transmission_lines_from()
MarketArea.transmission_lines_to()
MarketArea.ts
MarketArea.unit_group
ModelState
Unit
Unit.__init__()
Unit.best_profit
Unit.cost
Unit.custom
Unit.discharge
Unit.effective_head
Unit.flattened_attributes()
Unit.generator_description
Unit.get_tsm_object()
Unit.priority
Unit.production
Unit.production_discharge_relation
Unit.pump_constraint
Unit.pump_description
Unit.pump_unavailability
Unit.reserve
Unit.tag
Unit.ts
Unit.turbine_description
Unit.unavailability
UnitList
Reservoir
PowerPlant
PowerPlant.__init__()
PowerPlant.add_unit()
PowerPlant.best_profit
PowerPlant.custom
PowerPlant.discharge
PowerPlant.fees
PowerPlant.flattened_attributes()
PowerPlant.get_tsm_object()
PowerPlant.gross_head
PowerPlant.mip
PowerPlant.outlet_level
PowerPlant.production
PowerPlant.tag
PowerPlant.ts
PowerPlant.unavailability
Gate
Waterway
UnitGroupType
UnitGroupType.AFRR_DOWN
UnitGroupType.AFRR_UP
UnitGroupType.COMMIT
UnitGroupType.FCR_D_DOWN
UnitGroupType.FCR_D_UP
UnitGroupType.FCR_N_DOWN
UnitGroupType.FCR_N_UP
UnitGroupType.FFR
UnitGroupType.MFRR_DOWN
UnitGroupType.MFRR_UP
UnitGroupType.PRODUCTION
UnitGroupType.RR_DOWN
UnitGroupType.RR_UP
UnitGroupType.UNSPECIFIED
UnitGroupType.names
UnitGroupType.values
UnitGroup
UnitGroup.__init__()
UnitGroup.add_unit()
UnitGroup.custom
UnitGroup.delivery
UnitGroup.flattened_attributes()
UnitGroup.flow
UnitGroup.get_tsm_object()
UnitGroup.group_type
UnitGroup.id
UnitGroup.json
UnitGroup.market_area
UnitGroup.members
UnitGroup.name
UnitGroup.obj
UnitGroup.obligation
UnitGroup.production
UnitGroup.remove_unit()
UnitGroup.tag
UnitGroup.ts
t_xy
t_turbine_description
MessageList
t_xyz_list
t_xyz
DStmClient
DStmClient.__init__()
DStmClient.add_compute_server()
DStmClient.add_model()
DStmClient.clone_model()
DStmClient.close()
DStmClient.compute_server_status()
DStmClient.create_model()
DStmClient.evaluate_model()
DStmClient.evaluate_ts()
DStmClient.fx()
DStmClient.get_attrs()
DStmClient.get_log()
DStmClient.get_model()
DStmClient.get_model_ids()
DStmClient.get_model_infos()
DStmClient.get_optimization_summary()
DStmClient.get_server_version()
DStmClient.get_state()
DStmClient.get_ts()
DStmClient.host_port
DStmClient.is_open
DStmClient.kill_optimization()
DStmClient.optimize()
DStmClient.patch()
DStmClient.reconnect_count
DStmClient.remove_model()
DStmClient.rename_model()
DStmClient.reset_model()
DStmClient.set_attrs()
DStmClient.set_ts()
DStmClient.start_tune()
DStmClient.stop_tune()
DStmClient.timeout_ms
DStmClient.tune()
DStmServer
DStmServer.__init__()
DStmServer.add_compute_server()
DStmServer.add_container()
DStmServer.apply()
DStmServer.cache_max_items
DStmServer.cache_memory_target
DStmServer.cache_stats
DStmServer.cache_ts_initial_size_estimate
DStmServer.clear_cache_stats()
DStmServer.close()
DStmServer.do_add_model()
DStmServer.do_clone_model()
DStmServer.do_create_model()
DStmServer.do_evaluate_model()
DStmServer.do_get_model_ids()
DStmServer.do_get_model_infos()
DStmServer.do_get_state()
DStmServer.do_get_version_info()
DStmServer.do_optimize()
DStmServer.do_remove_model()
DStmServer.do_rename_model()
DStmServer.flush_cache()
DStmServer.flush_cache_all()
DStmServer.fx
DStmServer.get_listening_ip()
DStmServer.get_listening_port()
DStmServer.get_web_api_ip()
DStmServer.get_web_api_port()
DStmServer.is_running()
DStmServer.notify_change()
DStmServer.set_listening_ip()
DStmServer.set_listening_port()
DStmServer.set_master_slave_mode()
DStmServer.shared_lock_timeout
DStmServer.start_server()
DStmServer.start_web_api()
DStmServer.stop_server()
DStmServer.stop_web_api()
HpsClient
HpsServer
StmClient
StmServer
StmTaskServer
StmTaskServer.__init__()
StmTaskServer.add_auth_tokens()
StmTaskServer.auth_needed
StmTaskServer.auth_tokens()
StmTaskServer.fx
StmTaskServer.get_listening_port()
StmTaskServer.get_max_connections()
StmTaskServer.is_running()
StmTaskServer.remove_auth_tokens()
StmTaskServer.set_listening_ip()
StmTaskServer.set_listening_port()
StmTaskServer.set_max_connections()
StmTaskServer.start_server()
StmTaskServer.start_web_api()
StmTaskServer.stop_server()
StmTaskServer.stop_web_api()
StmTaskClient
StmTaskClient.__init__()
StmTaskClient.add_case()
StmTaskClient.add_model_ref()
StmTaskClient.close()
StmTaskClient.fx()
StmTaskClient.get_case()
StmTaskClient.get_model_infos()
StmTaskClient.get_model_ref()
StmTaskClient.host_port
StmTaskClient.is_open
StmTaskClient.read_model()
StmTaskClient.read_models()
StmTaskClient.reconnect_count
StmTaskClient.remove_case()
StmTaskClient.remove_model()
StmTaskClient.remove_model_ref()
StmTaskClient.store_model()
StmTaskClient.timeout_ms
StmTaskClient.update_case()
StmTaskClient.update_model_info()
StmCase
ModelRefList
StmModelRef
StmTask
Contract
Contract.__init__()
Contract.active
Contract.add_relation()
Contract.add_to_market_area()
Contract.add_to_portfolio()
Contract.buyer
Contract.constraint
Contract.custom
Contract.fee
Contract.find_related_to_this()
Contract.flattened_attributes()
Contract.get_market_areas()
Contract.get_portfolios()
Contract.get_tsm_object()
Contract.id
Contract.json
Contract.name
Contract.options
Contract.parent_id
Contract.power_plants
Contract.price
Contract.quantity
Contract.relations
Contract.remove_relation()
Contract.revenue
Contract.seller
Contract.tag
Contract.ts
Contract.validation
ContractList
ContractPortfolio
ContractPortfolio.__init__()
ContractPortfolio.contracts
ContractPortfolio.custom
ContractPortfolio.fee
ContractPortfolio.flattened_attributes()
ContractPortfolio.get_tsm_object()
ContractPortfolio.id
ContractPortfolio.json
ContractPortfolio.name
ContractPortfolio.quantity
ContractPortfolio.revenue
ContractPortfolio.tag
ContractPortfolio.ts
ContractPortfolioList
PowerModule
Busbar
Busbar.__init__()
Busbar.add_power_module()
Busbar.add_to_end_of_transmission_line()
Busbar.add_to_market_area()
Busbar.add_to_start_of_transmission_line()
Busbar.add_unit()
Busbar.add_wind_farm()
Busbar.custom
Busbar.flattened_attributes()
Busbar.flow
Busbar.get_market_areas()
Busbar.get_transmission_lines_from_busbar()
Busbar.get_transmission_lines_to_busbar()
Busbar.get_tsm_object()
Busbar.id
Busbar.json
Busbar.name
Busbar.power_modules
Busbar.price
Busbar.remove_power_module()
Busbar.remove_unit()
Busbar.remove_wind_farm()
Busbar.tag
Busbar.ts
Busbar.units
Busbar.wind_farms
Network
TransmissionLine
TransmissionLine.__init__()
TransmissionLine.capacity
TransmissionLine.custom
TransmissionLine.flattened_attributes()
TransmissionLine.from_bb
TransmissionLine.get_tsm_object()
TransmissionLine.id
TransmissionLine.json
TransmissionLine.name
TransmissionLine.tag
TransmissionLine.to_bb
TransmissionLine.ts
WindFarm
compute_effective_price()
UrlResolveError
- STM Compute and Shop
- STM Shop
ShopCommand
ShopCommand.__init__()
ShopCommand.keyword
ShopCommand.log_file()
ShopCommand.log_file_lp()
ShopCommand.objects
ShopCommand.options
ShopCommand.penalty_cost_all()
ShopCommand.penalty_cost_discharge()
ShopCommand.penalty_cost_gate_ramping()
ShopCommand.penalty_cost_load()
ShopCommand.penalty_cost_overflow()
ShopCommand.penalty_cost_overflow_time_adjust()
ShopCommand.penalty_cost_powerlimit()
ShopCommand.penalty_cost_reserve()
ShopCommand.penalty_cost_reservoir_endpoint()
ShopCommand.penalty_cost_reservoir_ramping()
ShopCommand.penalty_cost_soft_p_penalty()
ShopCommand.penalty_cost_soft_q_penalty()
ShopCommand.penalty_flag_all()
ShopCommand.penalty_flag_discharge()
ShopCommand.penalty_flag_gate_max_q_con()
ShopCommand.penalty_flag_gate_min_q_con()
ShopCommand.penalty_flag_gate_ramping()
ShopCommand.penalty_flag_load()
ShopCommand.penalty_flag_plant_max_p_con()
ShopCommand.penalty_flag_plant_max_q_con()
ShopCommand.penalty_flag_plant_min_p_con()
ShopCommand.penalty_flag_plant_min_q_con()
ShopCommand.penalty_flag_plant_schedule()
ShopCommand.penalty_flag_powerlimit()
ShopCommand.penalty_flag_reservoir_endpoint()
ShopCommand.penalty_flag_reservoir_ramping()
ShopCommand.print_bp_curves()
ShopCommand.print_bp_curves_all_combinations()
ShopCommand.print_bp_curves_current_combination()
ShopCommand.print_bp_curves_discharge()
ShopCommand.print_bp_curves_dyn_points()
ShopCommand.print_bp_curves_from_zero()
ShopCommand.print_bp_curves_market_ref_mc()
ShopCommand.print_bp_curves_mc_format()
ShopCommand.print_bp_curves_no_vertical_step()
ShopCommand.print_bp_curves_old_points()
ShopCommand.print_bp_curves_operation()
ShopCommand.print_bp_curves_production()
ShopCommand.print_mc_curves()
ShopCommand.print_mc_curves_down()
ShopCommand.print_mc_curves_down_mod()
ShopCommand.print_mc_curves_down_pq()
ShopCommand.print_mc_curves_down_pq_mod()
ShopCommand.print_mc_curves_mod()
ShopCommand.print_mc_curves_pq()
ShopCommand.print_mc_curves_pq_mod()
ShopCommand.print_mc_curves_up()
ShopCommand.print_mc_curves_up_down()
ShopCommand.print_mc_curves_up_down_mod()
ShopCommand.print_mc_curves_up_down_pq()
ShopCommand.print_mc_curves_up_down_pq_mod()
ShopCommand.print_mc_curves_up_mod()
ShopCommand.print_mc_curves_up_pq()
ShopCommand.print_mc_curves_up_pq_mod()
ShopCommand.print_model()
ShopCommand.print_pqcurves_all()
ShopCommand.print_pqcurves_convex()
ShopCommand.print_pqcurves_final()
ShopCommand.print_pqcurves_original()
ShopCommand.return_scenario_result_table()
ShopCommand.return_shopsimres()
ShopCommand.return_shopsimres_gen()
ShopCommand.return_simres()
ShopCommand.return_simres_gen()
ShopCommand.save_pq_curves()
ShopCommand.save_series()
ShopCommand.save_shopsimseries()
ShopCommand.save_tunnelloss()
ShopCommand.save_xmlseries()
ShopCommand.save_xmlshopsimseries()
ShopCommand.set_bypass_loss()
ShopCommand.set_capacity_all()
ShopCommand.set_capacity_bypass()
ShopCommand.set_capacity_gate()
ShopCommand.set_capacity_spill()
ShopCommand.set_code_full()
ShopCommand.set_code_head()
ShopCommand.set_code_incremental()
ShopCommand.set_com_dec_period()
ShopCommand.set_droop_discretization_limit()
ShopCommand.set_dyn_flex_mip()
ShopCommand.set_dyn_seg_incr()
ShopCommand.set_dyn_seg_mip()
ShopCommand.set_dyn_seg_on()
ShopCommand.set_fcr_d_band()
ShopCommand.set_fcr_n_band()
ShopCommand.set_fcr_n_equality()
ShopCommand.set_gen_turn_off_limit()
ShopCommand.set_headopt_feedback()
ShopCommand.set_max_num_threads()
ShopCommand.set_merge_off()
ShopCommand.set_merge_on()
ShopCommand.set_merge_stop()
ShopCommand.set_method_baropt()
ShopCommand.set_method_dual()
ShopCommand.set_method_hydbaropt()
ShopCommand.set_method_netdual()
ShopCommand.set_method_netprimal()
ShopCommand.set_method_primal()
ShopCommand.set_mipgap()
ShopCommand.set_newgate()
ShopCommand.set_nseg_all()
ShopCommand.set_nseg_down()
ShopCommand.set_nseg_up()
ShopCommand.set_parallel_mode_auto()
ShopCommand.set_parallel_mode_deterministic()
ShopCommand.set_parallel_mode_opportunistic()
ShopCommand.set_password()
ShopCommand.set_power_head_optimization()
ShopCommand.set_prod_from_ref_prod()
ShopCommand.set_ramping()
ShopCommand.set_reserve_ramping_cost()
ShopCommand.set_reserve_slack_cost()
ShopCommand.set_time_delay_unit_hour()
ShopCommand.set_time_delay_unit_minute()
ShopCommand.set_time_delay_unit_time_step_length()
ShopCommand.set_timelimit()
ShopCommand.set_universal_mip_not_set()
ShopCommand.set_universal_mip_off()
ShopCommand.set_universal_mip_on()
ShopCommand.set_xmllog()
ShopCommand.specifier
ShopCommand.start_shopsim()
ShopCommand.start_sim()
ShopCommandList
ShopSystem
ShopSystem.__init__()
ShopSystem.collect()
ShopSystem.command_raw()
ShopSystem.commander
ShopSystem.complete()
ShopSystem.emit()
ShopSystem.environment()
ShopSystem.environment_string()
ShopSystem.export_data()
ShopSystem.export_data_string()
ShopSystem.export_topology()
ShopSystem.export_topology_string()
ShopSystem.export_yaml_string()
ShopSystem.get_executed_commands_raw()
ShopSystem.get_log_buffer()
ShopSystem.get_version_info()
ShopSystem.optimize()
ShopSystem.optimize2()
ShopSystem.set_logging_to_files()
ShopSystem.set_logging_to_stdstreams()
ShopCommander
ShopCommander.__init__()
ShopCommander.execute()
ShopCommander.execute_string()
ShopCommander.executed()
ShopCommander.executed_strings()
ShopCommander.log_file()
ShopCommander.log_file_lp()
ShopCommander.penalty_cost_all()
ShopCommander.penalty_cost_discharge()
ShopCommander.penalty_cost_gate_ramping()
ShopCommander.penalty_cost_load()
ShopCommander.penalty_cost_overflow()
ShopCommander.penalty_cost_overflow_time_adjust()
ShopCommander.penalty_cost_powerlimit()
ShopCommander.penalty_cost_reserve()
ShopCommander.penalty_cost_reservoir_endpoint()
ShopCommander.penalty_cost_reservoir_ramping()
ShopCommander.penalty_cost_soft_p_penalty()
ShopCommander.penalty_cost_soft_q_penalty()
ShopCommander.penalty_flag_all()
ShopCommander.penalty_flag_discharge()
ShopCommander.penalty_flag_gate_max_q_con()
ShopCommander.penalty_flag_gate_min_q_con()
ShopCommander.penalty_flag_gate_ramping()
ShopCommander.penalty_flag_load()
ShopCommander.penalty_flag_plant_max_p_con()
ShopCommander.penalty_flag_plant_max_q_con()
ShopCommander.penalty_flag_plant_min_p_con()
ShopCommander.penalty_flag_plant_min_q_con()
ShopCommander.penalty_flag_plant_schedule()
ShopCommander.penalty_flag_powerlimit()
ShopCommander.penalty_flag_reservoir_endpoint()
ShopCommander.penalty_flag_reservoir_ramping()
ShopCommander.print_bp_curves()
ShopCommander.print_bp_curves_all_combinations()
ShopCommander.print_bp_curves_current_combination()
ShopCommander.print_bp_curves_discharge()
ShopCommander.print_bp_curves_dyn_points()
ShopCommander.print_bp_curves_from_zero()
ShopCommander.print_bp_curves_market_ref_mc()
ShopCommander.print_bp_curves_mc_format()
ShopCommander.print_bp_curves_no_vertical_step()
ShopCommander.print_bp_curves_old_points()
ShopCommander.print_bp_curves_operation()
ShopCommander.print_bp_curves_production()
ShopCommander.print_mc_curves()
ShopCommander.print_mc_curves_down()
ShopCommander.print_mc_curves_down_mod()
ShopCommander.print_mc_curves_down_pq()
ShopCommander.print_mc_curves_down_pq_mod()
ShopCommander.print_mc_curves_mod()
ShopCommander.print_mc_curves_pq()
ShopCommander.print_mc_curves_pq_mod()
ShopCommander.print_mc_curves_up()
ShopCommander.print_mc_curves_up_down()
ShopCommander.print_mc_curves_up_down_mod()
ShopCommander.print_mc_curves_up_down_pq()
ShopCommander.print_mc_curves_up_down_pq_mod()
ShopCommander.print_mc_curves_up_mod()
ShopCommander.print_mc_curves_up_pq()
ShopCommander.print_mc_curves_up_pq_mod()
ShopCommander.print_model()
ShopCommander.print_pqcurves_all()
ShopCommander.print_pqcurves_convex()
ShopCommander.print_pqcurves_final()
ShopCommander.print_pqcurves_original()
ShopCommander.return_scenario_result_table()
ShopCommander.return_shopsimres()
ShopCommander.return_shopsimres_gen()
ShopCommander.return_simres()
ShopCommander.return_simres_gen()
ShopCommander.save_pq_curves()
ShopCommander.save_series()
ShopCommander.save_shopsimseries()
ShopCommander.save_tunnelloss()
ShopCommander.save_xmlseries()
ShopCommander.save_xmlshopsimseries()
ShopCommander.set_bypass_loss()
ShopCommander.set_capacity_all()
ShopCommander.set_capacity_bypass()
ShopCommander.set_capacity_gate()
ShopCommander.set_capacity_spill()
ShopCommander.set_code_full()
ShopCommander.set_code_head()
ShopCommander.set_code_incremental()
ShopCommander.set_com_dec_period()
ShopCommander.set_droop_discretization_limit()
ShopCommander.set_dyn_flex_mip()
ShopCommander.set_dyn_seg_incr()
ShopCommander.set_dyn_seg_mip()
ShopCommander.set_dyn_seg_on()
ShopCommander.set_fcr_d_band()
ShopCommander.set_fcr_n_band()
ShopCommander.set_fcr_n_equality()
ShopCommander.set_gen_turn_off_limit()
ShopCommander.set_headopt_feedback()
ShopCommander.set_max_num_threads()
ShopCommander.set_merge_off()
ShopCommander.set_merge_on()
ShopCommander.set_merge_stop()
ShopCommander.set_method_baropt()
ShopCommander.set_method_dual()
ShopCommander.set_method_hydbaropt()
ShopCommander.set_method_netdual()
ShopCommander.set_method_netprimal()
ShopCommander.set_method_primal()
ShopCommander.set_mipgap()
ShopCommander.set_newgate()
ShopCommander.set_nseg_all()
ShopCommander.set_nseg_down()
ShopCommander.set_nseg_up()
ShopCommander.set_parallel_mode_auto()
ShopCommander.set_parallel_mode_deterministic()
ShopCommander.set_parallel_mode_opportunistic()
ShopCommander.set_password()
ShopCommander.set_power_head_optimization()
ShopCommander.set_prod_from_ref_prod()
ShopCommander.set_ramping()
ShopCommander.set_reserve_ramping_cost()
ShopCommander.set_reserve_slack_cost()
ShopCommander.set_time_delay_unit_hour()
ShopCommander.set_time_delay_unit_minute()
ShopCommander.set_time_delay_unit_time_step_length()
ShopCommander.set_timelimit()
ShopCommander.set_universal_mip_not_set()
ShopCommander.set_universal_mip_off()
ShopCommander.set_universal_mip_on()
ShopCommander.set_xmllog()
ShopCommander.start_shopsim()
ShopCommander.start_sim()
- Service
- UI
print_versions()
export()
export_print()
ItemDataProperty
LayoutInfo
LayoutServer
LayoutServer.__init__()
LayoutServer.add_auth_tokens()
LayoutServer.auth_needed
LayoutServer.auth_tokens()
LayoutServer.fx
LayoutServer.get_listening_port()
LayoutServer.get_max_connections()
LayoutServer.is_running()
LayoutServer.remove_auth_tokens()
LayoutServer.set_listening_ip()
LayoutServer.set_listening_port()
LayoutServer.set_max_connections()
LayoutServer.start_server()
LayoutServer.start_web_api()
LayoutServer.stop_server()
LayoutServer.stop_web_api()
LayoutClient
LayoutClient.__init__()
LayoutClient.close()
LayoutClient.get_model_infos()
LayoutClient.host_port
LayoutClient.is_open
LayoutClient.read_model()
LayoutClient.read_model_with_args()
LayoutClient.read_models()
LayoutClient.reconnect_count
LayoutClient.remove_model()
LayoutClient.store_model()
LayoutClient.timeout_ms
LayoutClient.update_model_info()
- Core
Dashboard
- Installation
- Concepts
- Tutorials
- Examples
- shyft.dashboard.examples
- shyft.dashboard.examples
- shyft.dashboard.examples.app
- shyft.dashboard.examples.basic_bokeh_app
- shyft.dashboard.examples.date_selector
- shyft.dashboard.examples.figure_legend
- shyft.dashboard.examples.gates
- shyft.dashboard.examples.hover_tool
- shyft.dashboard.examples.label_selector
- shyft.dashboard.examples.message_viewer
- shyft.dashboard.examples.multi_select_tabs
- shyft.dashboard.examples.ports
- shyft.dashboard.examples.selector_model
- shyft.dashboard.examples.selector_views
- shyft.dashboard.examples.slider_selector
- shyft.dashboard.examples.test_data_generator
- shyft.dashboard.examples.time_interval_selector_slider
- shyft.dashboard.examples.time_series_period_selector
- shyft.dashboard.examples.time_series_scatter_renderer
- shyft.dashboard.examples.time_series_viewer
- shyft.dashboard.examples.ts_viewer_background_data_renderer
- shyft.dashboard.examples.view_period_selector
- shyft.dashboard.apps
- shyft.dashboard.apps.dtss_viewer
- shyft.dashboard.apps.start_bokeh_apps
- shyft.dashboard.apps.water_route_app
- shyft.dashboard.entry_points
- shyft.dashboard.examples
- shyft.dashboard.examples
- API Documentation
- shyft.dashboard
- shyft.dashboard.base
- shyft.dashboard.base.app
- shyft.dashboard.base.constants
- shyft.dashboard.base.gate_model
- shyft.dashboard.base.gate_presenter
- shyft.dashboard.base.hashable
- shyft.dashboard.base.ports
PortError
PortConnectionError
PortConnectionWarning
States
ReceiverFunc
ReceiverFunc.self.timestamp
SenderFunc
SenderFunc.self.timestamp
PortTypes
PortBase
Receiver
Sender
check_port_compatibility()
connect_ports()
disconnect_ports()
StatePorts
grep_ports()
connect_state_ports()
connect_ports_and_state_ports()
- shyft.dashboard.base.selector_model
- shyft.dashboard.base.selector_presenter
- shyft.dashboard.base.selector_views
- shyft.dashboard.time_series
- shyft.dashboard.time_series.attr_callback_manager
- shyft.dashboard.time_series.axes
YAxisError
YAxisSide
YAxis
FigureYAxis
FigureYAxis.__init__()
FigureYAxis.label_callback()
FigureYAxis.unit_callback()
FigureYAxis.color_callback()
FigureYAxis.axis_format()
FigureYAxis.unit_view_format()
FigureYAxis.uid
FigureYAxis.side
FigureYAxis.set_y_range()
FigureYAxis.check_axis_dimensions()
FigureYAxis.get_dynamic_axis_unit()
FigureYAxis.reset_y_range()
- shyft.dashboard.time_series.axes_handler
TimeAxisHandlerError
DsViewTimeAxisType
BaseViewTimeAxis
BokehViewTimeAxis
TimePeriodSelectorTableViewTimeAxis
TimeAxisHandler
TimeAxisHandler.__init__()
TimeAxisHandler.auto_dt_figure_width
TimeAxisHandler.set_default_view_period()
TimeAxisHandler.initialize()
TimeAxisHandler.reset_view()
TimeAxisHandler.set_figure_width()
TimeAxisHandler.set_view_range()
TimeAxisHandler.trigger_time_axis_update()
TimeAxisHandler.evaluate_view_range()
TimeAxisHandler.calculate_restriction()
TimeAxisHandler.view_time_axis_properties
TimeAxisHandler.add_tool()
- shyft.dashboard.time_series.bindable
- shyft.dashboard.time_series.data_utility
- shyft.dashboard.time_series.ds_view_handle
- shyft.dashboard.time_series.ds_view_handle_registry
- shyft.dashboard.time_series.dt_selector
- shyft.dashboard.time_series.formatter
- shyft.dashboard.time_series.layouts
- shyft.dashboard.time_series.renderer
RendererError
to_bokeh_datetime_rep()
BaseFigureRenderer
BaseFigureRenderer.__init__()
BaseFigureRenderer.calendar
BaseFigureRenderer.y_range()
BaseFigureRenderer.set_view()
BaseFigureRenderer.on_set_view()
BaseFigureRenderer.clear_view()
BaseFigureRenderer.update_view_data()
BaseFigureRenderer.draw()
BaseFigureRenderer.visible
BaseFigureRenderer.ts_vector
BaseFigureRenderer.update_bokeh_data_source()
BaseFigureRenderer.reset_bokeh_data_source()
BaseFigureRenderer.glyphs
BaseFigureRenderer.set_bokeh_renderers()
BaseFigureRenderer.get_bokeh_renderers()
BaseFigureRenderer.visible_callback()
BaseFigureRenderer.color_callback()
SingleGlyphRenderer
LineRenderer
ScatterRenderer
DiamondScatterRenderer
CircleScatterRenderer
SquareScatterRenderer
TriangleScatterRenderer
FillInBetweenRenderer
MultiLineRenderer
BackgroundDataRenderer
- shyft.dashboard.time_series.sources
- shyft.dashboard.time_series.sources.source
DataSource
TsAdapterRequestParameter
SourceError
Source
Source.logger
Source.data_source
Source.views
Source.unit_reqistry
Source.visible
Source._state
Source.bokeh_document
Source.async_on
Source.queue
Source.current_request_parameter
Source.loading_data_async
Source.async_observer_ts_viewer
Source.__init__()
Source.update_data()
Source.request_data_from_ts_adapter_sync()
Source.update_view_data()
Source.update_view_data_async()
- shyft.dashboard.time_series.sources.ts_adapter
- shyft.dashboard.time_series.sources.source
- shyft.dashboard.time_series.state
- shyft.dashboard.time_series.tools
- shyft.dashboard.time_series.tools.base
- shyft.dashboard.time_series.tools.figure_tools
FigureToolError
FigureTool
ResetYRange
ActiveScroll
WheelZoomDirection
ExportLineDataButton
HoverToolToggleDropdown
HoverTool
TimePeriodSelectorInFigure
TimePeriodSelectorInFigure.__init__()
TimePeriodSelectorInFigure.layout
TimePeriodSelectorInFigure.layout_components
TimePeriodSelectorInFigure.period_to_str()
TimePeriodSelectorInFigure.on_bind()
TimePeriodSelectorInFigure.manipulate_period()
TimePeriodSelectorInFigure.pan_start_event_callback()
TimePeriodSelectorInFigure.pan_event_callback()
TimePeriodSelectorInFigure.set_time_period_restrictions()
TimePeriodSelectorInFigure.calculate_coordinates()
TimePeriodSelectorInFigure.update_plot()
TimePeriodSelectorInFigure.pan_end_event_callback()
TimePeriodSelectorInFigure.update_on_change_y_range()
ShowTsLabel
Actions
Modes
TimePeriodSelectorSlider
TimeIntervalSelectorSlider
TimeIntervalSelectorSlider.__init__()
TimeIntervalSelectorSlider.layout_components
TimeIntervalSelectorSlider.layout
TimeIntervalSelectorSlider.on_bind()
TimeIntervalSelectorSlider.on_click()
TimeIntervalSelectorSlider.reset_on_click()
TimeIntervalSelectorSlider.update_slider()
TimeIntervalSelectorSlider.set_slider_range_restrictions()
TimeIntervalSelectorSlider.set_time_period_restrictions()
TimeIntervalSelectorSlider.update_selected_area()
TimeIntervalSelectorSlider.update_title()
- shyft.dashboard.time_series.tools.table_tools
- shyft.dashboard.time_series.tools.ts_viewer_tools
- shyft.dashboard.time_series.tools.view_time_axis_tools
- shyft.dashboard.time_series.ts_viewer
TsViewerError
TsViewer
TsViewer.__init__()
TsViewer.layout
TsViewer.init_view_range()
TsViewer.plot()
TsViewer.clear()
TsViewer.trigger_data_update()
TsViewer.source_starting_async_data_update()
TsViewer.source_completed_async_data_update()
TsViewer.trigger_view_update()
TsViewer.add_view_container()
TsViewer.remove_view_container()
TsViewer.connect_to_dt_selector()
TsViewer.add_ds_view_handles()
TsViewer.remove_ds_view_handles()
TsViewer.add_tool()
TsViewer.set_layout()
TsViewer.layout_components
- shyft.dashboard.time_series.view
- shyft.dashboard.time_series.view_container
- shyft.dashboard.time_series.view_container.figure
Figure
Figure.__init__()
Figure.add_renderer_to_bokeh()
Figure.add_tool()
Figure.add_view()
Figure.clear()
Figure.clear_views()
Figure.draw_figure()
Figure.generate_renderers()
Figure.get_idle_renderer()
Figure.has_renderer_on_y_axis()
Figure.layout
Figure.layout_components
Figure.next_new_data_update_y_range()
Figure.remove_renderer_from_bokeh()
Figure.set_title()
Figure.update_title()
Figure.update_view_data()
Figure.update_y_range()
FigureError
- shyft.dashboard.time_series.view_container.legend
- shyft.dashboard.time_series.view_container.table
TableError
Table
Table.__init__()
Table.layout
Table.layout_components
Table.visible
Table.add_view()
Table.update_stored_view_data()
Table.update_view_data()
Table.prepare_data_and_update_data_source()
Table.update_data_source()
Table.reset_columns()
Table.reset_data_source()
Table.view_range_callback()
Table.estimate_view_range_indices()
Table.clear()
Table.clear_views()
Table.update_title()
Table.visible_callback()
Table.add_tool()
StatisticsTable
- shyft.dashboard.time_series.view_container.view_container_base
- shyft.dashboard.time_series.view_container.figure
- shyft.dashboard.time_series.view_time_axes
- shyft.dashboard.graph
- shyft.dashboard.maps
- shyft.dashboard.maps.base_map
- shyft.dashboard.maps.layer_data
- shyft.dashboard.maps.map_axes
MapAxesRanges
MapAxesRanges.__init__()
MapAxesRanges.on_bind()
MapAxesRanges.set_axes_bounds()
MapAxesRanges.set_axes_bounds_from_bounds_list()
MapAxesRanges.adjust_aspect_ratio()
MapAxesRanges.padding
MapAxesRanges.x_min
MapAxesRanges.y_min
MapAxesRanges.x_max
MapAxesRanges.y_max
MapAxesRanges.axes_bounds
MapAxesRanges.update_ranges()
- shyft.dashboard.maps.map_layer
- shyft.dashboard.maps.map_viewer
- shyft.dashboard.widgets
- shyft.dashboard.widgets.date_selector
- shyft.dashboard.widgets.logger_box
LogLevel
LoggerBox
LoggerBox.__init__()
LoggerBox.get_class_from_frame()
LoggerBox.isEnabledFor()
LoggerBox.layout_components
LoggerBox.callback_fontsize()
LoggerBox.callback_change_level()
LoggerBox.calculate_item_height()
LoggerBox.update_data_source()
LoggerBox.display_msg()
LoggerBox.debug()
LoggerBox.info()
LoggerBox.error()
LoggerBox.exception()
LoggerBox.critical()
LoggerBox.warning()
- shyft.dashboard.widgets.message_viewer
- shyft.dashboard.widgets.selector_models
- shyft.dashboard.widgets.sliders
- shyft.dashboard.widgets.water_route_widget
- shyft.dashboard.widgets.zoomables
- shyft.dashboard.util
- shyft.dashboard
- shyft.dashboard.base
- Start bokeh apps
- shyft.dashboard