Shyft: The Open Source Toolbox for Energy Markets
This document was last updated on 2025-02-26.
The open source SHyFT project contains four individual Python packages:
shyft.hydrologywhich provides spatially distributed conceptual hydrological modelsshyft.energy-marketwhich provides elements to build an energy market modelshyft.time-serieswhich provides a high performance generic time-series frameworkshyft.dashboardwhich 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
CalendarCalendar.DAYCalendar.HOURCalendar.MINUTECalendar.MONTHCalendar.QUARTERCalendar.RANGECalendar.SECONDCalendar.TZ_RANGECalendar.WEEKCalendar.YEARCalendar.__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
TimeAxisTimeAxis.__call__()TimeAxis.__init__()TimeAxis.calendar_dtTimeAxis.empty()TimeAxis.fixed_dtTimeAxis.index_of()TimeAxis.merge()TimeAxis.open_range_index_of()TimeAxis.period()TimeAxis.point_dtTimeAxis.size()TimeAxis.slice()TimeAxis.time()TimeAxis.time_pointsTimeAxis.time_points_doubleTimeAxis.timeaxis_typeTimeAxis.total_period()
- Class TimeSeries
TimeSeriesTimeSeries.__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_axisTimeSeries.time_shift()TimeSeries.total_period()TimeSeries.transform()TimeSeries.ts_id()TimeSeries.unbind()TimeSeries.upper_half()TimeSeries.upper_half_mask()TimeSeries.use_time_axis()TimeSeries.use_time_axis_from()TimeSeries.vTimeSeries.value()TimeSeries.values
- Class TsVector
TsVectorTsVector.__init__()TsVector.abs()TsVector.accumulate()TsVector.append()TsVector.average()TsVector.average_slice()TsVector.clear()TsVector.clone_expression()TsVector.derivative()TsVector.evaluate()TsVector.extend()TsVector.extend_ts()TsVector.extract_as_table()TsVector.forecast_merge()TsVector.insert()TsVector.inside()TsVector.integral()TsVector.log()TsVector.max()TsVector.min()TsVector.nash_sutcliffe()TsVector.percentiles()TsVector.pop()TsVector.pow()TsVector.repeat()TsVector.size()TsVector.slice()TsVector.statistics()TsVector.sum()TsVector.time_shift()TsVector.transform()TsVector.use_time_axis()TsVector.use_time_axis_from()TsVector.value_range()TsVector.values_at()
- Class TimeAxis
- Time series expressions
- DTSS - The Distributed Time series System
- Class DtsServer
DtsServerDtsServer.__init__()DtsServer.add_auth_tokens()DtsServer.alive_connectionsDtsServer.auth_neededDtsServer.auth_tokens()DtsServer.cache()DtsServer.cache_max_itemsDtsServer.cache_memory_targetDtsServer.cache_statsDtsServer.cache_ts_initial_size_estimateDtsServer.cbDtsServer.clear()DtsServer.clear_cache_stats()DtsServer.close()DtsServer.configuration_fileDtsServer.default_geo_db_configDtsServer.default_geo_db_typeDtsServer.failed_connectionsDtsServer.find()DtsServer.find_cbDtsServer.flush_cache()DtsServer.flush_cache_all()DtsServer.geo_ts_read_cbDtsServer.geo_ts_store_cbDtsServer.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_msDtsServer.is_running()DtsServer.maintain_backend_container()DtsServer.process_messages()DtsServer.read()DtsServer.remove_auth_tokens()DtsServer.remove_container()DtsServer.remove_container_cbDtsServer.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.stale_connection_close_countDtsServer.start_async()DtsServer.start_server()DtsServer.start_web_api()DtsServer.stop_server()DtsServer.stop_web_api()DtsServer.store()DtsServer.store_ts_cbDtsServer.swap_container()
DtssCfg
- Class DtsClient
DtsClientDtsClient.__init__()DtsClient.add_geo_ts_db()DtsClient.auto_connectDtsClient.cache_flush()DtsClient.cache_statsDtsClient.close()DtsClient.compress_expressionsDtsClient.connectionsDtsClient.evaluate()DtsClient.find()DtsClient.geo_evaluate()DtsClient.geo_store()DtsClient.get_client_supported_protocols()DtsClient.get_container_names()DtsClient.get_geo_db_ts_info()DtsClient.get_q_bridge_status()DtsClient.get_q_bridges()DtsClient.get_server_supported_protocols()DtsClient.get_server_version()DtsClient.get_transfer_status()DtsClient.get_transfers()DtsClient.get_ts_info()DtsClient.merge_store_ts_points()DtsClient.operation_timeout_msDtsClient.percentiles()DtsClient.q_ack()DtsClient.q_add()DtsClient.q_find()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.start_q_bridge()DtsClient.start_transfer()DtsClient.stop_q_bridge()DtsClient.stop_transfer()DtsClient.store()DtsClient.store_ts()DtsClient.swap_container()DtsClient.total_clientsDtsClient.update_geo_ts_db_info()
- Class StorePolicy
- Class DtsServer
- DTSS Exchange
- DTSS Transfer
TransferConfigurationTransferConfiguration.PeriodSpecTransferConfiguration.RemoteSpecTransferConfiguration.TimeSeriesSpecTransferConfiguration.WhenSpecTransferConfiguration.XferSpecTransferConfiguration.__init__()TransferConfiguration.howTransferConfiguration.jsonTransferConfiguration.nameTransferConfiguration.protocol_versionTransferConfiguration.read_remoteTransferConfiguration.read_updates_cacheTransferConfiguration.store_policyTransferConfiguration.whatTransferConfiguration.whenTransferConfiguration.whereTransferConfiguration.xfer_period
TransferStatusTransferStatus.ReadErrorTransferStatus.WriteErrorTransferStatus.__init__()TransferStatus.last_activityTransferStatus.n_ts_foundTransferStatus.read_errorsTransferStatus.read_speedTransferStatus.reader_aliveTransferStatus.remote_errorsTransferStatus.total_transferredTransferStatus.write_errorsTransferStatus.write_speedTransferStatus.writer_alive
- DTSS QueueBridge
QueueBridgeConfigurationQueueBridgeStatus
- DTSS Queue for time-series
- Geo-location Time series
- Class GeoPoint
- Class GeoTimeSeries
- Class GeoTimeSeriesVector
- Class GeoQuery
- Class GeoSlice
- Class GeoTsMatrix
- Class GeoMatrixShape
- Class GeoGridSpec
- Class GeoEvalArgs
- Class GeoTimeSeriesConfiguration
GeoTimeSeriesConfigurationGeoTimeSeriesConfiguration.__init__()GeoTimeSeriesConfiguration.bounding_box()GeoTimeSeriesConfiguration.compute()GeoTimeSeriesConfiguration.convex_hull()GeoTimeSeriesConfiguration.create_geo_ts_matrix()GeoTimeSeriesConfiguration.create_ts_matrix()GeoTimeSeriesConfiguration.descriptionGeoTimeSeriesConfiguration.dtGeoTimeSeriesConfiguration.find_geo_match_ix()GeoTimeSeriesConfiguration.gridGeoTimeSeriesConfiguration.jsonGeoTimeSeriesConfiguration.n_ensemblesGeoTimeSeriesConfiguration.nameGeoTimeSeriesConfiguration.origin_proj4GeoTimeSeriesConfiguration.prefixGeoTimeSeriesConfiguration.t0_time_axisGeoTimeSeriesConfiguration.t0_timesGeoTimeSeriesConfiguration.variables
- Class GeoPointVector
GeoPointVectorGeoPointVector.__init__()GeoPointVector.append()GeoPointVector.area()GeoPointVector.clear()GeoPointVector.create_from_x_y_z()GeoPointVector.extend()GeoPointVector.insert()GeoPointVector.mid_point()GeoPointVector.nearest_neighbours()GeoPointVector.polygon_buffer()GeoPointVector.pop()GeoPointVector.size()GeoPointVector.transform()
- Class GeoPointVectorVector
GeoPointVectorVectorGeoPointVectorVector.__init__()GeoPointVectorVector.append()GeoPointVectorVector.areas()GeoPointVectorVector.clear()GeoPointVectorVector.extend()GeoPointVectorVector.insert()GeoPointVectorVector.intersection_areas()GeoPointVectorVector.mid_points()GeoPointVectorVector.pop()GeoPointVectorVector.size()
- 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
ARegionEnvironmentARegionEnvironment.__init__()ARegionEnvironment.create_from_geo_ts_matrix()ARegionEnvironment.deserialize()ARegionEnvironment.precipitationARegionEnvironment.radiationARegionEnvironment.rel_humARegionEnvironment.serialize()ARegionEnvironment.temperatureARegionEnvironment.variablesARegionEnvironment.wind_speed
ActualEvapotranspirationCalculate_step()ActualEvapotranspirationParameterActualEvapotranspirationResponseBTKParameterCalibrationOptionCalibrationOption.__init__()CalibrationOption.bobyqa()CalibrationOption.dream()CalibrationOption.global_search()CalibrationOption.max_iterationsCalibrationOption.methodCalibrationOption.sceua()CalibrationOption.solver_epsilonCalibrationOption.time_limitCalibrationOption.tr_startCalibrationOption.tr_stopCalibrationOption.x_epsilonCalibrationOption.y_epsilon
CalibrationStatusCatchmentPropertyTypeCellEnvironmentCellStateIdDrmClientDrmClient.__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_portDrmClient.is_calculated()DrmClient.is_cell_env_ts_ok()DrmClient.is_openDrmClient.operation_timeout_msDrmClient.reconnect_countDrmClient.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_msDrmClient.total_clients
DrmServerDrmServer.__init__()DrmServer.alive_connectionsDrmServer.fxDrmServer.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()
FlowAdjustResultFreeWaterEvaporationCalculatorFreeWaterEvaporationResponseGammaSnowCalculatorGammaSnowParameterGammaSnowParameter.__init__()GammaSnowParameter.calculate_iso_pot_energyGammaSnowParameter.effective_snow_cv()GammaSnowParameter.fast_albedo_decay_rateGammaSnowParameter.glacier_albedoGammaSnowParameter.initial_bare_ground_fractionGammaSnowParameter.is_snow_season()GammaSnowParameter.is_start_melt_season()GammaSnowParameter.max_albedoGammaSnowParameter.max_waterGammaSnowParameter.min_albedoGammaSnowParameter.n_winter_daysGammaSnowParameter.slow_albedo_decay_rateGammaSnowParameter.snow_cvGammaSnowParameter.snow_cv_altitude_factorGammaSnowParameter.snow_cv_forest_factorGammaSnowParameter.snowfall_reset_depthGammaSnowParameter.surface_magnitudeGammaSnowParameter.txGammaSnowParameter.wind_constGammaSnowParameter.wind_scaleGammaSnowParameter.winter_end_day_of_year
GammaSnowResponseGammaSnowStateGeoCellDataGeoCellData.__init__()GeoCellData.area()GeoCellData.aspect()GeoCellData.catchment_id()GeoCellData.epsg_idGeoCellData.is_tin()GeoCellData.land_type_fractions_info()GeoCellData.mid_point()GeoCellData.radiation_slope_factor()GeoCellData.routing_infoGeoCellData.set_catchment_id()GeoCellData.set_land_type_fractions()GeoCellData.set_tin_data()GeoCellData.slope()GeoCellData.surface_area()GeoCellData.vertexes()
GeoCellDataClientGeoCellDataClient.__init__()GeoCellDataClient.close()GeoCellDataClient.get_model_infos()GeoCellDataClient.host_portGeoCellDataClient.is_openGeoCellDataClient.operation_timeout_msGeoCellDataClient.read_model()GeoCellDataClient.read_models()GeoCellDataClient.reconnect_countGeoCellDataClient.remove_model()GeoCellDataClient.store_model()GeoCellDataClient.timeout_msGeoCellDataClient.update_model_info()
GeoCellDataModelGeoCellDataModelVectorGeoCellDataServerGeoCellDataServer.__init__()GeoCellDataServer.get_listening_port()GeoCellDataServer.get_max_connections()GeoCellDataServer.get_model_infos()GeoCellDataServer.is_running()GeoCellDataServer.read_model()GeoCellDataServer.read_model_blob()GeoCellDataServer.read_models()GeoCellDataServer.remove_model()GeoCellDataServer.set_listening_ip()GeoCellDataServer.set_listening_port()GeoCellDataServer.set_max_connections()GeoCellDataServer.stale_connection_close_countGeoCellDataServer.start_server()GeoCellDataServer.stop_server()GeoCellDataServer.store_model()GeoCellDataServer.update_model_info()
GeoCellDataVectorGeoPointSourceGeoPointSourceVectorGlacierMeltParameterGoalFunctionClientGoalFunctionClient.__init__()GoalFunctionClient.close()GoalFunctionClient.get_model_infos()GoalFunctionClient.host_portGoalFunctionClient.is_openGoalFunctionClient.operation_timeout_msGoalFunctionClient.read_model()GoalFunctionClient.read_models()GoalFunctionClient.reconnect_countGoalFunctionClient.remove_model()GoalFunctionClient.store_model()GoalFunctionClient.timeout_msGoalFunctionClient.update_model_info()
GoalFunctionModelGoalFunctionModelVectorGoalFunctionServerGoalFunctionServer.__init__()GoalFunctionServer.get_listening_port()GoalFunctionServer.get_max_connections()GoalFunctionServer.get_model_infos()GoalFunctionServer.is_running()GoalFunctionServer.read_model()GoalFunctionServer.read_model_blob()GoalFunctionServer.read_models()GoalFunctionServer.remove_model()GoalFunctionServer.set_listening_ip()GoalFunctionServer.set_listening_port()GoalFunctionServer.set_max_connections()GoalFunctionServer.stale_connection_close_countGoalFunctionServer.start_server()GoalFunctionServer.stop_server()GoalFunctionServer.store_model()GoalFunctionServer.update_model_info()
HbvActualEvapotranspirationCalculate_step()HbvActualEvapotranspirationParameterHbvActualEvapotranspirationResponseHbvPhysicalSnowCalculatorHbvPhysicalSnowParameterHbvPhysicalSnowParameter.__init__()HbvPhysicalSnowParameter.calculate_iso_pot_energyHbvPhysicalSnowParameter.cfrHbvPhysicalSnowParameter.fast_albedo_decay_rateHbvPhysicalSnowParameter.intervalsHbvPhysicalSnowParameter.lwHbvPhysicalSnowParameter.max_albedoHbvPhysicalSnowParameter.min_albedoHbvPhysicalSnowParameter.sHbvPhysicalSnowParameter.set_snow_quantiles()HbvPhysicalSnowParameter.set_snow_redistribution_factors()HbvPhysicalSnowParameter.slow_albedo_decay_rateHbvPhysicalSnowParameter.snowfall_reset_depthHbvPhysicalSnowParameter.surface_magnitudeHbvPhysicalSnowParameter.txHbvPhysicalSnowParameter.wind_constHbvPhysicalSnowParameter.wind_scale
HbvPhysicalSnowResponseHbvPhysicalSnowStateHbvSnowCalculatorHbvSnowParameterHbvSnowResponseHbvSnowStateHbvSoilCalculatorHbvSoilParameterHbvSoilResponseHbvSoilStateHbvTankCalculatorHbvTankParameterHbvTankResponseHbvTankStateIDWParameterIDWPrecipitationParameterIDWTemperatureParameterInterpolationParameterKalmanBiasPredictorKalmanBiasPredictor.__init__()KalmanBiasPredictor.compute_running_bias()KalmanBiasPredictor.compute_running_bias_ts()KalmanBiasPredictor.filterKalmanBiasPredictor.stateKalmanBiasPredictor.update_with_forecast()KalmanBiasPredictor.update_with_forecast_vector()KalmanBiasPredictor.update_with_geo_forecast()
KalmanFilterKalmanParameterKalmanStateKirchnerCalculatorKirchnerParameterKirchnerResponseKirchnerStateLandTypeFractionsMethodStackParameterOKCovarianceTypeOKParameterOptimizerMethodParameterClientParameterClient.__init__()ParameterClient.close()ParameterClient.get_model_infos()ParameterClient.host_portParameterClient.is_openParameterClient.operation_timeout_msParameterClient.read_model()ParameterClient.read_models()ParameterClient.reconnect_countParameterClient.remove_model()ParameterClient.store_model()ParameterClient.timeout_msParameterClient.update_model_info()
ParameterModelParameterModelVectorParameterOptimizerParameterServerParameterServer.__init__()ParameterServer.get_listening_port()ParameterServer.get_max_connections()ParameterServer.get_model_infos()ParameterServer.is_running()ParameterServer.read_model()ParameterServer.read_model_blob()ParameterServer.read_models()ParameterServer.remove_model()ParameterServer.set_listening_ip()ParameterServer.set_listening_port()ParameterServer.set_max_connections()ParameterServer.stale_connection_close_countParameterServer.start_server()ParameterServer.stop_server()ParameterServer.store_model()ParameterServer.update_model_info()
PenmanMonteithCalculatorPenmanMonteithParameterPenmanMonteithResponsePenmanMonteithVegetationCalculatorPenmanMonteithVegetationParameterPenmanMonteithVegetationResponsePrecipitationCorrectionCalculatorPrecipitationCorrectionParameterPrecipitationSourcePrecipitationSourceVectorPrecipitationSourceVector.__init__()PrecipitationSourceVector.append()PrecipitationSourceVector.clear()PrecipitationSourceVector.extend()PrecipitationSourceVector.from_geo_and_ts_vector()PrecipitationSourceVector.geo_tsvectorPrecipitationSourceVector.insert()PrecipitationSourceVector.pop()PrecipitationSourceVector.size()PrecipitationSourceVector.values_at_time()
PriestleyTaylorCalculatorPriestleyTaylorParameterPriestleyTaylorResponseRadiationCalculatorRadiationParameterRadiationResponseRadiationSourceRadiationSourceVectorRadiationSourceVector.__init__()RadiationSourceVector.append()RadiationSourceVector.clear()RadiationSourceVector.extend()RadiationSourceVector.from_geo_and_ts_vector()RadiationSourceVector.geo_tsvectorRadiationSourceVector.insert()RadiationSourceVector.pop()RadiationSourceVector.size()RadiationSourceVector.values_at_time()
RegionModelTypeRegionModelType.PT_GS_KRegionModelType.PT_GS_K_OPTRegionModelType.PT_HPS_KRegionModelType.PT_HPS_K_OPTRegionModelType.PT_HS_KRegionModelType.PT_HS_K_OPTRegionModelType.PT_SS_KRegionModelType.PT_SS_K_OPTRegionModelType.PT_ST_HBVRegionModelType.PT_ST_KRegionModelType.PT_ST_K_HBVRegionModelType.PT_ST_K_OPTRegionModelType.R_PMV_ST_KRegionModelType.R_PMV_ST_K_OPTRegionModelType.R_PM_GS_KRegionModelType.R_PM_GS_K_OPTRegionModelType.R_PM_ST_KRegionModelType.R_PM_ST_K_OPTRegionModelType.R_PT_GS_KRegionModelType.R_PT_GS_K_OPTRegionModelType.__init__()RegionModelType.nameRegionModelType.value
RelHumSourceRelHumSourceVectorRelHumSourceVector.__init__()RelHumSourceVector.append()RelHumSourceVector.clear()RelHumSourceVector.extend()RelHumSourceVector.from_geo_and_ts_vector()RelHumSourceVector.geo_tsvectorRelHumSourceVector.insert()RelHumSourceVector.pop()RelHumSourceVector.size()RelHumSourceVector.values_at_time()
RiverRiverNetworkRoutingInfoSkaugenCalculatorSkaugenParameterSkaugenResponseSkaugenStateSnowTilesCalculatorSnowTilesParameterSnowTilesResponseSnowTilesStateStateClientStateClient.__init__()StateClient.close()StateClient.get_model_infos()StateClient.host_portStateClient.is_openStateClient.operation_timeout_msStateClient.read_model()StateClient.read_models()StateClient.reconnect_countStateClient.remove_model()StateClient.store_model()StateClient.timeout_msStateClient.update_model_info()
StateModelStateModelVectorStateServerStateServer.__init__()StateServer.get_listening_port()StateServer.get_max_connections()StateServer.get_model_infos()StateServer.is_running()StateServer.read_model()StateServer.read_model_blob()StateServer.read_models()StateServer.remove_model()StateServer.set_listening_ip()StateServer.set_listening_port()StateServer.set_max_connections()StateServer.stale_connection_close_countStateServer.start_server()StateServer.stop_server()StateServer.store_model()StateServer.update_model_info()
TargetSpecCalcTypeTargetSpecificationPtsTargetSpecificationPts.__init__()TargetSpecificationPts.calc_modeTargetSpecificationPts.catchment_indexesTargetSpecificationPts.catchment_propertyTargetSpecificationPts.evaluate_fx()TargetSpecificationPts.fxTargetSpecificationPts.river_idTargetSpecificationPts.s_aTargetSpecificationPts.s_bTargetSpecificationPts.s_rTargetSpecificationPts.scale_factorTargetSpecificationPts.tsTargetSpecificationPts.uid
TargetSpecificationVectorTemperatureSourceTemperatureSourceVectorTemperatureSourceVector.__init__()TemperatureSourceVector.append()TemperatureSourceVector.clear()TemperatureSourceVector.extend()TemperatureSourceVector.from_geo_and_ts_vector()TemperatureSourceVector.geo_tsvectorTemperatureSourceVector.insert()TemperatureSourceVector.pop()TemperatureSourceVector.size()TemperatureSourceVector.values_at_time()
TsTransformUHGParameterWindSpeedSourceWindSpeedSourceVectorWindSpeedSourceVector.__init__()WindSpeedSourceVector.append()WindSpeedSourceVector.clear()WindSpeedSourceVector.extend()WindSpeedSourceVector.from_geo_and_ts_vector()WindSpeedSourceVector.geo_tsvectorWindSpeedSourceVector.insert()WindSpeedSourceVector.pop()WindSpeedSourceVector.size()WindSpeedSourceVector.values_at_time()
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()parse_cf_time()stat_scopeversion()
Energy Market
- Installation
- Concepts
- Tutorials
- Examples
- API Documentation
- Core
CatchmentCatchmentListClientConnectionRoleGateGateListHydroComponentHydroComponent.__init__()HydroComponent.customHydroComponent.disconnect_from()HydroComponent.downstreamsHydroComponent.equal_structure()HydroComponent.get_tsm_object()HydroComponent.hpsHydroComponent.idHydroComponent.jsonHydroComponent.nameHydroComponent.objHydroComponent.tsHydroComponent.upstreams
HydroComponentListHydroConnectionHydroConnectionListHydroGraphTraversalHydroPowerSystemHydroPowerSystem.__init__()HydroPowerSystem.aggregatesHydroPowerSystem.catchmentsHydroPowerSystem.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.createdHydroPowerSystem.customHydroPowerSystem.equal_content()HydroPowerSystem.equal_structure()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_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.gatesHydroPowerSystem.get_tsm_object()HydroPowerSystem.idHydroPowerSystem.jsonHydroPowerSystem.model_areaHydroPowerSystem.nameHydroPowerSystem.objHydroPowerSystem.power_plantsHydroPowerSystem.power_stationsHydroPowerSystem.reservoirsHydroPowerSystem.to_blob()HydroPowerSystem.to_blob_ref()HydroPowerSystem.tsHydroPowerSystem.unitsHydroPowerSystem.water_routesHydroPowerSystem.waterways
HydroPowerSystemBuilderHydroPowerSystemBuilder.__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()
HydroPowerSystemListIntStringDictStringTimeSeriesDictModelModel.__init__()Model.areaModel.create_model_area()Model.create_power_line()Model.create_power_module()Model.createdModel.customModel.equal_content()Model.equal_structure()Model.from_blob()Model.get_tsm_object()Model.idModel.jsonModel.nameModel.objModel.power_linesModel.to_blob()Model.ts
ModelAreaModelBuilderModelInfoPointPointListPowerLinePowerLineListPowerModulePowerModuleDictPowerPlantPowerPlant.__init__()PowerPlant.add_aggregate()PowerPlant.add_unit()PowerPlant.aggregatesPowerPlant.customPowerPlant.get_tsm_object()PowerPlant.hpsPowerPlant.idPowerPlant.jsonPowerPlant.namePowerPlant.objPowerPlant.remove_aggregate()PowerPlant.remove_unit()PowerPlant.tsPowerPlant.units
PowerPlantListReservoirReservoirListRunRunClientRunClient.__init__()RunClient.close()RunClient.get_model_infos()RunClient.host_portRunClient.is_openRunClient.operation_timeout_msRunClient.read_model()RunClient.read_models()RunClient.reconnect_countRunClient.remove_model()RunClient.store_model()RunClient.timeout_msRunClient.update_model_info()
RunServerRunServer.__init__()RunServer.get_listening_port()RunServer.get_max_connections()RunServer.get_model_infos()RunServer.is_running()RunServer.read_model()RunServer.read_model_blob()RunServer.read_models()RunServer.remove_model()RunServer.set_listening_ip()RunServer.set_listening_port()RunServer.set_max_connections()RunServer.stale_connection_close_countRunServer.start_server()RunServer.stop_server()RunServer.store_model()RunServer.update_model_info()
ServerServer.__init__()Server.get_listening_port()Server.get_max_connections()Server.get_model_infos()Server.is_running()Server.read_model()Server.read_model_blob()Server.read_models()Server.remove_model()Server.set_listening_ip()Server.set_listening_port()Server.set_max_connections()Server.stale_connection_close_countServer.start_server()Server.stop_server()Server.store_model()Server.update_model_info()
TurbineCapabilityTurbineDescriptionTurbineOperatingZoneTurbineOperatingZoneListUnitUnitListWaterwayWaterwayListXyPointCurveXyPointCurveListXyPointCurveWithZXyPointCurveWithZListXyPointCurveWithZList.__init__()XyPointCurveWithZList.append()XyPointCurveWithZList.clear()XyPointCurveWithZList.evaluate()XyPointCurveWithZList.extend()XyPointCurveWithZList.insert()XyPointCurveWithZList.pop()XyPointCurveWithZList.size()XyPointCurveWithZList.x_max()XyPointCurveWithZList.x_min()XyPointCurveWithZList.y_max()XyPointCurveWithZList.y_min()XyPointCurveWithZList.z_max()XyPointCurveWithZList.z_min()
XyzPointCurvecompressed_size()points_from_x_y()run_statedownstream_reservoirs()downstream_units()upstream_reservoirs()upstream_units()has_forward_capability()has_backward_capability()has_reversible_capability()
- STM
AbsoluteConstraintApplicationClientApplicationClient.__init__()ApplicationClient.add_case()ApplicationClient.add_task_ref()ApplicationClient.get_case_by_id()ApplicationClient.get_case_by_name()ApplicationClient.get_layout_infos()ApplicationClient.get_task_infos()ApplicationClient.get_task_ref()ApplicationClient.read_layout()ApplicationClient.read_layout_with_args()ApplicationClient.read_layouts()ApplicationClient.read_task()ApplicationClient.read_tasks()ApplicationClient.remove_case_by_id()ApplicationClient.remove_case_by_name()ApplicationClient.remove_layout()ApplicationClient.remove_task()ApplicationClient.remove_task_ref()ApplicationClient.store_layout()ApplicationClient.store_task()ApplicationClient.task_fx()ApplicationClient.update_case()ApplicationClient.update_layout_info()ApplicationClient.update_task_info()
ApplicationServerBusbarBusbar.TsTripletBusbar.__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.customBusbar.flattened_attributes()Busbar.flowBusbar.get_market_areas()Busbar.get_transmission_lines_from_busbar()Busbar.get_transmission_lines_to_busbar()Busbar.get_tsm_object()Busbar.idBusbar.jsonBusbar.nameBusbar.networkBusbar.objBusbar.power_modulesBusbar.priceBusbar.remove_power_module()Busbar.remove_unit()Busbar.remove_wind_farm()Busbar.tagBusbar.tsBusbar.unitsBusbar.wind_farms
BusbarListCatchmentCatchmentListContractContract.ConstraintContract.ContractRelationContract.ContractRelationListContract.__init__()Contract.activeContract.add_relation()Contract.add_to_market_area()Contract.add_to_portfolio()Contract.buyerContract.constraintContract.customContract.feeContract.find_related_to_this()Contract.flattened_attributes()Contract.get_market_areas()Contract.get_portfolios()Contract.get_tsm_object()Contract.idContract.jsonContract.nameContract.objContract.optionsContract.parent_idContract.power_plantsContract.priceContract.quantityContract.relationsContract.remove_relation()Contract.revenueContract.sellerContract.systemContract.tagContract.tsContract.validationContract.wind_farms
ContractListContractPortfolioContractPortfolio.__init__()ContractPortfolio.contractsContractPortfolio.customContractPortfolio.feeContractPortfolio.flattened_attributes()ContractPortfolio.get_tsm_object()ContractPortfolio.idContractPortfolio.jsonContractPortfolio.nameContractPortfolio.objContractPortfolio.quantityContractPortfolio.revenueContractPortfolio.systemContractPortfolio.tagContractPortfolio.ts
ContractPortfolioListDStmClientDStmClient.__init__()DStmClient.add_compute_server()DStmClient.add_model()DStmClient.cache_flush()DStmClient.cache_stats()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_server_version()DStmClient.get_state()DStmClient.get_ts()DStmClient.host_portDStmClient.is_openDStmClient.operation_timeout_msDStmClient.optimize()DStmClient.patch_model()DStmClient.reconnect_countDStmClient.remove_model()DStmClient.rename_model()DStmClient.reset_model()DStmClient.set_attrs()DStmClient.set_model()DStmClient.set_ts()DStmClient.start_tune()DStmClient.stop_tune()DStmClient.timeout_msDStmClient.tune()
DStmServerDStmServer.__init__()DStmServer.add_compute_server()DStmServer.add_container()DStmServer.add_model()DStmServer.apply()DStmServer.cache_max_itemsDStmServer.cache_memory_targetDStmServer.cache_statsDStmServer.cache_ts_initial_size_estimateDStmServer.clear_cache_stats()DStmServer.clear_master_slave()DStmServer.clone_model()DStmServer.close()DStmServer.create_model()DStmServer.evaluate_model()DStmServer.flush_cache()DStmServer.fxDStmServer.get_listening_ip()DStmServer.get_listening_port()DStmServer.get_model()DStmServer.get_model_ids()DStmServer.get_model_infos()DStmServer.get_state()DStmServer.get_version_info()DStmServer.get_web_api_ip()DStmServer.get_web_api_port()DStmServer.is_running()DStmServer.notify_change()DStmServer.optimize()DStmServer.remove_from_cache()DStmServer.remove_model()DStmServer.rename_model()DStmServer.set_listening_ip()DStmServer.set_listening_port()DStmServer.set_master_slave_mode()DStmServer.start_server()DStmServer.start_web_api()DStmServer.stop_server()DStmServer.stop_web_api()
GateGate.DischargeGate.OpeningGate.__init__()Gate.costGate.customGate.dischargeGate.flattened_attributes()Gate.flow_descriptionGate.flow_description_delta_hGate.get_tsm_object()Gate.idGate.jsonGate.nameGate.objGate.openingGate.tagGate.ts
GateListHpsClientHpsClient.__init__()HpsClient.close()HpsClient.get_model_infos()HpsClient.host_portHpsClient.is_openHpsClient.operation_timeout_msHpsClient.read_model()HpsClient.read_models()HpsClient.reconnect_countHpsClient.remove_model()HpsClient.store_model()HpsClient.timeout_msHpsClient.update_model_info()
HpsServerHpsServer.__init__()HpsServer.get_listening_port()HpsServer.get_max_connections()HpsServer.get_model_infos()HpsServer.is_running()HpsServer.read_model()HpsServer.read_model_blob()HpsServer.read_models()HpsServer.remove_model()HpsServer.set_listening_ip()HpsServer.set_listening_port()HpsServer.set_max_connections()HpsServer.stale_connection_close_countHpsServer.start_server()HpsServer.stop_server()HpsServer.store_model()HpsServer.update_model_info()
HydroPowerSystemHydroPowerSystem.__init__()HydroPowerSystem.create_aggregate()HydroPowerSystem.create_catchment()HydroPowerSystem.create_gate()HydroPowerSystem.create_power_plant()HydroPowerSystem.create_reservoir()HydroPowerSystem.create_reservoir_aggregate()HydroPowerSystem.create_river()HydroPowerSystem.create_tunnel()HydroPowerSystem.create_unit()HydroPowerSystem.create_waterway()HydroPowerSystem.customHydroPowerSystem.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.flattened_attributes()HydroPowerSystem.from_blob()HydroPowerSystem.from_stripped_blob()HydroPowerSystem.get_tsm_object()HydroPowerSystem.idHydroPowerSystem.jsonHydroPowerSystem.nameHydroPowerSystem.objHydroPowerSystem.reservoir_aggregatesHydroPowerSystem.systemHydroPowerSystem.tagHydroPowerSystem.to_blob()HydroPowerSystem.to_stripped_blob()HydroPowerSystem.ts
HydroPowerSystemListJanitorConfigLayoutInfoLogEntryLogSeverityManagedServerStateMarketAreaMarketArea.OfferingMarketArea.TsTripletMarketArea.TsTripletResultMarketArea.__init__()MarketArea.busbarsMarketArea.buyMarketArea.contractsMarketArea.create_busbar_derived_unit_group()MarketArea.customMarketArea.demandMarketArea.flattened_attributes()MarketArea.get_consumption()MarketArea.get_export()MarketArea.get_import()MarketArea.get_production()MarketArea.get_tsm_object()MarketArea.idMarketArea.jsonMarketArea.loadMarketArea.max_buyMarketArea.max_saleMarketArea.nameMarketArea.objMarketArea.priceMarketArea.productionMarketArea.remove_unit_group()MarketArea.reserve_obligation_penaltyMarketArea.saleMarketArea.supplyMarketArea.systemMarketArea.tagMarketArea.transmission_lines_from()MarketArea.transmission_lines_to()MarketArea.tsMarketArea.unit_group
MarketAreaListModelRefListModelStateNetworkNetworkListPenaltyConstraintPowerModulePowerModuleListPowerModuleMemberPowerPlantPowerPlant.BestProfitPowerPlant.DischargePowerPlant.Discharge.__init__()PowerPlant.Discharge.constraint_maxPowerPlant.Discharge.constraint_minPowerPlant.Discharge.downstream_level_constraintPowerPlant.Discharge.intake_loss_from_bypass_flagPowerPlant.Discharge.ramping_downPowerPlant.Discharge.ramping_upPowerPlant.Discharge.realisedPowerPlant.Discharge.resultPowerPlant.Discharge.schedulePowerPlant.Discharge.upstream_level_constraint
PowerPlant.FeesPowerPlant.ProductionPowerPlant.Production.__init__()PowerPlant.Production.constraint_maxPowerPlant.Production.constraint_minPowerPlant.Production.instant_maxPowerPlant.Production.merge_tolerancePowerPlant.Production.ramping_downPowerPlant.Production.ramping_upPowerPlant.Production.realisedPowerPlant.Production.resultPowerPlant.Production.schedule
PowerPlant.__init__()PowerPlant.add_aggregate()PowerPlant.add_unit()PowerPlant.best_profitPowerPlant.customPowerPlant.dischargePowerPlant.feesPowerPlant.flattened_attributes()PowerPlant.get_tsm_object()PowerPlant.gross_headPowerPlant.idPowerPlant.jsonPowerPlant.mipPowerPlant.namePowerPlant.objPowerPlant.outlet_levelPowerPlant.productionPowerPlant.reservePowerPlant.tagPowerPlant.tsPowerPlant.unavailability
PowerPlantListReservoirReservoir.InflowReservoir.LevelReservoir.RampingReservoir.VolumeReservoir.Volume.ConstraintsReservoir.Volume.CostReservoir.Volume.SlackReservoir.Volume.__init__()Reservoir.Volume.constraintReservoir.Volume.penaltyReservoir.Volume.realisedReservoir.Volume.resultReservoir.Volume.scheduleReservoir.Volume.slackReservoir.Volume.static_max
Reservoir.WaterValueReservoir.__init__()Reservoir.customReservoir.flattened_attributes()Reservoir.get_tsm_object()Reservoir.idReservoir.inflowReservoir.jsonReservoir.levelReservoir.nameReservoir.objReservoir.rampingReservoir.tagReservoir.tsReservoir.volumeReservoir.volume_level_mappingReservoir.water_value
ReservoirAggregateReservoirAggregate.InflowReservoirAggregate.VolumeReservoirAggregate.__init__()ReservoirAggregate.add_reservoir()ReservoirAggregate.customReservoirAggregate.flattened_attributes()ReservoirAggregate.get_tsm_object()ReservoirAggregate.idReservoirAggregate.inflowReservoirAggregate.jsonReservoirAggregate.nameReservoirAggregate.objReservoirAggregate.remove_reservoir()ReservoirAggregate.reservoirsReservoirAggregate.tagReservoirAggregate.tsReservoirAggregate.volume
ReservoirAggregateListReservoirListRunParametersServerStatusShopCommandShopCommand.__init__()ShopCommand.keywordShopCommand.log_file()ShopCommand.log_file_lp()ShopCommand.objectsShopCommand.optionsShopCommand.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_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.specifierShopCommand.start_shopsim()ShopCommand.start_sim()
StmCaseStmClientStmClient.__init__()StmClient.close()StmClient.get_model_infos()StmClient.host_portStmClient.is_openStmClient.operation_timeout_msStmClient.read_model()StmClient.read_models()StmClient.reconnect_countStmClient.remove_model()StmClient.store_model()StmClient.timeout_msStmClient.update_model_info()
StmModelRefStmPatchOperationStmServerStmServer.__init__()StmServer.get_listening_port()StmServer.get_max_connections()StmServer.get_model_infos()StmServer.is_running()StmServer.read_model()StmServer.read_model_blob()StmServer.read_models()StmServer.remove_model()StmServer.set_listening_ip()StmServer.set_listening_port()StmServer.set_max_connections()StmServer.stale_connection_close_countStmServer.start_server()StmServer.stop_server()StmServer.store_model()StmServer.update_model_info()
StmSystemStmSystem.__init__()StmSystem.add_unit_group()StmSystem.contract_portfoliosStmSystem.contractsStmSystem.create_hydro_power_system()StmSystem.create_market_area()StmSystem.create_network()StmSystem.create_power_module()StmSystem.create_wind_farm()StmSystem.customStmSystem.fix_uplinks()StmSystem.from_blob()StmSystem.from_stripped_blob()StmSystem.get_attr()StmSystem.get_attrs()StmSystem.get_tsm_object()StmSystem.hydro_power_systemsStmSystem.idStmSystem.jsonStmSystem.market_areasStmSystem.nameStmSystem.networksStmSystem.objStmSystem.patch()StmSystem.power_modulesStmSystem.result_ts_urls()StmSystem.run_parametersStmSystem.set_attr()StmSystem.set_attrs()StmSystem.summaryStmSystem.tagStmSystem.to_blob()StmSystem.to_stripped_blob()StmSystem.tsStmSystem.unit_groupsStmSystem.wind_farms
StmTaskStmTaskClientStmTaskClient.__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_portStmTaskClient.is_openStmTaskClient.operation_timeout_msStmTaskClient.read_model()StmTaskClient.read_models()StmTaskClient.reconnect_countStmTaskClient.remove_case()StmTaskClient.remove_model()StmTaskClient.remove_model_ref()StmTaskClient.store_model()StmTaskClient.timeout_msStmTaskClient.update_case()StmTaskClient.update_model_info()StmTaskClient.update_model_ref()
StmTaskServerStmTaskServer.__init__()StmTaskServer.add_auth_tokens()StmTaskServer.auth_neededStmTaskServer.auth_tokens()StmTaskServer.fxStmTaskServer.get_listening_port()StmTaskServer.get_max_connections()StmTaskServer.get_model_infos()StmTaskServer.is_running()StmTaskServer.read_model()StmTaskServer.read_model_blob()StmTaskServer.read_models()StmTaskServer.remove_auth_tokens()StmTaskServer.remove_model()StmTaskServer.set_listening_ip()StmTaskServer.set_listening_port()StmTaskServer.set_max_connections()StmTaskServer.stale_connection_close_countStmTaskServer.start_server()StmTaskServer.start_web_api()StmTaskServer.stop_server()StmTaskServer.stop_web_api()StmTaskServer.store_model()StmTaskServer.update_model_info()
TransmissionLineTransmissionLine.__init__()TransmissionLine.capacityTransmissionLine.customTransmissionLine.flattened_attributes()TransmissionLine.from_bbTransmissionLine.get_tsm_object()TransmissionLine.idTransmissionLine.jsonTransmissionLine.nameTransmissionLine.networkTransmissionLine.objTransmissionLine.tagTransmissionLine.to_bbTransmissionLine.ts
TransmissionLineListTsEvaluationErrorUnitUnit.BestProfitUnit.CostUnit.DischargeUnit.ProductionUnit.ProductionDischargeRelationUnit.PumpConstraintUnit.ReserveUnit.Reserve.FcrDroopUnit.Reserve.PairUnit.Reserve.SpecUnit.Reserve.__init__()Unit.Reserve.afrrUnit.Reserve.afrr_static_maxUnit.Reserve.afrr_static_minUnit.Reserve.droopUnit.Reserve.droop_stepsUnit.Reserve.fcr_dUnit.Reserve.fcr_mipUnit.Reserve.fcr_nUnit.Reserve.fcr_static_maxUnit.Reserve.fcr_static_minUnit.Reserve.frrUnit.Reserve.mfrrUnit.Reserve.mfrr_static_minUnit.Reserve.mfrr_stop_flagUnit.Reserve.rr
Unit.__init__()Unit.best_profitUnit.costUnit.customUnit.dischargeUnit.effective_headUnit.flattened_attributes()Unit.generator_descriptionUnit.get_tsm_object()Unit.idUnit.jsonUnit.nameUnit.objUnit.priorityUnit.productionUnit.production_discharge_relationUnit.pump_constraintUnit.pump_descriptionUnit.pump_unavailabilityUnit.reserveUnit.tagUnit.tsUnit.turbine_descriptionUnit.unavailability
UnitGroupUnitGroup.DeliveryUnitGroup.MemberUnitGroup.MemberListUnitGroup.ObligationUnitGroup.__init__()UnitGroup.add_unit()UnitGroup.customUnitGroup.deliveryUnitGroup.flattened_attributes()UnitGroup.flowUnitGroup.get_tsm_object()UnitGroup.group_typeUnitGroup.idUnitGroup.jsonUnitGroup.market_areaUnitGroup.membersUnitGroup.nameUnitGroup.objUnitGroup.obligationUnitGroup.productionUnitGroup.remove_unit()UnitGroup.tagUnitGroup.ts
UnitGroupListUnitListUnitMemberUrlResolveErrorWaterwayWaterway.DischargeWaterway.Discharge.ConstraintsWaterway.Discharge.Constraints.__init__()Waterway.Discharge.Constraints.accumulated_maxWaterway.Discharge.Constraints.accumulated_minWaterway.Discharge.Constraints.maxWaterway.Discharge.Constraints.max_averageWaterway.Discharge.Constraints.minWaterway.Discharge.Constraints.min_averageWaterway.Discharge.Constraints.ramping_downWaterway.Discharge.Constraints.ramping_up
Waterway.Discharge.PenaltiesWaterway.Discharge.Penalties.CostsWaterway.Discharge.Penalties.Costs.__init__()Waterway.Discharge.Penalties.Costs.accumulated_maxWaterway.Discharge.Penalties.Costs.accumulated_minWaterway.Discharge.Penalties.Costs.constraint_maxWaterway.Discharge.Penalties.Costs.constraint_minWaterway.Discharge.Penalties.Costs.max_averageWaterway.Discharge.Penalties.Costs.min_averageWaterway.Discharge.Penalties.Costs.peak_curveWaterway.Discharge.Penalties.Costs.ramping_downWaterway.Discharge.Penalties.Costs.ramping_upWaterway.Discharge.Penalties.Costs.rate
Waterway.Discharge.Penalties.ResultsWaterway.Discharge.Penalties.Results.__init__()Waterway.Discharge.Penalties.Results.accumulated_maxWaterway.Discharge.Penalties.Results.accumulated_minWaterway.Discharge.Penalties.Results.constraint_maxWaterway.Discharge.Penalties.Results.constraint_minWaterway.Discharge.Penalties.Results.ramping_downWaterway.Discharge.Penalties.Results.ramping_upWaterway.Discharge.Penalties.Results.rate
Waterway.Discharge.Penalties.__init__()Waterway.Discharge.Penalties.costWaterway.Discharge.Penalties.result
Waterway.Discharge.__init__()Waterway.Discharge.constraintWaterway.Discharge.penaltyWaterway.Discharge.realisedWaterway.Discharge.referenceWaterway.Discharge.resultWaterway.Discharge.scheduleWaterway.Discharge.static_max
Waterway.FlowDescriptionWaterway.GeometryWaterway.__init__()Waterway.add_gate()Waterway.customWaterway.delayWaterway.deviationWaterway.dischargeWaterway.flattened_attributes()Waterway.flow_descriptionWaterway.geometryWaterway.get_tsm_object()Waterway.head_loss_coeffWaterway.head_loss_funcWaterway.idWaterway.jsonWaterway.nameWaterway.objWaterway.tagWaterway.ts
WaterwayListWindFarmWindFarm.CostWindFarm.ProductionWindFarm.ReserveWindFarm.__init__()WindFarm.add_wind_turbines()WindFarm.costWindFarm.create_wind_turbine()WindFarm.customWindFarm.epsgWindFarm.flattened_attributes()WindFarm.get_tsm_object()WindFarm.heightWindFarm.icingWindFarm.idWindFarm.jsonWindFarm.locationWindFarm.nameWindFarm.objWindFarm.power_correctionWindFarm.power_curveWindFarm.productionWindFarm.reserveWindFarm.systemWindFarm.tagWindFarm.tsWindFarm.unavailabilityWindFarm.wake_lossWindFarm.wind_turbines
WindFarmListWindFarmMemberWindTurbineWindTurbine.CostWindTurbine.ProductionWindTurbine.Production.ConstraintWindTurbine.Production.ReserveWindTurbine.Production.Reserve.PairWindTurbine.Production.Reserve.SpecWindTurbine.Production.Reserve.Spec.__init__()WindTurbine.Production.Reserve.Spec.costWindTurbine.Production.Reserve.Spec.maxWindTurbine.Production.Reserve.Spec.minWindTurbine.Production.Reserve.Spec.penaltyWindTurbine.Production.Reserve.Spec.realisedWindTurbine.Production.Reserve.Spec.resultWindTurbine.Production.Reserve.Spec.schedule
WindTurbine.Production.Reserve.__init__()WindTurbine.Production.Reserve.fcr_dWindTurbine.Production.Reserve.fcr_nWindTurbine.Production.Reserve.mfrr
WindTurbine.Production.__init__()WindTurbine.Production.constraintWindTurbine.Production.realisedWindTurbine.Production.resultWindTurbine.Production.schedule
WindTurbine.__init__()WindTurbine.costWindTurbine.customWindTurbine.flattened_attributes()WindTurbine.get_tsm_object()WindTurbine.heightWindTurbine.idWindTurbine.jsonWindTurbine.locationWindTurbine.nameWindTurbine.objWindTurbine.power_curveWindTurbine.productionWindTurbine.reserveWindTurbine.tagWindTurbine.tsWindTurbine.wind_farm
WindTurbineListcompute_effective_price()url_planning_inputs()url_planning_outputs()
- STM Compute and Shop
- STM Shop
ShopCommandShopCommand.__init__()ShopCommand.keywordShopCommand.log_file()ShopCommand.log_file_lp()ShopCommand.objectsShopCommand.optionsShopCommand.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_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.specifierShopCommand.start_shopsim()ShopCommand.start_sim()
ShopCommandListShopCommanderShopCommander.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_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()
ShopSystemShopSystem.environment()ShopSystem.environment_string()ShopSystem.optimize()ShopSystem.optimize2()ShopSystem.__init__()ShopSystem.collect()ShopSystem.command_raw()ShopSystem.complete()ShopSystem.emit()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.set_logging_to_files()ShopSystem.set_logging_to_stdstreams()ShopSystem.commander
- Service
- UI
- 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.range_tool
- 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
- 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
YAxisErrorYAxisSideYAxisFigureYAxisFigureYAxis.__init__()FigureYAxis.label_callback()FigureYAxis.unit_callback()FigureYAxis.color_callback()FigureYAxis.axis_format()FigureYAxis.unit_view_format()FigureYAxis.uidFigureYAxis.sideFigureYAxis.set_y_range()FigureYAxis.check_axis_dimensions()FigureYAxis.get_dynamic_axis_unit()FigureYAxis.reset_y_range()
- shyft.dashboard.time_series.axes_handler
TimeAxisHandlerErrorDsViewTimeAxisTypeBaseViewTimeAxisBokehViewTimeAxisTimePeriodSelectorTableViewTimeAxisTimeAxisHandlerTimeAxisHandler.__init__()TimeAxisHandler.auto_dt_figure_widthTimeAxisHandler.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_propertiesTimeAxisHandler.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
RendererErrorto_bokeh_datetime_rep()BaseFigureRendererBaseFigureRenderer.__init__()BaseFigureRenderer.calendarBaseFigureRenderer.y_range()BaseFigureRenderer.set_view()BaseFigureRenderer.on_set_view()BaseFigureRenderer.clear_view()BaseFigureRenderer.update_view_data()BaseFigureRenderer.draw()BaseFigureRenderer.visibleBaseFigureRenderer.ts_vectorBaseFigureRenderer.update_bokeh_data_source()BaseFigureRenderer.reset_bokeh_data_source()BaseFigureRenderer.glyphsBaseFigureRenderer.set_bokeh_renderers()BaseFigureRenderer.get_bokeh_renderers()BaseFigureRenderer.visible_callback()BaseFigureRenderer.color_callback()
SingleGlyphRendererLineRendererScatterRendererDiamondScatterRendererCircleScatterRendererSquareScatterRendererTriangleScatterRendererFillInBetweenRendererMultiLineRendererBackgroundDataRenderer
- shyft.dashboard.time_series.sources
- shyft.dashboard.time_series.sources.source
DataSourceTsAdapterRequestParameterSourceErrorSourceSource.loggerSource.data_sourceSource.viewsSource.unit_reqistrySource.visibleSource._stateSource.bokeh_documentSource.async_onSource.queueSource.current_request_parameterSource.loading_data_asyncSource.async_observer_ts_viewerSource.__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
FigureToolErrorFigureToolResetYRangeActiveScrollWheelZoomDirectionExportLineDataButtonHoverToolToggleDropdownHoverToolTimePeriodSelectorInFigureTimePeriodSelectorInFigure.__init__()TimePeriodSelectorInFigure.layoutTimePeriodSelectorInFigure.layout_componentsTimePeriodSelectorInFigure.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()
ShowTsLabelActionsModesTimePeriodSelectorSliderTimeIntervalSelectorSliderTimeIntervalSelectorSlider.__init__()TimeIntervalSelectorSlider.layout_componentsTimeIntervalSelectorSlider.layoutTimeIntervalSelectorSlider.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
TsViewerErrorTsViewerTsViewer.__init__()TsViewer.layoutTsViewer.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
FigureErrorFigureFigure.__init__()Figure.layoutFigure.layout_componentsFigure.clear()Figure.add_view()Figure.has_renderer_on_y_axis()Figure.clear_views()Figure.update_view_data()Figure.get_idle_renderer()Figure.generate_renderers()Figure.add_renderer_to_bokeh()Figure.remove_renderer_from_bokeh()Figure.set_title()Figure.update_title()Figure.draw_figure()Figure.update_y_range()Figure.next_new_data_update_y_range()Figure.add_tool()
- shyft.dashboard.time_series.view_container.legend
- shyft.dashboard.time_series.view_container.table
TableErrorTableTable.__init__()Table.layoutTable.layout_componentsTable.visibleTable.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
MapAxesRangesMapAxesRanges.__init__()MapAxesRanges.on_bind()MapAxesRanges.set_axes_bounds()MapAxesRanges.set_axes_bounds_from_bounds_list()MapAxesRanges.adjust_aspect_ratio()MapAxesRanges.paddingMapAxesRanges.x_minMapAxesRanges.y_minMapAxesRanges.x_maxMapAxesRanges.y_maxMapAxesRanges.axes_boundsMapAxesRanges.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
LogLevelLoggerBoxLoggerBox.__init__()LoggerBox.get_class_from_frame()LoggerBox.isEnabledFor()LoggerBox.layout_componentsLoggerBox.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