Shyft: The Open Source Toolbox for Energy Markets

This document was last updated on 2024-02-21.

The open source SHyFT project contains four individual Python packages:

1. shyft.hydrology which provides spatially distributed conceptual hydrological models

2. shyft.energy-market which provides elements to build an energy market model

3. shyft.time-series which provides a high performance generic time-series framework

4. shyft.dashboard which provides web components to display time series using Bokeh.

Project

• Introduction
• What is Shyft?
  • Features
  • History
  • Design principles
• Setup Shyft
  • Container based setup
  • Info about packages
• Get involved
• Contact

Time Series

• Installation
• Concepts
  • Dealing with time
    • UTC / GMT and DST
    • Epoch Timestamp
    • Python datetime vs. epoch
  • What is a time series?
  • Time series expressions
  • DTSS - Distributed Time Series System
• Tutorials
  • Time
    • Create a time object
    • Using a time object
    • Containers
      • UtcPeriod
      • YMDhms
      • YWdhms
  • Calendar
    • Create a Calendar object
    • Calendar and time
    • Python datetime to Shyft time
  • TimeAxis
    • Create a TimeAxis object
      • Fixed interval time axis
      • Ireggular interval time axis
      • Calendar time axis
    • A few helpful functions
  • TimeSeries
    • Time series types
      • POINT_INSTANT_VALUE
      • POINT_AVERAGE_VALUE
    • Inspection functions
      • TimeSeries(t: int/float/time)
      • point_interpretation()
      • size()
      • time_axis
      • values.to_numpy()
    • General time series manipulation
      • Arithmetics
      • Mathematical operations
        • Average
        • Accumulate
        • Derivative
        • Integral
        • Statistics
      • Utility functions
        • Inside
        • Max/min
        • Time shift
  • Distributed Time Series (DTS)
    • DtsServer
    • DtsClient
• Examples
  • ts.convolve_w
  • ts.decode
  • ts.derivative
  • KRLS predictor using DTSS containers
    • Introduction
    • 0. Setup the demo
    • 1. Register a KRLS time-series
    • 1. Predict a time-series
    • 3. Update the trained period
    • 4. Repredict
  • ts.inside
  • ts.partition_by and ts.percentiles
  • Time, Calendar and periods
    • Shyft time
    • Calendars
      • Initializing calendars
      • Construct localized time
      • Stringifying local time
      • Trim time
      • Add to time
      • Diff moments
      • Time constants
    • Time periods
      • Initialization
      • List of functions
      • Start & end
      • Timespan
      • Valid
      • To string
      • Trimming periods
      • Intersection & overlap
      • Moment in period
      • Diff a period
• API Documentation
  • Time
    • Function utctime_now
      • utctime_now
    • Function deltahours
      • deltahours
    • Function deltaminutes
      • deltaminutes
    • Class time
      • time
        • time.__init__()
        • time.epoch
        • time.max
        • time.min
        • time.now()
        • time.seconds
        • time.sqrt()
        • time.undefined
    • Class YMDhms
      • YMDhms
        • YMDhms.__init__()
        • YMDhms.day
        • YMDhms.hour
        • YMDhms.is_null()
        • YMDhms.is_valid()
        • YMDhms.max()
        • YMDhms.micro_second
        • YMDhms.min()
        • YMDhms.minute
        • YMDhms.month
        • YMDhms.second
        • YMDhms.year
    • Class YWdhms
      • YWdhms
        • YWdhms.__init__()
        • YWdhms.hour
        • YWdhms.is_null()
        • YWdhms.is_valid()
        • YWdhms.iso_week
        • YWdhms.iso_year
        • YWdhms.max()
        • YWdhms.micro_second
        • YWdhms.min()
        • YWdhms.minute
        • YWdhms.second
        • YWdhms.week_day
    • Class TzInfo
      • TzInfo
        • TzInfo.__init__()
        • TzInfo.base_offset()
        • TzInfo.is_dst()
        • TzInfo.name()
        • TzInfo.utc_offset()
    • 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
      • UtcPeriod
        • UtcPeriod.__init__()
        • UtcPeriod.contains()
        • UtcPeriod.diff_units()
        • UtcPeriod.end
        • UtcPeriod.intersection()
        • UtcPeriod.overlaps()
        • UtcPeriod.start
        • UtcPeriod.timespan()
        • UtcPeriod.to_string()
        • UtcPeriod.trim()
        • UtcPeriod.valid()
    • Class UtcTimeVector
      • UtcTimeVector
        • UtcTimeVector.__init__()
        • UtcTimeVector.append()
        • UtcTimeVector.extend()
        • UtcTimeVector.from_numpy()
        • UtcTimeVector.push_back()
        • UtcTimeVector.size()
        • UtcTimeVector.to_numpy()
        • UtcTimeVector.to_numpy_double()
  • Time series
    • Class TimeAxis
      • TimeAxis
        • TimeAxis.__call__()
        • TimeAxis.__init__()
        • TimeAxis.calendar_dt
        • TimeAxis.empty()
        • 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()
        • 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()
        • TsVector.use_time_axis_from()
        • TsVector.value_range()
        • TsVector.values_at()
        • TsVector.values_at_time()
  • Time series expressions
    • Class TsBindInfo
      • TsBindInfo
        • TsBindInfo.__init__()
        • TsBindInfo.id
        • TsBindInfo.ts
  • 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.configuration_file
        • 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
        • DtsServer.swap_container()
    • 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()
        • DtsClient.store_ts()
        • DtsClient.swap_container()
        • DtsClient.total_clients
    • Class TsInfo
      • TsInfo
        • TsInfo.__init__()
        • TsInfo.created
        • TsInfo.data_period
        • TsInfo.delta_t
        • TsInfo.modified
        • TsInfo.name
        • TsInfo.olson_tz_id
        • TsInfo.point_fx
    • Class CacheStats
      • CacheStats
        • CacheStats.__init__()
        • CacheStats.coverage_misses
        • CacheStats.fragment_count
        • CacheStats.hits
        • CacheStats.id_count
        • CacheStats.misses
        • CacheStats.point_count
  • Geo-location Time series
    • Class GeoPoint
      • GeoPoint
        • GeoPoint.__init__()
        • GeoPoint.difference()
        • GeoPoint.distance2()
        • GeoPoint.distance_measure()
        • GeoPoint.x
        • GeoPoint.xy_distance()
        • GeoPoint.y
        • GeoPoint.z
        • GeoPoint.zscaled_distance()
    • Class GeoTimeSeries
      • GeoTimeSeries
        • GeoTimeSeries.__init__()
        • GeoTimeSeries.mid_point
        • GeoTimeSeries.ts
    • Class GeoTimeSeriesVector
      • GeoTimeSeriesVector
        • GeoTimeSeriesVector.__init__()
        • GeoTimeSeriesVector.append()
        • GeoTimeSeriesVector.extend()
        • GeoTimeSeriesVector.values_at_time()
    • Class GeoQuery
      • GeoQuery
        • GeoQuery.__init__()
        • GeoQuery.epsg
        • GeoQuery.polygon
    • Class GeoSlice
      • GeoSlice
        • GeoSlice.__init__()
        • GeoSlice.e
        • GeoSlice.g
        • GeoSlice.period
        • GeoSlice.skip_dt
        • GeoSlice.t
        • GeoSlice.ts_dt
        • GeoSlice.v
    • Class GeoTsMatrix
      • GeoTsMatrix
        • GeoTsMatrix.__init__()
        • GeoTsMatrix.concatenate()
        • GeoTsMatrix.evaluate()
        • GeoTsMatrix.extract_geo_ts_vector()
        • GeoTsMatrix.get_geo_point()
        • GeoTsMatrix.get_ts()
        • GeoTsMatrix.set_geo_point()
        • GeoTsMatrix.set_ts()
        • GeoTsMatrix.shape
        • GeoTsMatrix.transform()
    • Class GeoMatrixShape
      • GeoMatrixShape
        • GeoMatrixShape.__init__()
        • GeoMatrixShape.n_e
        • GeoMatrixShape.n_g
        • GeoMatrixShape.n_t0
        • GeoMatrixShape.n_v
    • Class GeoGridSpec
      • GeoGridSpec
        • GeoGridSpec.__init__()
        • GeoGridSpec.epsg
        • GeoGridSpec.find_geo_match()
        • GeoGridSpec.points
    • Class GeoEvalArgs
      • GeoEvalArgs
        • GeoEvalArgs.__init__()
        • GeoEvalArgs.cc_dt0
        • GeoEvalArgs.concat
        • GeoEvalArgs.ens
        • GeoEvalArgs.geo_range
        • GeoEvalArgs.geo_ts_db_id
        • GeoEvalArgs.t0_time_axis
        • GeoEvalArgs.ts_dt
        • GeoEvalArgs.ts_expressions
        • GeoEvalArgs.variables
    • 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
      • Class convolve_policy
        • convolve_policy
          • convolve_policy.BACKWARD
          • convolve_policy.CENTER
          • convolve_policy.FORWARD
          • convolve_policy.USE_NAN
          • convolve_policy.USE_NEAREST
          • convolve_policy.USE_ZERO
          • convolve_policy.names
          • convolve_policy.values
      • Class derivative_method
        • derivative_method
          • derivative_method.BACKWARD
          • derivative_method.CENTER
          • derivative_method.DEFAULT
          • derivative_method.FORWARD
          • derivative_method.names
          • derivative_method.values
      • Class extend_fill_policy
        • extend_fill_policy
          • extend_fill_policy.FILL_NAN
          • extend_fill_policy.FILL_VALUE
          • extend_fill_policy.USE_LAST
          • extend_fill_policy.names
          • extend_fill_policy.values
      • Class extend_split_policy
        • extend_split_policy
          • extend_split_policy.AT_VALUE
          • extend_split_policy.LHS_LAST
          • extend_split_policy.RHS_FIRST
          • extend_split_policy.names
          • extend_split_policy.values
      • Class interpolation_scheme
        • interpolation_scheme
          • interpolation_scheme.SCHEME_CATMULL_ROM
          • interpolation_scheme.SCHEME_LINEAR
          • interpolation_scheme.SCHEME_POLYNOMIAL
          • interpolation_scheme.names
          • interpolation_scheme.values
      • Class point_interpretation_policy
        • point_interpretation_policy
          • point_interpretation_policy.POINT_AVERAGE_VALUE
          • point_interpretation_policy.POINT_INSTANT_VALUE
          • point_interpretation_policy.names
          • point_interpretation_policy.values
      • Class trim_policy
        • trim_policy
          • trim_policy.TRIM_IN
          • trim_policy.TRIM_OUT
          • trim_policy.TRIM_ROUND
          • trim_policy.names
          • trim_policy.values
    • Tools
      • Class KrlsRbfPredictor
        • KrlsRbfPredictor
          • KrlsRbfPredictor.__init__()
          • KrlsRbfPredictor.clear()
          • KrlsRbfPredictor.mse_ts()
          • KrlsRbfPredictor.predict()
          • KrlsRbfPredictor.predictor_mse()
          • KrlsRbfPredictor.train()
      • Class QacParameter
        • QacParameter
          • QacParameter.__init__()
          • QacParameter.constant_filler
          • QacParameter.max_timespan
          • QacParameter.max_v
          • QacParameter.min_v
          • QacParameter.repeat_allowed
          • QacParameter.repeat_timespan
          • QacParameter.repeat_tolerance
    • Hydrology
      • Class IcePackingParameters
        • IcePackingParameters
          • IcePackingParameters.__init__()
          • IcePackingParameters.threshold_temperature
          • IcePackingParameters.threshold_window
      • Class IcePackingRecessionParameters
        • IcePackingRecessionParameters
          • IcePackingRecessionParameters.__init__()
          • IcePackingRecessionParameters.alpha
          • IcePackingRecessionParameters.recession_minimum
      • Class ice_packing_temperature_policy
        • ice_packing_temperature_policy
          • ice_packing_temperature_policy.ALLOW_ANY_MISSING
          • ice_packing_temperature_policy.ALLOW_INITIAL_MISSING
          • ice_packing_temperature_policy.DISALLOW_MISSING
          • ice_packing_temperature_policy.names
          • ice_packing_temperature_policy.values
      • Class RatingCurveFunction
        • RatingCurveFunction
          • RatingCurveFunction.__init__()
          • RatingCurveFunction.add_segment()
          • RatingCurveFunction.flow()
          • RatingCurveFunction.size()
      • Class RatingCurveParameters
        • RatingCurveParameters
          • RatingCurveParameters.__init__()
          • RatingCurveParameters.add_curve()
          • RatingCurveParameters.flow()
      • Class RatingCurveSegment
        • RatingCurveSegment
          • RatingCurveSegment.__init__()
          • RatingCurveSegment.a
          • RatingCurveSegment.b
          • RatingCurveSegment.c
          • RatingCurveSegment.flow()
          • RatingCurveSegment.lower
          • RatingCurveSegment.valid()
      • Class RatingCurveSegments
        • RatingCurveSegments
          • RatingCurveSegments.__init__()
          • RatingCurveSegments.append()
          • RatingCurveSegments.extend()
      • Class RatingCurveTimeFunction
        • RatingCurveTimeFunction
          • RatingCurveTimeFunction.__init__()
          • RatingCurveTimeFunction.f
          • RatingCurveTimeFunction.t
      • Class RatingCurveTimeFunctions
        • RatingCurveTimeFunctions
          • RatingCurveTimeFunctions.__init__()
          • RatingCurveTimeFunctions.append()
          • RatingCurveTimeFunctions.extend()

Hydrology

• Installation
• Concepts
  • Hydrological region model
  • Orchestration
    • Repositories
      • The generic repository
      • The ‘repository’ entries in ‘datasets.yaml’
      • The ‘repository’ entry in ‘configuration.yaml’
  • Summary
  • What is a repository?
  • Configuring Shyft
• Tutorials
  • Essential api classes
    • Introduction
    • 1. Loading required python modules and running a configured shyft simulation
    • 2. The key classes within the api and being “pythonic”
      • IntVector, and other ---Vector types
    • 3. shyft.time_series.TimeSeries
  • 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
      • 1. The starting model state: updating the current state of the model
      • 2. Running the interpolation
      • 3. Running the model
    • STEP 7: EXTRACTING SIMULATION RESULTS
    • STEP 8: MODEL CALIBRATION
    • Exercise
  • The Shyft api
    • Introduction
    • 1. Loading required python modules and setting path to Shyft installation
    • 2. Build a Shyft model
      • The simulation domain
      • Create a collection of simulation cells
      • GeoCellDataVector
      • The model class
    • 3. Read forcing data
    • 4. Interpolate forcing data to the cells
    • 5. Conduct the simulation
    • 6. Take a look at simulation results
  • Single method point simulation
    • Introduction
    • The Shyft Environment
      • 1. Synthetic forcing data set
      • 2. Convert input data to shyft-conform data-types by using api functionality
      • 3. Run a method using the Shyft API
      • 4. Changing parameters and initial state
  • Part 1: Nidelva simulation with Shyft API
    • Introduction
    • 1. Loading required python modules and setting path to Shyft installation
      • The Shyft Environment
    • 2. Configuration of a Shyft simulation
      • The simulator and the region_model
    • 3. Running a Shyft simulation
    • 4. Post processing and data extraction
      • Visualizing the discharge for each [sub-]catchment
      • A preferred approach
      • A teaser to the Shyft API
    • Visualizing the distributed catchment data
      • Extract data for individual simulation cells
    • Visualing the Snow Cover Area of all cells for a certain point in time
      • A note about the geometry of the region
  • Part 2: Nidelva simulation with the Shyft API
    • Introduction
    • 1. Loading required python modules and setting path to Shyft installation
      • The Shyft Environment
    • 2. Shyft initialization
      • Repositories
      • Creating a Shyft source
      • Look at the data
      • Create api.TimeSeries
      • Exploring the Shyft API
      • The concept of Shyft repositories
      • The ARegionEnvironment class
      • Interpolation Parameters
      • Initialization of the region_model
    • Summary
  • Running a calibration with Shyft
    • 1. Loading required python modules and setting path to Shyft installation
      • The Shyft Environment
    • 2. Configuration of a Shyft calibration
    • 3. Running a Shyft calibration
    • 4. Inspecting the calibration results
      • Plotting simulated and observed discharge
    • 5. Changing parameters on-the-fly
      • 5a. Snow or rain? The parameter gs.tx sets the threshold temperature at which precipitation is treated as snow fall.
  • Configured Shyft simulations
    • Introduction
    • 1. Loading required python modules and setting path to Shyft installation
      • The Shyft Environment
    • 2. Configuration of a Shyft simulation
      • The simulator and the region_model
    • 3. Running a Shyft simulation
    • 4. Post processing and data extraction
      • Visualizing the discharge for each [sub-]catchment
        • Look at the discharge timeseries
      • Visualizing the distributed catchment data
        • Extract data for individual simulation cells
      • Visualing the Snow Cover Area of all cells for a certain point in time
        • A note about the geometry of the region
  • Shyft simulation using Repositories
    • Introduction
    • 1. Loading required python modules and setting path to Shyft installation
      • The Shyft Environment
    • 2. A Shyft simulation
      • Orchestration and Repositories
        • Interfaces
      • Initial Configuration
        • region specification
        • Model specification
      • The region_model
        • Exploring the region_model
      • Adding forcing data to the region_model
        • “Sources”
        • Data Repositories
        • Shyft TimeAxis
      • Shyft Interpolation
      • Conduct the simulation
    • 3. Simulation results
    • Summary
  • Kalman filtering on time series
    • 1. Loading required python modules and setting path to Shyft installation
    • 2. Generate synthetic data for temperature observations and forecasts time-series
    • 3. Calculate the bias time-series using Kalman filter
    • 4. Apply bias to forecasts
    • 5. Plot the results
  • 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
    • 1. Loading required python modules and setting path to Shyft installation
    • 2. Create Kalman filter
    • 3. Creates start states
    • 4. Update filter
    • 5. Plot results
    • 6. Test to see how choice of parameters impact filter
  • 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
    • The function to run the 1-hour time-step Penman-Monteith equation from shyft
    • So this is our main code to study sensitivity
      • Temperature sensitivity
      • Windspeed sensitivity
      • Actual vapor pressure/relative humidity
      • Rnet sensitivity
      • Elevation
    • Sensitivity to parameters we will study using FPM
      • Vegetation height
      • Stomatal resistance
      • WS measurements height
      • Temperature and humidity measurements height
  • Penman-Monteith Single Method Verification
    • 24-hour time-step
    • 1-hour timestep
  • Sensitivity analysis of radiation routine
    • First we will import all necessary content
      • Information about station
      • Temperature dependency
      • Slope dependency
    • Aspect dependency
      • Latitude dependency
      • RHumidity dependency
      • Elevation dependency
      • Albedo dependency
      • Turbidity dependency
      • Time-step verification of algorithm
      • Random inputs
  • Checking calculation of Radiation at Polar Region
  • Radiation algorithm on the camels data
    • Importing all necessary classes
    • eq.38 reaction on topography
• 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
    • GeoCellDataModel.__init__()
    • GeoCellDataModel.geo_cell_data
    • GeoCellDataModel.id
  • StateServer
    • StateServer.__init__()
    • StateServer.get_listening_port()
    • StateServer.get_max_connections()
    • StateServer.is_running()
    • StateServer.set_listening_ip()
    • StateServer.set_listening_port()
    • StateServer.set_max_connections()
    • StateServer.start_server()
    • StateServer.stop_server()
  • 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
    • StateModel.__init__()
    • StateModel.id
    • StateModel.states
  • 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
    • ParameterModel.__init__()
    • ParameterModel.id
    • ParameterModel.parameters
  • 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
    • ActualEvapotranspirationParameter.__init__()
    • ActualEvapotranspirationParameter.ae_scale_factor
  • ActualEvapotranspirationResponse
    • ActualEvapotranspirationResponse.__init__()
    • ActualEvapotranspirationResponse.ae
  • BTKParameter
    • BTKParameter.__init__()
    • BTKParameter.nug()
    • BTKParameter.range()
    • BTKParameter.sill()
    • BTKParameter.temperature_gradient()
    • BTKParameter.temperature_gradient_sd()
    • BTKParameter.zscale()
  • CatchmentPropertyType
    • CatchmentPropertyType.CELL_CHARGE
    • CatchmentPropertyType.DISCHARGE
    • CatchmentPropertyType.ROUTED_DISCHARGE
    • CatchmentPropertyType.SNOW_COVERED_AREA
    • CatchmentPropertyType.SNOW_WATER_EQUIVALENT
    • CatchmentPropertyType.names
    • CatchmentPropertyType.values
  • CellEnvironment
    • CellEnvironment.__init__()
    • CellEnvironment.has_nan_values()
    • CellEnvironment.init()
    • CellEnvironment.precipitation
    • CellEnvironment.radiation
    • CellEnvironment.rel_hum
    • CellEnvironment.temperature
    • CellEnvironment.wind_speed
  • CellStateId
    • CellStateId.__init__()
    • CellStateId.area
    • CellStateId.cid
    • CellStateId.x
    • CellStateId.y
  • FlowAdjustResult
    • FlowAdjustResult.__init__()
    • FlowAdjustResult.diagnostics
    • FlowAdjustResult.q_0
    • FlowAdjustResult.q_r
  • GammaSnowCalculator
    • GammaSnowCalculator.__init__()
    • GammaSnowCalculator.step()
  • 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
    • GammaSnowResponse.__init__()
    • GammaSnowResponse.outflow
    • GammaSnowResponse.sca
    • GammaSnowResponse.storage
  • GammaSnowState
    • GammaSnowState.__init__()
    • GammaSnowState.acc_melt
    • GammaSnowState.albedo
    • GammaSnowState.alpha
    • GammaSnowState.iso_pot_energy
    • GammaSnowState.lwc
    • GammaSnowState.sdc_melt_mean
    • GammaSnowState.surface_heat
    • GammaSnowState.temp_swe
  • 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
    • GeoCellDataVector.__init__()
    • GeoCellDataVector.append()
    • GeoCellDataVector.deserialize()
    • GeoCellDataVector.extend()
    • GeoCellDataVector.serialize()
  • GeoPointSource
    • GeoPointSource.__init__()
    • GeoPointSource.geo_ts
    • GeoPointSource.mid_point()
    • GeoPointSource.mid_point_
    • GeoPointSource.ts
    • GeoPointSource.uid
  • GeoPointSourceVector
    • GeoPointSourceVector.__init__()
    • GeoPointSourceVector.append()
    • GeoPointSourceVector.extend()
    • GeoPointSourceVector.values_at_time()
  • GlacierMeltParameter
    • GlacierMeltParameter.__init__()
    • GlacierMeltParameter.direct_response
    • GlacierMeltParameter.dtf
  • HbvActualEvapotranspirationParameter
    • HbvActualEvapotranspirationParameter.__init__()
    • HbvActualEvapotranspirationParameter.lp
  • HbvActualEvapotranspirationResponse
    • HbvActualEvapotranspirationResponse.__init__()
    • HbvActualEvapotranspirationResponse.ae
  • HbvActualEvapotranspirationCalculate_step()
  • HbvPhysicalSnowCalculator
    • HbvPhysicalSnowCalculator.__init__()
    • HbvPhysicalSnowCalculator.step()
  • 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
    • HbvPhysicalSnowResponse.__init__()
    • HbvPhysicalSnowResponse.hps_state
    • HbvPhysicalSnowResponse.outflow
    • HbvPhysicalSnowResponse.sca
    • HbvPhysicalSnowResponse.storage
  • HbvPhysicalSnowState
    • HbvPhysicalSnowState.__init__()
    • HbvPhysicalSnowState.albedo
    • HbvPhysicalSnowState.distribute()
    • HbvPhysicalSnowState.iso_pot_energy
    • HbvPhysicalSnowState.sca
    • HbvPhysicalSnowState.sp
    • HbvPhysicalSnowState.surface_heat
    • HbvPhysicalSnowState.sw
    • HbvPhysicalSnowState.swe
  • HbvSnowCalculator
    • HbvSnowCalculator.__init__()
    • HbvSnowCalculator.step()
  • HbvSnowParameter
    • HbvSnowParameter.__init__()
    • HbvSnowParameter.cfr
    • HbvSnowParameter.cx
    • HbvSnowParameter.intervals
    • HbvSnowParameter.lw
    • HbvSnowParameter.s
    • HbvSnowParameter.set_snow_quantiles()
    • HbvSnowParameter.set_snow_redistribution_factors()
    • HbvSnowParameter.ts
    • HbvSnowParameter.tx
  • HbvSnowResponse
    • HbvSnowResponse.__init__()
    • HbvSnowResponse.outflow
    • HbvSnowResponse.snow_state
  • HbvSnowState
    • HbvSnowState.__init__()
    • HbvSnowState.distribute()
    • HbvSnowState.sca
    • HbvSnowState.sp
    • HbvSnowState.sw
    • HbvSnowState.swe
  • HbvSoilCalculator
    • HbvSoilCalculator.__init__()
    • HbvSoilCalculator.step()
  • HbvSoilParameter
    • HbvSoilParameter.__init__()
    • HbvSoilParameter.beta
    • HbvSoilParameter.fc
    • HbvSoilParameter.infmax
    • HbvSoilParameter.lpdel
  • HbvSoilResponse
    • HbvSoilResponse.__init__()
    • HbvSoilResponse.ae
    • HbvSoilResponse.inuz
  • HbvSoilState
    • HbvSoilState.__init__()
    • HbvSoilState.sm
  • HbvTankCalculator
    • HbvTankCalculator.__init__()
    • HbvTankCalculator.step()
  • HbvTankParameter
    • HbvTankParameter.__init__()
    • HbvTankParameter.ce
    • HbvTankParameter.cevpl
    • HbvTankParameter.klz
    • HbvTankParameter.kuz0
    • HbvTankParameter.kuz1
    • HbvTankParameter.kuz2
    • HbvTankParameter.perc
    • HbvTankParameter.uz1
    • HbvTankParameter.uz2
  • HbvTankResponse
    • HbvTankResponse.__init__()
    • HbvTankResponse.elake
    • HbvTankResponse.perculation
    • HbvTankResponse.q
    • HbvTankResponse.qlz
    • HbvTankResponse.quz
    • HbvTankResponse.quz0
    • HbvTankResponse.quz1
    • HbvTankResponse.quz2
  • HbvTankState
    • HbvTankState.__init__()
    • HbvTankState.lz
    • HbvTankState.uz
  • SnowTilesParameter
    • SnowTilesParameter.__init__()
    • SnowTilesParameter.area_fractions
    • SnowTilesParameter.cfr
    • SnowTilesParameter.cx
    • SnowTilesParameter.lwmax
    • SnowTilesParameter.shape
    • SnowTilesParameter.ts
    • SnowTilesParameter.tx
  • IDWParameter
    • IDWParameter.__init__()
    • IDWParameter.distance_measure_factor
    • IDWParameter.max_distance
    • IDWParameter.max_members
    • IDWParameter.zscale
  • IDWPrecipitationParameter
    • IDWPrecipitationParameter.__init__()
    • IDWPrecipitationParameter.scale_factor
  • IDWTemperatureParameter
    • IDWTemperatureParameter.__init__()
    • IDWTemperatureParameter.default_temp_gradient
    • IDWTemperatureParameter.gradient_by_equation
    • IDWTemperatureParameter.gradient_max
    • IDWTemperatureParameter.gradient_min
    • IDWTemperatureParameter.minimum_z_distance
  • InterpolationParameter
    • InterpolationParameter.__init__()
    • InterpolationParameter.precipitation
    • InterpolationParameter.radiation
    • InterpolationParameter.rel_hum
    • InterpolationParameter.temperature
    • InterpolationParameter.temperature_idw
    • InterpolationParameter.use_idw_for_temperature
    • InterpolationParameter.wind_speed
  • 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
    • KalmanFilter.__init__()
    • KalmanFilter.create_initial_state()
    • KalmanFilter.parameter
    • KalmanFilter.update()
  • KalmanParameter
    • KalmanParameter.__init__()
    • KalmanParameter.covariance_init
    • KalmanParameter.hourly_correlation
    • KalmanParameter.n_daily_observations
    • KalmanParameter.ratio_std_w_over_v
    • KalmanParameter.std_error_bias_measurements
  • KalmanState
    • KalmanState.P
    • KalmanState.W
    • KalmanState.__init__()
    • KalmanState.get_P()
    • KalmanState.get_W()
    • KalmanState.get_k()
    • KalmanState.get_x()
    • KalmanState.k
    • KalmanState.size()
    • KalmanState.x
  • KirchnerCalculator
    • KirchnerCalculator.__init__()
    • KirchnerCalculator.step()
  • KirchnerParameter
    • KirchnerParameter.__init__()
    • KirchnerParameter.c1
    • KirchnerParameter.c2
    • KirchnerParameter.c3
  • KirchnerResponse
    • KirchnerResponse.__init__()
    • KirchnerResponse.q_avg
  • KirchnerState
    • KirchnerState.__init__()
    • KirchnerState.q
  • LandTypeFractions
    • LandTypeFractions.__init__()
    • LandTypeFractions.forest()
    • LandTypeFractions.glacier()
    • LandTypeFractions.lake()
    • LandTypeFractions.reservoir()
    • LandTypeFractions.set_fractions()
    • LandTypeFractions.snow_storage()
    • LandTypeFractions.unspecified()
  • MethodStackParameter
    • MethodStackParameter.__init__()
    • MethodStackParameter.reservoir_direct_response_fraction
  • OKCovarianceType
    • OKCovarianceType.EXPONENTIAL
    • OKCovarianceType.GAUSSIAN
    • OKCovarianceType.names
    • OKCovarianceType.values
  • OKParameter
    • OKParameter.__init__()
    • OKParameter.a
    • OKParameter.c
    • OKParameter.cov_type
    • OKParameter.z_scale
  • PenmanMonteithCalculator
    • PenmanMonteithCalculator.__init__()
    • PenmanMonteithCalculator.reference_evapotranspiration()
  • PenmanMonteithParameter
    • PenmanMonteithParameter.__init__()
    • PenmanMonteithParameter.full_model
    • PenmanMonteithParameter.height_t
    • PenmanMonteithParameter.height_veg
    • PenmanMonteithParameter.height_ws
    • PenmanMonteithParameter.rl
  • PenmanMonteithResponse
    • PenmanMonteithResponse.__init__()
    • PenmanMonteithResponse.et_ref
    • PenmanMonteithResponse.soil_heat
  • PrecipitationCorrectionCalculator
    • PrecipitationCorrectionCalculator.__init__()
    • PrecipitationCorrectionCalculator.calc()
  • PrecipitationCorrectionParameter
    • PrecipitationCorrectionParameter.__init__()
    • PrecipitationCorrectionParameter.scale_factor
  • PrecipitationSource
    • PrecipitationSource.__init__()
    • PrecipitationSource.vector_t
  • PrecipitationSourceVector
    • PrecipitationSourceVector.__init__()
    • PrecipitationSourceVector.append()
    • PrecipitationSourceVector.extend()
    • PrecipitationSourceVector.from_geo_and_ts_vector()
    • PrecipitationSourceVector.geo_tsvector
    • PrecipitationSourceVector.values_at_time()
  • PriestleyTaylorCalculator
    • PriestleyTaylorCalculator.__init__()
    • PriestleyTaylorCalculator.potential_evapotranspiration()
  • PriestleyTaylorParameter
    • PriestleyTaylorParameter.__init__()
    • PriestleyTaylorParameter.albedo
    • PriestleyTaylorParameter.alpha
  • PriestleyTaylorResponse
    • PriestleyTaylorResponse.__init__()
    • PriestleyTaylorResponse.pot_evapotranspiration
  • RadiationCalculator
    • RadiationCalculator.__init__()
    • RadiationCalculator.net_radiation()
    • RadiationCalculator.net_radiation_inst()
    • RadiationCalculator.net_radiation_step()
    • RadiationCalculator.net_radiation_step_asce_st()
  • RadiationParameter
    • RadiationParameter.__init__()
    • RadiationParameter.albedo
    • RadiationParameter.turbidity
  • RadiationResponse
    • RadiationResponse.__init__()
    • RadiationResponse.net
    • RadiationResponse.net_lw
    • RadiationResponse.net_sw
    • RadiationResponse.ra
    • RadiationResponse.sw_cs_p
    • RadiationResponse.sw_t
  • RadiationSource
    • RadiationSource.__init__()
    • RadiationSource.vector_t
  • RadiationSourceVector
    • RadiationSourceVector.__init__()
    • RadiationSourceVector.append()
    • RadiationSourceVector.extend()
    • RadiationSourceVector.from_geo_and_ts_vector()
    • RadiationSourceVector.geo_tsvector
    • RadiationSourceVector.values_at_time()
  • RelHumSource
    • RelHumSource.__init__()
    • RelHumSource.vector_t
  • RelHumSourceVector
    • RelHumSourceVector.__init__()
    • RelHumSourceVector.append()
    • RelHumSourceVector.extend()
    • RelHumSourceVector.from_geo_and_ts_vector()
    • RelHumSourceVector.geo_tsvector
    • RelHumSourceVector.values_at_time()
  • River
    • River.__init__()
    • River.downstream
    • River.id
    • River.parameter
    • River.uhg()
  • RiverNetwork
    • RiverNetwork.__init__()
    • RiverNetwork.add()
    • RiverNetwork.downstream_by_id()
    • RiverNetwork.network_contains_directed_cycle()
    • RiverNetwork.remove_by_id()
    • RiverNetwork.river_by_id()
    • RiverNetwork.set_downstream_by_id()
    • RiverNetwork.upstreams_by_id()
  • RoutingInfo
    • RoutingInfo.__init__()
    • RoutingInfo.distance
    • RoutingInfo.id
  • SkaugenCalculator
    • SkaugenCalculator.__init__()
    • SkaugenCalculator.step()
  • SkaugenParameter
    • SkaugenParameter.__init__()
    • SkaugenParameter.alpha_0
    • SkaugenParameter.cfr
    • SkaugenParameter.cx
    • SkaugenParameter.d_range
    • SkaugenParameter.max_water_fraction
    • SkaugenParameter.ts
    • SkaugenParameter.tx
    • SkaugenParameter.unit_size
  • SkaugenResponse
    • SkaugenResponse.__init__()
    • SkaugenResponse.outflow
    • SkaugenResponse.sca
    • SkaugenResponse.swe
    • SkaugenResponse.total_stored_water
  • SkaugenState
    • SkaugenState.__init__()
    • SkaugenState.alpha
    • SkaugenState.free_water
    • SkaugenState.nu
    • SkaugenState.num_units
    • SkaugenState.residual
    • SkaugenState.sca
    • SkaugenState.swe
  • TargetSpecCalcType
    • TargetSpecCalcType.ABS_DIFF
    • TargetSpecCalcType.KLING_GUPTA
    • TargetSpecCalcType.NASH_SUTCLIFFE
    • TargetSpecCalcType.RMSE
    • TargetSpecCalcType.names
    • TargetSpecCalcType.values
  • 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
    • TargetSpecificationVector.__init__()
    • TargetSpecificationVector.append()
    • TargetSpecificationVector.extend()
    • TargetSpecificationVector.size()
  • TemperatureSource
    • TemperatureSource.__init__()
    • TemperatureSource.vector_t
  • TemperatureSourceVector
    • TemperatureSourceVector.__init__()
    • TemperatureSourceVector.append()
    • TemperatureSourceVector.extend()
    • TemperatureSourceVector.from_geo_and_ts_vector()
    • TemperatureSourceVector.geo_tsvector
    • TemperatureSourceVector.values_at_time()
  • TsTransform
    • TsTransform.__init__()
    • TsTransform.to_average()
  • UHGParameter
    • UHGParameter.__init__()
    • UHGParameter.alpha
    • UHGParameter.beta
    • UHGParameter.velocity
  • WindSpeedSource
    • WindSpeedSource.__init__()
    • WindSpeedSource.vector_t
  • WindSpeedSourceVector
    • WindSpeedSourceVector.__init__()
    • WindSpeedSourceVector.append()
    • WindSpeedSourceVector.extend()
    • WindSpeedSourceVector.from_geo_and_ts_vector()
    • WindSpeedSourceVector.geo_tsvector
    • 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()
  • stat_scope
    • stat_scope.catchment
    • stat_scope.cell
    • stat_scope.names
    • stat_scope.values
  • 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
    • OptimizerMethod.BOBYQA
    • OptimizerMethod.DREAM
    • OptimizerMethod.GLOBAL
    • OptimizerMethod.SCEUA
    • OptimizerMethod.names
    • OptimizerMethod.values
  • CalibrationStatus
    • CalibrationStatus.__init__()
    • CalibrationStatus.result()
    • CalibrationStatus.running
    • CalibrationStatus.trace_goal_function_value()
    • CalibrationStatus.trace_goal_function_values
    • CalibrationStatus.trace_parameter()
    • CalibrationStatus.trace_size
  • ParameterOptimizer
    • ParameterOptimizer.__init__()
    • ParameterOptimizer.fx
    • ParameterOptimizer.goal_function()
    • ParameterOptimizer.optimize()
    • ParameterOptimizer.p_max
    • ParameterOptimizer.p_min
  • 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
    • SnowTilesState.__init__()
    • SnowTilesState.fw
    • SnowTilesState.lw
  • SnowTilesCalculator
    • SnowTilesCalculator.__init__()
    • SnowTilesCalculator.step()
  • SnowTilesResponse
    • SnowTilesResponse.__init__()
    • SnowTilesResponse.outflow
    • SnowTilesResponse.sca
    • SnowTilesResponse.swe
  • percentiles()

Energy Market

• Installation
• Concepts
  • What is an energy market?
• Tutorials
• Examples
• API Documentation
  • Core
    • IdBase
      • IdBase.__init__()
      • IdBase.custom
      • IdBase.get_tsm_object()
      • IdBase.id
      • IdBase.json
      • IdBase.name
      • IdBase.obj
      • IdBase.ts
    • Catchment
      • Catchment.__init__()
      • Catchment.hps
    • CatchmentList
      • CatchmentList.__init__()
      • CatchmentList.append()
      • CatchmentList.extend()
      • CatchmentList.get_item_old()
      • CatchmentList.items()
      • CatchmentList.keys()
      • CatchmentList.values()
    • Client
      • Client.__init__()
      • Client.close()
      • Client.get_model_infos()
      • Client.host_port
      • Client.is_open
      • Client.read_model()
      • Client.read_models()
      • Client.reconnect_count
      • Client.remove_model()
      • Client.store_model()
      • Client.timeout_ms
      • Client.update_model_info()
    • ConnectionRole
      • ConnectionRole.bypass
      • ConnectionRole.flood
      • ConnectionRole.input
      • ConnectionRole.main
      • ConnectionRole.names
      • ConnectionRole.values
    • Gate
      • Gate.__init__()
      • Gate.water_route
      • Gate.waterway
    • GateList
      • GateList.__init__()
      • GateList.append()
      • GateList.extend()
      • GateList.get_item_old()
      • GateList.items()
      • GateList.keys()
      • GateList.values()
    • HydroComponent
      • HydroComponent.__init__()
      • HydroComponent.disconnect_from()
      • HydroComponent.downstreams
      • HydroComponent.equal_structure()
      • HydroComponent.hps
      • HydroComponent.upstreams
    • HydroComponentList
      • HydroComponentList.__init__()
      • HydroComponentList.append()
      • HydroComponentList.extend()
      • HydroComponentList.get_item_old()
      • HydroComponentList.items()
      • HydroComponentList.keys()
      • HydroComponentList.values()
    • HydroConnection
      • HydroConnection.__init__()
      • HydroConnection.has_target
      • HydroConnection.role
      • HydroConnection.target
    • HydroConnectionList
      • HydroConnectionList.__init__()
      • HydroConnectionList.append()
      • HydroConnectionList.extend()
    • HydroGraphTraversal
      • HydroGraphTraversal.__init__()
      • HydroGraphTraversal.extract_water_courses()
      • HydroGraphTraversal.get_path_between()
      • HydroGraphTraversal.get_path_to_ocean()
      • HydroGraphTraversal.is_connected()
      • HydroGraphTraversal.path_to_ocean()
    • 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.model_area
      • 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
      • HydroPowerSystemDict.__init__()
      • HydroPowerSystemDict.items()
      • HydroPowerSystemDict.keys()
    • HydroPowerSystemList
      • HydroPowerSystemList.__init__()
      • HydroPowerSystemList.append()
      • HydroPowerSystemList.extend()
      • HydroPowerSystemList.get_item_old()
      • HydroPowerSystemList.items()
      • HydroPowerSystemList.keys()
      • HydroPowerSystemList.values()
    • IntStringDict
      • IntStringDict.__init__()
    • StringTimeSeriesDict
      • StringTimeSeriesDict.__init__()
    • Model
      • Model.__init__()
      • Model.area
      • Model.create_model_area()
      • Model.create_power_line()
      • Model.create_power_module()
      • Model.created
      • Model.equal_content()
      • Model.equal_structure()
      • Model.from_blob()
      • Model.power_lines
      • Model.to_blob()
    • ModelArea
      • ModelArea.__init__()
      • ModelArea.create_power_module()
      • ModelArea.detailed_hydro
      • ModelArea.equal_structure()
      • ModelArea.model
      • ModelArea.power_modules
    • ModelAreaDict
      • ModelAreaDict.__init__()
    • ModelBuilder
      • ModelBuilder.__init__()
      • ModelBuilder.create_model_area()
      • ModelBuilder.create_power_line()
      • ModelBuilder.create_power_module()
    • ModelInfo
      • ModelInfo.__init__()
      • ModelInfo.created
      • ModelInfo.id
      • ModelInfo.json
      • ModelInfo.name
    • ModelInfoVector
      • ModelInfoVector.__init__()
      • ModelInfoVector.append()
      • ModelInfoVector.extend()
    • ModelList
      • ModelList.__init__()
      • ModelList.append()
      • ModelList.extend()
      • ModelList.get_item_old()
      • ModelList.items()
      • ModelList.keys()
      • ModelList.values()
    • Point
      • Point.__init__()
      • Point.x
      • Point.y
    • PointList
      • PointList.__init__()
      • PointList.append()
      • PointList.extend()
    • PowerLine
      • PowerLine.__init__()
      • PowerLine.area_1
      • PowerLine.area_2
      • PowerLine.equal_structure()
      • PowerLine.model
    • PowerLineList
      • PowerLineList.__init__()
      • PowerLineList.append()
      • PowerLineList.extend()
      • PowerLineList.get_item_old()
      • PowerLineList.items()
      • PowerLineList.keys()
      • PowerLineList.values()
    • PowerModule
      • PowerModule.__init__()
      • PowerModule.area
    • PowerModuleDict
      • PowerModuleDict.__init__()
      • PowerModuleDict.get_item_old()
      • PowerModuleDict.items()
      • PowerModuleDict.keys()
      • PowerModuleDict.values()
    • PowerPlant
      • PowerPlant.__init__()
      • PowerPlant.add_aggregate()
      • PowerPlant.add_unit()
      • PowerPlant.aggregates
      • PowerPlant.hps
      • PowerPlant.remove_aggregate()
      • PowerPlant.remove_unit()
      • PowerPlant.units
    • PowerPlantList
      • PowerPlantList.__init__()
      • PowerPlantList.append()
      • PowerPlantList.extend()
      • PowerPlantList.get_item_old()
      • PowerPlantList.items()
      • PowerPlantList.keys()
      • PowerPlantList.values()
    • Reservoir
      • Reservoir.__init__()
      • Reservoir.input_from()
      • Reservoir.output_to()
    • ReservoirList
      • ReservoirList.__init__()
      • ReservoirList.append()
      • ReservoirList.extend()
      • ReservoirList.get_item_old()
      • ReservoirList.items()
      • ReservoirList.keys()
      • ReservoirList.values()
    • Run
      • Run.__init__()
      • Run.created
      • Run.id
      • Run.json
      • Run.mid
      • Run.name
      • Run.state
    • RunClient
      • RunClient.__init__()
      • RunClient.close()
      • RunClient.get_model_infos()
      • RunClient.host_port
      • RunClient.is_open
      • RunClient.read_model()
      • RunClient.read_models()
      • RunClient.reconnect_count
      • RunClient.remove_model()
      • RunClient.store_model()
      • RunClient.timeout_ms
      • RunClient.update_model_info()
    • RunServer
      • RunServer.__init__()
      • RunServer.get_listening_port()
      • RunServer.get_max_connections()
      • RunServer.is_running()
      • RunServer.set_listening_ip()
      • RunServer.set_listening_port()
      • RunServer.set_max_connections()
      • RunServer.start_server()
      • RunServer.stop_server()
    • RunVector
      • RunVector.__init__()
      • RunVector.append()
      • RunVector.extend()
    • Server
      • Server.__init__()
      • Server.get_listening_port()
      • Server.get_max_connections()
      • Server.is_running()
      • Server.set_listening_ip()
      • Server.set_listening_port()
      • Server.set_max_connections()
      • Server.start_server()
      • Server.stop_server()
    • TurbineCapability
      • TurbineCapability.names
      • TurbineCapability.turbine_backward
      • TurbineCapability.turbine_forward
      • TurbineCapability.turbine_none
      • TurbineCapability.turbine_reversible
      • TurbineCapability.values
    • TurbineDescription
      • TurbineDescription.__init__()
      • TurbineDescription.capability()
      • TurbineDescription.get_operating_zone()
      • TurbineDescription.operating_zones
    • TurbineOperatingZone
      • TurbineOperatingZone.__init__()
      • TurbineOperatingZone.efficiency_curves
      • TurbineOperatingZone.evaluate()
      • TurbineOperatingZone.fcr_max
      • TurbineOperatingZone.fcr_min
      • TurbineOperatingZone.production_max
      • TurbineOperatingZone.production_min
      • TurbineOperatingZone.production_nominal
    • TurbineOperatingZoneList
      • TurbineOperatingZoneList.__init__()
      • TurbineOperatingZoneList.append()
      • TurbineOperatingZoneList.extend()
    • Unit
      • Unit.__init__()
      • Unit.downstream
      • Unit.input_from()
      • Unit.is_pump
      • Unit.output_to()
      • Unit.power_plant
      • Unit.power_station
      • Unit.upstream
    • UnitList
      • UnitList.__init__()
      • UnitList.append()
      • UnitList.extend()
      • UnitList.get_item_old()
      • UnitList.items()
      • UnitList.keys()
      • UnitList.values()
    • Waterway
      • Waterway.__init__()
      • Waterway.add_gate()
      • Waterway.downstream
      • Waterway.gates
      • Waterway.input_from()
      • Waterway.output_to()
      • Waterway.remove_gate()
      • Waterway.upstream
      • Waterway.upstream_role
    • WaterwayList
      • WaterwayList.__init__()
      • WaterwayList.append()
      • WaterwayList.extend()
      • WaterwayList.get_item_old()
      • WaterwayList.items()
      • WaterwayList.keys()
      • WaterwayList.values()
    • XyPointCurve
      • XyPointCurve.__init__()
      • XyPointCurve.calculate_x()
      • XyPointCurve.calculate_y()
      • XyPointCurve.is_convex()
      • XyPointCurve.is_mono_increasing()
      • XyPointCurve.points
      • XyPointCurve.x_max()
      • XyPointCurve.x_min()
      • XyPointCurve.y_max()
      • XyPointCurve.y_min()
    • XyPointCurveList
      • XyPointCurveList.__init__()
      • XyPointCurveList.append()
      • XyPointCurveList.extend()
    • XyPointCurveWithZ
      • XyPointCurveWithZ.__init__()
      • XyPointCurveWithZ.xy_point_curve
      • XyPointCurveWithZ.z
    • 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
      • XyzPointCurve.__init__()
      • XyzPointCurve.curves
      • XyzPointCurve.evaluate()
      • XyzPointCurve.get_curve()
      • XyzPointCurve.gradient()
      • XyzPointCurve.set_curve()
    • compressed_size()
    • points_from_x_y()
    • run_state
      • run_state.R_CREATED
      • run_state.R_FAILED
      • run_state.R_FINISHED_RUN
      • run_state.R_FROZEN
      • run_state.R_PREP_INPUT
      • run_state.R_READ_RESULT
      • run_state.R_RUNNING
      • run_state.names
      • run_state.values
    • 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.from_stripped_blob()
      • HydroPowerSystem.reservoir_aggregates
      • HydroPowerSystem.system
      • HydroPowerSystem.to_blob()
      • HydroPowerSystem.to_stripped_blob()
    • HydroPowerSystemList
      • HydroPowerSystemList.__init__()
      • HydroPowerSystemList.append()
      • HydroPowerSystemList.extend()
    • StmSystem
      • StmSystem.__init__()
      • StmSystem.add_unit_group()
      • StmSystem.contract_portfolios
      • StmSystem.contracts
      • StmSystem.create_hydro_power_system()
      • StmSystem.create_market_area()
      • StmSystem.create_network()
      • StmSystem.create_power_module()
      • StmSystem.create_wind_farm()
      • StmSystem.fix_uplinks()
      • StmSystem.from_blob()
      • StmSystem.from_stripped_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.to_stripped_blob()
      • StmSystem.unit_groups
      • StmSystem.wind_farms
    • StmSystemList
      • StmSystemList.__init__()
      • StmSystemList.append()
      • StmSystemList.extend()
    • StmPatchOperation
      • StmPatchOperation.ADD
      • StmPatchOperation.REMOVE_OBJECTS
      • StmPatchOperation.REMOVE_RELATIONS
      • StmPatchOperation.names
      • StmPatchOperation.values
    • MarketArea
      • MarketArea.Offering
        • MarketArea.Offering.__init__()
        • MarketArea.Offering.bids
        • MarketArea.Offering.price
        • MarketArea.Offering.usage
      • MarketArea.TsTriplet
        • MarketArea.TsTriplet.__init__()
        • MarketArea.TsTriplet.realised
        • MarketArea.TsTriplet.result
        • MarketArea.TsTriplet.schedule
      • MarketArea.TsTripletResult
        • MarketArea.TsTripletResult.__init__()
        • MarketArea.TsTripletResult.realised
        • MarketArea.TsTripletResult.result
        • MarketArea.TsTripletResult.schedule
      • 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.load
      • MarketArea.max_buy
      • MarketArea.max_sale
      • MarketArea.price
      • MarketArea.production
      • MarketArea.remove_unit_group()
      • MarketArea.reserve_obligation_penalty
      • MarketArea.sale
      • MarketArea.supply
      • MarketArea.system
      • MarketArea.tag
      • MarketArea.transmission_lines_from()
      • MarketArea.transmission_lines_to()
      • MarketArea.ts
      • MarketArea.unit_group
    • ModelState
      • ModelState.FAILED
      • ModelState.FINISHED
      • ModelState.IDLE
      • ModelState.RUNNING
      • ModelState.TUNING
      • ModelState.names
      • ModelState.values
    • Unit
      • Unit.BestProfit
        • Unit.BestProfit.__init__()
        • Unit.BestProfit.discharge
        • Unit.BestProfit.discharge_production_ratio
        • Unit.BestProfit.operating_zone
        • Unit.BestProfit.production
      • Unit.Cost
        • Unit.Cost.__init__()
        • Unit.Cost.pump_start
        • Unit.Cost.pump_stop
        • Unit.Cost.start
        • Unit.Cost.stop
      • Unit.Discharge
        • Unit.Discharge.Constraint
          • Unit.Discharge.Constraint.__init__()
          • Unit.Discharge.Constraint.max
          • Unit.Discharge.Constraint.max_from_downstream_level
          • Unit.Discharge.Constraint.min
        • Unit.Discharge.__init__()
        • Unit.Discharge.constraint
        • Unit.Discharge.realised
        • Unit.Discharge.result
        • Unit.Discharge.schedule
      • Unit.Production
        • Unit.Production.Constraint
          • Unit.Production.Constraint.__init__()
          • Unit.Production.Constraint.max
          • Unit.Production.Constraint.min
        • Unit.Production.__init__()
        • Unit.Production.commitment
        • Unit.Production.constraint
        • Unit.Production.nominal
        • Unit.Production.pump_commitment
        • Unit.Production.realised
        • Unit.Production.result
        • Unit.Production.schedule
        • Unit.Production.static_max
        • Unit.Production.static_min
      • Unit.ProductionDischargeRelation
        • Unit.ProductionDischargeRelation.__init__()
        • Unit.ProductionDischargeRelation.convex
        • Unit.ProductionDischargeRelation.final
        • Unit.ProductionDischargeRelation.original
      • Unit.PumpConstraint
        • Unit.PumpConstraint.__init__()
        • Unit.PumpConstraint.min_downstream_level
      • Unit.Reserve
        • Unit.Reserve.FcrDroop
          • Unit.Reserve.FcrDroop.__init__()
          • Unit.Reserve.FcrDroop.cost
          • Unit.Reserve.FcrDroop.result
          • Unit.Reserve.FcrDroop.steps
        • Unit.Reserve.Pair
          • Unit.Reserve.Pair.__init__()
          • Unit.Reserve.Pair.down
          • Unit.Reserve.Pair.up
        • Unit.Reserve.Spec
          • Unit.Reserve.Spec.__init__()
          • Unit.Reserve.Spec.cost
          • Unit.Reserve.Spec.max
          • Unit.Reserve.Spec.min
          • Unit.Reserve.Spec.penalty
          • Unit.Reserve.Spec.realised
          • Unit.Reserve.Spec.result
          • Unit.Reserve.Spec.schedule
        • Unit.Reserve.__init__()
        • Unit.Reserve.afrr
        • Unit.Reserve.afrr_static_max
        • Unit.Reserve.afrr_static_min
        • Unit.Reserve.droop
        • Unit.Reserve.droop_steps
        • Unit.Reserve.fcr_d
        • Unit.Reserve.fcr_mip
        • Unit.Reserve.fcr_n
        • Unit.Reserve.fcr_static_max
        • Unit.Reserve.fcr_static_min
        • Unit.Reserve.frr
        • Unit.Reserve.mfrr
        • Unit.Reserve.mfrr_static_min
        • Unit.Reserve.rr
      • 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
      • UnitList.__init__()
      • UnitList.append()
      • UnitList.extend()
    • Reservoir
      • Reservoir.Inflow
        • Reservoir.Inflow.__init__()
        • Reservoir.Inflow.realised
        • Reservoir.Inflow.result
        • Reservoir.Inflow.schedule
      • Reservoir.Level
        • Reservoir.Level.Constraints
          • Reservoir.Level.Constraints.__init__()
          • Reservoir.Level.Constraints.max
          • Reservoir.Level.Constraints.min
        • Reservoir.Level.__init__()
        • Reservoir.Level.constraint
        • Reservoir.Level.realised
        • Reservoir.Level.regulation_max
        • Reservoir.Level.regulation_min
        • Reservoir.Level.result
        • Reservoir.Level.schedule
      • Reservoir.Ramping
        • Reservoir.Ramping.__init__()
        • Reservoir.Ramping.amplitude_down
        • Reservoir.Ramping.amplitude_up
        • Reservoir.Ramping.level_down
        • Reservoir.Ramping.level_up
      • Reservoir.Volume
        • Reservoir.Volume.Constraints
          • Reservoir.Volume.Constraints.Tactical
            • Reservoir.Volume.Constraints.Tactical.__init__()
            • Reservoir.Volume.Constraints.Tactical.max
            • Reservoir.Volume.Constraints.Tactical.min
          • Reservoir.Volume.Constraints.__init__()
          • Reservoir.Volume.Constraints.max
          • Reservoir.Volume.Constraints.min
          • Reservoir.Volume.Constraints.tactical
        • Reservoir.Volume.Cost
          • Reservoir.Volume.Cost.CostCurve
            • Reservoir.Volume.Cost.CostCurve.__init__()
            • Reservoir.Volume.Cost.CostCurve.curve
            • Reservoir.Volume.Cost.CostCurve.penalty
          • Reservoir.Volume.Cost.__init__()
          • Reservoir.Volume.Cost.flood
          • Reservoir.Volume.Cost.peak
        • Reservoir.Volume.Slack
          • Reservoir.Volume.Slack.__init__()
          • Reservoir.Volume.Slack.lower
          • Reservoir.Volume.Slack.upper
        • Reservoir.Volume.__init__()
        • Reservoir.Volume.constraint
        • Reservoir.Volume.penalty
        • Reservoir.Volume.realised
        • Reservoir.Volume.result
        • Reservoir.Volume.schedule
        • Reservoir.Volume.slack
        • Reservoir.Volume.static_max
      • Reservoir.WaterValue
        • Reservoir.WaterValue.Result
          • Reservoir.WaterValue.Result.__init__()
          • Reservoir.WaterValue.Result.end_value
          • Reservoir.WaterValue.Result.global_volume
          • Reservoir.WaterValue.Result.local_energy
          • Reservoir.WaterValue.Result.local_volume
        • Reservoir.WaterValue.__init__()
        • Reservoir.WaterValue.endpoint_desc
        • Reservoir.WaterValue.result
      • Reservoir.__init__()
      • Reservoir.custom
      • Reservoir.flattened_attributes()
      • Reservoir.get_tsm_object()
      • Reservoir.inflow
      • Reservoir.level
      • Reservoir.ramping
      • Reservoir.tag
      • Reservoir.ts
      • Reservoir.volume
      • Reservoir.volume_level_mapping
      • Reservoir.water_value
    • PowerPlant
      • PowerPlant.BestProfit
        • PowerPlant.BestProfit.__init__()
        • PowerPlant.BestProfit.cost_average
        • PowerPlant.BestProfit.cost_commitment
        • PowerPlant.BestProfit.cost_marginal
        • PowerPlant.BestProfit.discharge
        • PowerPlant.BestProfit.dynamic_water_value
      • PowerPlant.Discharge
        • PowerPlant.Discharge.__init__()
        • PowerPlant.Discharge.constraint_max
        • PowerPlant.Discharge.constraint_min
        • PowerPlant.Discharge.downstream_level_constraint
        • PowerPlant.Discharge.intake_loss_from_bypass_flag
        • PowerPlant.Discharge.ramping_down
        • PowerPlant.Discharge.ramping_up
        • PowerPlant.Discharge.realised
        • PowerPlant.Discharge.result
        • PowerPlant.Discharge.schedule
        • PowerPlant.Discharge.upstream_level_constraint
      • PowerPlant.Fees
        • PowerPlant.Fees.__init__()
        • PowerPlant.Fees.feeding_fee
      • PowerPlant.Production
        • PowerPlant.Production.__init__()
        • PowerPlant.Production.constraint_max
        • PowerPlant.Production.constraint_min
        • PowerPlant.Production.instant_max
        • PowerPlant.Production.merge_tolerance
        • PowerPlant.Production.ramping_down
        • PowerPlant.Production.ramping_up
        • PowerPlant.Production.realised
        • PowerPlant.Production.result
        • PowerPlant.Production.schedule
      • 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
      • Gate.Discharge
        • Gate.Discharge.Constraints
          • Gate.Discharge.Constraints.__init__()
          • Gate.Discharge.Constraints.max
          • Gate.Discharge.Constraints.min
        • Gate.Discharge.__init__()
        • Gate.Discharge.constraint
        • Gate.Discharge.merge_tolerance
        • Gate.Discharge.realised
        • Gate.Discharge.result
        • Gate.Discharge.schedule
        • Gate.Discharge.static_max
      • Gate.Opening
        • Gate.Opening.Constraints
          • Gate.Opening.Constraints.__init__()
          • Gate.Opening.Constraints.continuous
          • Gate.Opening.Constraints.positions
        • Gate.Opening.__init__()
        • Gate.Opening.constraint
        • Gate.Opening.realised
        • Gate.Opening.result
        • Gate.Opening.schedule
      • Gate.__init__()
      • Gate.cost
      • Gate.custom
      • Gate.discharge
      • Gate.flattened_attributes()
      • Gate.flow_description
      • Gate.flow_description_delta_h
      • Gate.get_tsm_object()
      • Gate.opening
      • Gate.tag
      • Gate.ts
    • Waterway
      • Waterway.Discharge
        • Waterway.Discharge.Constraints
          • Waterway.Discharge.Constraints.__init__()
          • Waterway.Discharge.Constraints.accumulated_max
          • Waterway.Discharge.Constraints.accumulated_min
          • Waterway.Discharge.Constraints.max
          • Waterway.Discharge.Constraints.max_average
          • Waterway.Discharge.Constraints.min
          • Waterway.Discharge.Constraints.min_average
          • Waterway.Discharge.Constraints.ramping_down
          • Waterway.Discharge.Constraints.ramping_up
        • Waterway.Discharge.Penalties
          • Waterway.Discharge.Penalties.Costs
            • Waterway.Discharge.Penalties.Costs.__init__()
            • Waterway.Discharge.Penalties.Costs.accumulated_max
            • Waterway.Discharge.Penalties.Costs.accumulated_min
            • Waterway.Discharge.Penalties.Costs.constraint_max
            • Waterway.Discharge.Penalties.Costs.constraint_min
            • Waterway.Discharge.Penalties.Costs.max_average
            • Waterway.Discharge.Penalties.Costs.min_average
            • Waterway.Discharge.Penalties.Costs.peak_curve
            • Waterway.Discharge.Penalties.Costs.ramping_down
            • Waterway.Discharge.Penalties.Costs.ramping_up
            • Waterway.Discharge.Penalties.Costs.rate
          • Waterway.Discharge.Penalties.Results
            • Waterway.Discharge.Penalties.Results.__init__()
            • Waterway.Discharge.Penalties.Results.accumulated_max
            • Waterway.Discharge.Penalties.Results.accumulated_min
            • Waterway.Discharge.Penalties.Results.constraint_max
            • Waterway.Discharge.Penalties.Results.constraint_min
            • Waterway.Discharge.Penalties.Results.ramping_down
            • Waterway.Discharge.Penalties.Results.ramping_up
            • Waterway.Discharge.Penalties.Results.rate
          • Waterway.Discharge.Penalties.__init__()
          • Waterway.Discharge.Penalties.cost
          • Waterway.Discharge.Penalties.result
        • Waterway.Discharge.__init__()
        • Waterway.Discharge.constraint
        • Waterway.Discharge.penalty
        • Waterway.Discharge.realised
        • Waterway.Discharge.reference
        • Waterway.Discharge.result
        • Waterway.Discharge.schedule
        • Waterway.Discharge.static_max
      • Waterway.FlowDescription
        • Waterway.FlowDescription.DeltaMeter
          • Waterway.FlowDescription.DeltaMeter.__init__()
          • Waterway.FlowDescription.DeltaMeter.downstream_ref
          • Waterway.FlowDescription.DeltaMeter.upstream_ref
        • Waterway.FlowDescription.__init__()
        • Waterway.FlowDescription.delta_meter
        • Waterway.FlowDescription.upstream_ref
      • Waterway.Geometry
        • Waterway.Geometry.__init__()
        • Waterway.Geometry.diameter
        • Waterway.Geometry.length
        • Waterway.Geometry.z0
        • Waterway.Geometry.z1
      • Waterway.__init__()
      • Waterway.add_gate()
      • Waterway.custom
      • Waterway.delay
      • Waterway.deviation
      • Waterway.discharge
      • Waterway.flattened_attributes()
      • Waterway.flow_description
      • Waterway.geometry
      • Waterway.get_tsm_object()
      • Waterway.head_loss_coeff
      • Waterway.head_loss_func
      • Waterway.tag
      • Waterway.ts
    • 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.Delivery
        • UnitGroup.Delivery.__init__()
        • UnitGroup.Delivery.realised
        • UnitGroup.Delivery.result
        • UnitGroup.Delivery.schedule
      • UnitGroup.Member
        • UnitGroup.Member.__init__()
        • UnitGroup.Member.active
        • UnitGroup.Member.unit
      • UnitGroup.MemberList
        • UnitGroup.MemberList.__init__()
        • UnitGroup.MemberList.append()
        • UnitGroup.MemberList.extend()
      • UnitGroup.Obligation
        • UnitGroup.Obligation.__init__()
        • UnitGroup.Obligation.cost
        • UnitGroup.Obligation.penalty
        • UnitGroup.Obligation.result
        • UnitGroup.Obligation.schedule
      • UnitGroup.__init__()
      • UnitGroup.add_unit()
      • UnitGroup.custom
      • UnitGroup.delivery
      • UnitGroup.flattened_attributes()
      • UnitGroup.flow
      • UnitGroup.get_tsm_object()
      • UnitGroup.group_type
      • UnitGroup.market_area
      • UnitGroup.members
      • UnitGroup.obj
      • UnitGroup.obligation
      • UnitGroup.production
      • UnitGroup.remove_unit()
      • UnitGroup.tag
      • UnitGroup.ts
    • t_xy
      • t_xy.__call__()
      • t_xy.__init__()
    • t_turbine_description
      • t_turbine_description.__call__()
      • t_turbine_description.__init__()
    • MessageList
      • MessageList.__init__()
      • MessageList.append()
      • MessageList.exists
      • MessageList.extend()
    • t_xyz_list
      • t_xyz_list.__call__()
      • t_xyz_list.__init__()
    • t_xyz
      • t_xyz.__call__()
      • t_xyz.__init__()
    • 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
      • HpsClient.__init__()
      • HpsClient.close()
      • HpsClient.get_model_infos()
      • HpsClient.host_port
      • HpsClient.is_open
      • HpsClient.read_model()
      • HpsClient.read_models()
      • HpsClient.reconnect_count
      • HpsClient.remove_model()
      • HpsClient.store_model()
      • HpsClient.timeout_ms
      • HpsClient.update_model_info()
    • HpsServer
      • HpsServer.__init__()
      • HpsServer.get_listening_port()
      • HpsServer.get_max_connections()
      • HpsServer.is_running()
      • HpsServer.set_listening_ip()
      • HpsServer.set_listening_port()
      • HpsServer.set_max_connections()
      • HpsServer.start_server()
      • HpsServer.stop_server()
    • StmClient
      • StmClient.__init__()
      • StmClient.close()
      • StmClient.get_model_infos()
      • StmClient.host_port
      • StmClient.is_open
      • StmClient.read_model()
      • StmClient.read_models()
      • StmClient.reconnect_count
      • StmClient.remove_model()
      • StmClient.store_model()
      • StmClient.timeout_ms
      • StmClient.update_model_info()
    • StmServer
      • StmServer.__init__()
      • StmServer.get_listening_port()
      • StmServer.get_max_connections()
      • StmServer.is_running()
      • StmServer.set_listening_ip()
      • StmServer.set_listening_port()
      • StmServer.set_max_connections()
      • StmServer.start_server()
      • StmServer.stop_server()
    • 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
      • StmCase.__init__()
      • StmCase.add_model_ref()
      • StmCase.created
      • StmCase.get_model_ref()
      • StmCase.id
      • StmCase.json
      • StmCase.labels
      • StmCase.model_refs
      • StmCase.name
      • StmCase.remove_model_ref()
    • ModelRefList
      • ModelRefList.__init__()
      • ModelRefList.append()
      • ModelRefList.extend()
    • StmModelRef
      • StmModelRef.__init__()
      • StmModelRef.api_port_num
      • StmModelRef.host
      • StmModelRef.model_key
      • StmModelRef.port_num
    • StmTask
      • StmTask.__init__()
      • StmTask.add_case()
      • StmTask.base_model
      • StmTask.cases
      • StmTask.created
      • StmTask.get_case()
      • StmTask.id
      • StmTask.json
      • StmTask.labels
      • StmTask.name
      • StmTask.remove_case()
      • StmTask.task_name
      • StmTask.update_case()
    • Contract
      • Contract.Constraint
        • Contract.Constraint.__init__()
        • Contract.Constraint.max_trade
        • Contract.Constraint.min_trade
        • Contract.Constraint.ramping_down
        • Contract.Constraint.ramping_down_penalty_cost
        • Contract.Constraint.ramping_up
        • Contract.Constraint.ramping_up_penalty_cost
      • Contract.ContractRelation
        • Contract.ContractRelation.__init__()
        • Contract.ContractRelation.id
        • Contract.ContractRelation.owner
        • Contract.ContractRelation.related
        • Contract.ContractRelation.relation_type
      • Contract.ContractRelationList
        • Contract.ContractRelationList.__init__()
        • Contract.ContractRelationList.append()
        • Contract.ContractRelationList.extend()
      • 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.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
      • ContractList.__init__()
      • ContractList.append()
      • ContractList.extend()
    • 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
      • ContractPortfolioList.__init__()
      • ContractPortfolioList.append()
      • ContractPortfolioList.extend()
    • PowerModule
      • PowerModule.Power
        • PowerModule.Power.__init__()
        • PowerModule.Power.realised
        • PowerModule.Power.result
        • PowerModule.Power.schedule
      • PowerModule.__init__()
      • PowerModule.custom
      • PowerModule.flattened_attributes()
      • PowerModule.get_tsm_object()
      • PowerModule.power
      • PowerModule.system
      • PowerModule.tag
      • PowerModule.ts
    • Busbar
      • Busbar.TsTriplet
        • Busbar.TsTriplet.__init__()
        • Busbar.TsTriplet.realised
        • Busbar.TsTriplet.result
        • Busbar.TsTriplet.schedule
      • 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.network
      • 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
      • Network.__init__()
      • Network.busbars
      • Network.create_busbar()
      • Network.create_transmission_line()
      • Network.custom
      • Network.get_tsm_object()
      • Network.system
      • Network.tag
      • Network.transmission_lines
      • Network.ts
    • TransmissionLine
      • TransmissionLine.__init__()
      • TransmissionLine.capacity
      • TransmissionLine.custom
      • TransmissionLine.flattened_attributes()
      • TransmissionLine.from_bb
      • TransmissionLine.get_tsm_object()
      • TransmissionLine.network
      • TransmissionLine.tag
      • TransmissionLine.to_bb
      • TransmissionLine.ts
    • WindFarm
      • WindFarm.Production
        • WindFarm.Production.__init__()
        • WindFarm.Production.forecast
        • WindFarm.Production.realised
        • WindFarm.Production.result
      • WindFarm.__init__()
      • WindFarm.custom
      • WindFarm.flattened_attributes()
      • WindFarm.get_tsm_object()
      • WindFarm.production
      • WindFarm.system
      • WindFarm.tag
      • WindFarm.ts
    • compute_effective_price()
    • UrlResolveError
      • UrlResolveError.__init__()
      • UrlResolveError.what
  • STM Compute and Shop
    • Client
      • Client.__init__()
      • Client.send()
    • GetAttrsReply
      • GetAttrsReply.__init__()
      • GetAttrsReply.attrs
    • GetAttrsRequest
      • GetAttrsRequest.__init__()
      • GetAttrsRequest.urls
    • GetPlanReply
      • GetPlanReply.__init__()
      • GetPlanReply.summary
    • GetPlanRequest
      • GetPlanRequest.__init__()
    • GetStatusReply
      • GetStatusReply.__init__()
      • GetStatusReply.log
      • GetStatusReply.state
    • GetStatusRequest
      • GetStatusRequest.__init__()
      • GetStatusRequest.log_index
    • ManagedServerState
      • ManagedServerState.ASSIGNED
      • ManagedServerState.BUSY
      • ManagedServerState.DEAD
      • ManagedServerState.IDLE
      • ManagedServerState.names
      • ManagedServerState.values
    • PlanReply
      • PlanReply.__init__()
    • PlanRequest
      • PlanRequest.__init__()
      • PlanRequest.commands
      • PlanRequest.time_axis
    • Server
      • Server.__init__()
      • Server.close()
      • Server.get_listening_ip()
      • Server.get_listening_port()
      • Server.is_running()
      • Server.set_listening_ip()
      • Server.set_listening_port()
      • Server.start_server()
      • Server.stop_server()
    • ServerStatus
      • ServerStatus.__init__()
      • ServerStatus.address
      • ServerStatus.last_send
      • ServerStatus.model_id
      • ServerStatus.state
    • ServerStatusVector
      • ServerStatusVector.__init__()
      • ServerStatusVector.append()
      • ServerStatusVector.extend()
    • SetAttrsReply
      • SetAttrsReply.__init__()
      • SetAttrsReply.attrs
    • SetAttrsRequest
      • SetAttrsRequest.__init__()
      • SetAttrsRequest.attrs
    • StartReply
      • StartReply.__init__()
    • StartRequest
      • StartRequest.__init__()
      • StartRequest.model
      • StartRequest.model_id
    • State
      • State.DONE
      • State.IDLE
      • State.RUNNING
      • State.STARTED
      • State.names
      • State.values
    • StopReply
      • StopReply.__init__()
    • StopRequest
      • StopRequest.__init__()
  • 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
      • ShopCommandList.__init__()
      • ShopCommandList.append()
      • ShopCommandList.extend()
    • 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
      • ItemDataProperty.DataX
      • ItemDataProperty.DataY
      • ItemDataProperty.Decimals
      • ItemDataProperty.ScaleX
      • ItemDataProperty.ScaleY
      • ItemDataProperty.Tags
      • ItemDataProperty.ValidationX
      • ItemDataProperty.ValidationY
      • ItemDataProperty.names
      • ItemDataProperty.values
    • LayoutInfo
      • LayoutInfo.__init__()
      • LayoutInfo.id
      • LayoutInfo.json
      • LayoutInfo.name
    • 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()

Dashboard

• Installation
• Concepts
  • Introduction
  • Core Philosophy
  • Project structure
  • Some (core) concepts in depth
    • Model-View-Presenter abstraction
    • App
    • Entry Points
    • Widget
    • Ports
    • Selectors
    • Time Series Viewer
• Tutorials
  • Prerequisites
• Examples
  • shyft.dashboard.examples
    • shyft.dashboard.examples
      • shyft.dashboard.examples.app
        • MyApp
          • MyApp.__init__()
          • MyApp.layout
          • MyApp.layout_components
          • MyApp.on_click_toggle()
      • shyft.dashboard.examples.basic_bokeh_app
        • BasicBokeh
          • BasicBokeh.__init__()
          • BasicBokeh.name
          • BasicBokeh.get_layout()
      • shyft.dashboard.examples.date_selector
        • DateSelectorExample
          • DateSelectorExample.__init__()
          • DateSelectorExample.name
          • DateSelectorExample.get_layout()
      • shyft.dashboard.examples.figure_legend
        • TsAdapterSine
          • TsAdapterSine.__init__()
          • TsAdapterSine.ts
          • TsAdapterSine.__call__()
        • MultiTsAdapterSine
          • MultiTsAdapterSine.__init__()
          • MultiTsAdapterSine.tsv
          • MultiTsAdapterSine.__call__()
        • FigureLegend
          • FigureLegend.__init__()
          • FigureLegend.name
          • FigureLegend.get_layout()
      • shyft.dashboard.examples.gates
        • CompGatesExample
          • CompGatesExample.__init__()
          • CompGatesExample.name
          • CompGatesExample.get_layout()
      • shyft.dashboard.examples.hover_tool
        • HoverToolExample
          • HoverToolExample.__init__()
          • HoverToolExample.name
          • HoverToolExample.get_layout()
      • shyft.dashboard.examples.label_selector
        • LabelSelectorExample
          • LabelSelectorExample.__init__()
          • LabelSelectorExample.name
          • LabelSelectorExample.get_layout()
      • shyft.dashboard.examples.message_viewer
        • MessageViewerExample
          • MessageViewerExample.__init__()
          • MessageViewerExample.name
          • MessageViewerExample.get_layout()
      • shyft.dashboard.examples.multi_select_tabs
        • MultiSelectTabsExample
          • MultiSelectTabsExample.__init__()
          • MultiSelectTabsExample.name
          • MultiSelectTabsExample.get_layout()
      • shyft.dashboard.examples.ports
      • shyft.dashboard.examples.selector_model
        • TimesElevenPlusFiveSelector
          • TimesElevenPlusFiveSelector.__init__()
          • TimesElevenPlusFiveSelector.on_change_selected()
          • TimesElevenPlusFiveSelector.process_selection_evaluation()
          • TimesElevenPlusFiveSelector.loading_function()
        • CompSelectorModelExample
          • CompSelectorModelExample.__init__()
          • CompSelectorModelExample.name
          • CompSelectorModelExample.get_layout()
      • shyft.dashboard.examples.selector_views
        • CompSelectorViewsExample
          • CompSelectorViewsExample.__init__()
          • CompSelectorViewsExample.name
          • CompSelectorViewsExample.get_layout()
      • shyft.dashboard.examples.slider_selector
        • SliderSelectorExample
          • SliderSelectorExample.__init__()
          • SliderSelectorExample.name
          • SliderSelectorExample.get_layout()
      • shyft.dashboard.examples.test_data_generator
        • ExampleTsAdapterSine
          • ExampleTsAdapterSine.__init__()
          • ExampleTsAdapterSine.__call__()
      • shyft.dashboard.examples.time_interval_selector_slider
        • TimeIntervalSliderExample
          • TimeIntervalSliderExample.__init__()
          • TimeIntervalSliderExample.name
          • TimeIntervalSliderExample.get_layout()
      • shyft.dashboard.examples.time_series_period_selector
        • TsPeriodSelectorExample
          • TsPeriodSelectorExample.__init__()
          • TsPeriodSelectorExample.name
          • TsPeriodSelectorExample.get_layout()
      • shyft.dashboard.examples.time_series_scatter_renderer
        • TsScatterViewerExample
          • TsScatterViewerExample.__init__()
          • TsScatterViewerExample.name
          • TsScatterViewerExample.get_layout()
      • shyft.dashboard.examples.time_series_viewer
        • DsViewHandleGenerator
          • DsViewHandleGenerator.__init__()
          • DsViewHandleGenerator.create_and_send_ds_view_handle()
          • DsViewHandleGenerator.remove_ds_view_handle()
        • TsViewerExample
          • TsViewerExample.__init__()
          • TsViewerExample.name
          • TsViewerExample.get_layout()
      • shyft.dashboard.examples.ts_viewer_background_data_renderer
        • ExampleTsAdapterBackgroundData
          • ExampleTsAdapterBackgroundData.__init__()
          • ExampleTsAdapterBackgroundData.__call__()
        • BackgroundDataRendererExample
          • BackgroundDataRendererExample.__init__()
          • BackgroundDataRendererExample.name
          • BackgroundDataRendererExample.get_layout()
      • shyft.dashboard.examples.view_period_selector
    • shyft.dashboard.apps
      • shyft.dashboard.apps.dtss_viewer
        • shyft.dashboard.apps.dtss_viewer.dtsc_helper_functions
          • check_dtss_url()
          • try_dtss_connection()
          • detect_unit_of()
          • find_all_ts_names_and_url()
          • DtssTsAdapter
            • DtssTsAdapter.__init__()
            • DtssTsAdapter.__call__()
        • shyft.dashboard.apps.dtss_viewer.dtss_viewer_app
          • DtssViewerApp
            • DtssViewerApp.__init__()
            • DtssViewerApp.name
            • DtssViewerApp.get_layout()
        • shyft.dashboard.apps.dtss_viewer.widgets
          • ContainerPathReceiver
            • ContainerPathReceiver.__init__()
            • ContainerPathReceiver.layout
            • ContainerPathReceiver.layout_components
            • ContainerPathReceiver.changed_value_dtss_url()
            • ContainerPathReceiver.changed_pattern()
            • ContainerPathReceiver.changed_value_shyft_container()
          • TsSelector
            • TsSelector.__init__()
            • TsSelector.get_options()
            • TsSelector.update_list()
            • TsSelector.on_change_selected()
          • TsViewDemo
            • TsViewDemo.__init__()
            • TsViewDemo.find_y_axis_for_unit()
      • shyft.dashboard.apps.start_bokeh_apps
        • start_local_demo_dtss()
      • shyft.dashboard.apps.water_route_app
        • shyft.dashboard.apps.water_route_app.example_hps
          • get_example_hps()
        • shyft.dashboard.apps.water_route_app.simplified_water_route
          • SimplifiedWaterRouteGraph
            • SimplifiedWaterRouteGraph.get_next_node_downstream()
            • SimplifiedWaterRouteGraph.generate_graph()
        • shyft.dashboard.apps.water_route_app.water_route_app
          • WaterRouteApp
            • WaterRouteApp.__init__()
            • WaterRouteApp.name
            • WaterRouteApp.get_layout()
    • shyft.dashboard.entry_points
      • shyft.dashboard.entry_points.entry_points
        • parse_entry_points_for_apps()
      • shyft.dashboard.entry_points.start_bokeh_examples
        • main()
      • shyft.dashboard.entry_points.visualize_apps
        • main()
• API Documentation
  • shyft.dashboard
    • shyft.dashboard.base
      • shyft.dashboard.base.app
        • AppBase
          • AppBase.__init__()
          • AppBase.name
          • AppBase.get_layout()
        • make_document()
        • start_bokeh_apps()
        • update_value_factory()
        • Widget
          • Widget.__init__()
          • Widget.layout
          • Widget.layout_components
          • Widget.update_value_factory()
      • shyft.dashboard.base.constants
      • shyft.dashboard.base.gate_model
        • GateError
        • GateState
          • GateState.Open
          • GateState.Closed
        • GateBase
          • GateBase.__init__()
          • GateBase.open()
          • GateBase.close()
        • SingleGate
          • SingleGate.__init__()
          • SingleGate.open()
          • SingleGate.close()
        • AggregatedGate
          • AggregatedGate.__init__()
          • AggregatedGate.open()
          • AggregatedGate.close()
      • shyft.dashboard.base.gate_presenter
        • GatePresenter
          • GatePresenter.__init__()
      • shyft.dashboard.base.hashable
        • Hashable
          • Hashable.__init__()
          • Hashable.uid
      • shyft.dashboard.base.ports
        • PortError
        • PortConnectionError
        • PortConnectionWarning
        • States
          • States.LOADING
          • States.INVALID
          • States.READY
          • States.ACTIVE
          • States.DEACTIVE
          • States.PROCESSING
          • States.EXPECTING_DATA
        • ReceiverFunc
          • ReceiverFunc.__init__()
          • ReceiverFunc.__call__()
        • ReceiverFunc.self.timestamp
        • SenderFunc
          • SenderFunc.__init__()
          • SenderFunc.__call__()
        • SenderFunc.self.timestamp
        • PortTypes
          • PortTypes.SENDER
          • PortTypes.RECEIVER
        • PortBase
          • PortBase.__init__()
          • PortBase.__call__()
          • PortBase.signal_type
          • PortBase.connected
        • Receiver
          • Receiver.__init__()
        • Sender
          • Sender.__init__()
          • Sender.connect()
          • Sender.disconnect()
        • check_port_compatibility()
        • connect_ports()
        • disconnect_ports()
        • StatePorts
          • StatePorts.__init__()
        • grep_ports()
        • connect_state_ports()
        • connect_ports_and_state_ports()
      • shyft.dashboard.base.selector_model
        • processing_wrapper()
        • SelectorModelBase
          • SelectorModelBase.__init__()
          • SelectorModelBase.on_change_selected()
        • BasicSelector
          • BasicSelector.__init__()
          • BasicSelector.on_change_selected()
        • TextInputModelBase
          • TextInputModelBase.__init__()
          • TextInputModelBase.on_change_text_input()
      • shyft.dashboard.base.selector_presenter
        • SelectorPresenterError
        • SelectorPresenter
          • SelectorPresenter.__init__()
          • SelectorPresenter.set_selector_value()
          • SelectorPresenter.set_selector_options()
          • SelectorPresenter.selector_options
        • TextInputPresenter
          • TextInputPresenter.__init__()
      • shyft.dashboard.base.selector_views
        • SelectorViewBase
          • SelectorViewBase.__init__()
          • SelectorViewBase.layout_components
          • SelectorViewBase.width
          • SelectorViewBase.layout
        • calculate_layout_width()
        • TwoSelect
          • TwoSelect.__init__()
          • TwoSelect.layout
          • TwoSelect.layout_components
          • TwoSelect.disabled
          • TwoSelect.width
        • FilterMultiSelect
          • FilterMultiSelect.__init__()
          • FilterMultiSelect.layout
          • FilterMultiSelect.layout_components
          • FilterMultiSelect.disabled
          • FilterMultiSelect.width
        • BokehViewBase
          • BokehViewBase.__init__()
          • BokehViewBase.layout
          • BokehViewBase.disabled
          • BokehViewBase.layout_components
          • BokehViewBase.width
        • Select
          • Select.__init__()
        • MultiSelect
          • MultiSelect.__init__()
        • AutocompleteInput
          • AutocompleteInput.__init__()
        • GroupBokehViewBase
          • GroupBokehViewBase.__init__()
          • GroupBokehViewBase.layout
          • GroupBokehViewBase.layout_components
        • RadioGroupBokehViewBase
          • RadioGroupBokehViewBase.__init__()
        • RadioButtonGroup
          • RadioButtonGroup.__init__()
        • RadioGroup
          • RadioGroup.__init__()
        • CheckboxGroupBokehViewBase
          • CheckboxGroupBokehViewBase.__init__()
        • CheckboxGroup
          • CheckboxGroup.__init__()
        • CheckboxButtonGroup
          • CheckboxButtonGroup.__init__()
        • TextInput
          • TextInput.__init__()
          • TextInput.layout
          • TextInput.layout_components
          • TextInput.on_change()
    • shyft.dashboard.time_series
      • shyft.dashboard.time_series.attr_callback_manager
        • AttributeCallbackManager
          • AttributeCallbackManager.__init__()
          • AttributeCallbackManager.on_change()
          • AttributeCallbackManager.remove_all_callbacks()
      • shyft.dashboard.time_series.axes
        • YAxisError
        • YAxisSide
          • YAxisSide.LEFT
          • YAxisSide.RIGHT
        • YAxis
          • YAxis.__init__()
          • YAxis.side
          • YAxis.default_y_range
          • YAxis.dynamic_unit_prefix
        • 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
          • DsViewTimeAxisType.padded_view_time_axis
          • DsViewTimeAxisType.view_time_axis
        • BaseViewTimeAxis
          • BaseViewTimeAxis.receive_view_period
          • BaseViewTimeAxis.__init__()
          • BaseViewTimeAxis.trigger_update()
          • BaseViewTimeAxis.on_change_view_range()
          • BaseViewTimeAxis.remove_on_change_view_range()
          • BaseViewTimeAxis.set_view_range()
          • BaseViewTimeAxis.view_range
        • BokehViewTimeAxis
          • BokehViewTimeAxis.shared_x_range
          • BokehViewTimeAxis.__init__()
          • BokehViewTimeAxis.x_range_callback()
          • BokehViewTimeAxis.x_range_data_updater()
          • BokehViewTimeAxis.set_view_range()
          • BokehViewTimeAxis.view_range
        • TimePeriodSelectorTableViewTimeAxis
          • TimePeriodSelectorTableViewTimeAxis.__init__()
          • TimePeriodSelectorTableViewTimeAxis.set_view_range()
          • TimePeriodSelectorTableViewTimeAxis.view_range
        • 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
        • BindableError
        • Bindable
          • Bindable.__init__()
          • Bindable.bind()
          • Bindable.on_bind()
          • Bindable.unbind()
          • Bindable.on_unbind()
          • Bindable.bound
        • BindableToMany
          • BindableToMany.__init__()
          • BindableToMany.bind()
          • BindableToMany.on_bind()
          • BindableToMany.unbind()
          • BindableToMany.on_unbind()
          • BindableToMany.bound
      • shyft.dashboard.time_series.data_utility
        • DataUtilError
        • calculate_dead_band_indices()
        • data_to_patch_values()
        • convert_ts_to_plot_vectors()
        • merge_convert_ts_vectors_to_numpy()
        • find_nearest()
        • convert_ts_to_numpy()
      • shyft.dashboard.time_series.ds_view_handle
        • DsViewHandleError
        • DsViewHandle
          • DsViewHandle.__init__()
          • DsViewHandle.data_source
          • DsViewHandle.views
        • DsViewHandleCreator
          • DsViewHandleCreator.__init__()
          • DsViewHandleCreator.create_ds_view_handles()
          • DsViewHandleCreator.get_views()
          • DsViewHandleCreator.get_y_axis_by_label()
          • DsViewHandleCreator.get_y_axis_by_unit()
          • DsViewHandleCreator.get_percentiles_views()
          • DsViewHandleCreator.get_time_range()
        • BasicDsViewHandleCreator
          • BasicDsViewHandleCreator.__init__()
          • BasicDsViewHandleCreator.create_ds_view_handles()
      • shyft.dashboard.time_series.ds_view_handle_registry
        • DsViewHandleRegistry
          • DsViewHandleRegistry.__init__()
          • DsViewHandleRegistry.ds_view_handles
          • DsViewHandleRegistry.registry
          • DsViewHandleRegistry.empty_registry()
          • DsViewHandleRegistry.replace()
          • DsViewHandleRegistry.add()
          • DsViewHandleRegistry.remove()
          • DsViewHandleRegistry.remove_by_tag()
        • DsvhRegistryPolicy
          • DsvhRegistryPolicy.REPLACE
          • DsvhRegistryPolicy.ADD
        • DsViewHandleRegistryApp
          • DsViewHandleRegistryApp.__init__()
          • DsViewHandleRegistryApp.layout
          • DsViewHandleRegistryApp.layout_components
      • shyft.dashboard.time_series.dt_selector
        • CalendarDtStr
          • CalendarDtStr.Year
          • CalendarDtStr.Quarter
          • CalendarDtStr.Month
          • CalendarDtStr.Week
          • CalendarDtStr.Day
          • CalendarDtStr.Hour
          • CalendarDtStr.Minute
          • CalendarDtStr.Second
        • calendar_unit_to_str()
        • dt_to_str()
        • tdiff_to_str()
        • DeltaTSelector
          • DeltaTSelector.__init__()
          • DeltaTSelector.on_change_selected()
      • shyft.dashboard.time_series.formatter
        • conditional_time_formatter()
        • basic_time_formatter()
      • shyft.dashboard.time_series.layouts
        • ViewContainerTabsError
        • ViewContainerTabs
          • ViewContainerTabs.__init__()
          • ViewContainerTabs.on_active_tabs()
          • ViewContainerTabs.layout
      • 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
          • SingleGlyphRenderer.__init__()
          • SingleGlyphRenderer.reset_bokeh_data_source()
          • SingleGlyphRenderer.bokeh_ds_keys
          • SingleGlyphRenderer.glyphs
          • SingleGlyphRenderer.color_callback()
        • LineRenderer
          • LineRenderer.__init__()
          • LineRenderer.bokeh_ds_keys
          • LineRenderer.on_set_view()
          • LineRenderer.update_bokeh_data_source()
          • LineRenderer.index_callback()
          • LineRenderer.line_style_callback()
          • LineRenderer.line_width_callback()
        • ScatterRenderer
          • ScatterRenderer.__init__()
          • ScatterRenderer.bokeh_ds_keys
          • ScatterRenderer.on_set_view()
          • ScatterRenderer.update_bokeh_data_source()
          • ScatterRenderer.index_callback()
          • ScatterRenderer.patch_attr_callback()
        • DiamondScatterRenderer
          • DiamondScatterRenderer.__init__()
        • CircleScatterRenderer
          • CircleScatterRenderer.__init__()
        • SquareScatterRenderer
          • SquareScatterRenderer.__init__()
        • TriangleScatterRenderer
          • TriangleScatterRenderer.__init__()
        • FillInBetweenRenderer
          • FillInBetweenRenderer.__init__()
          • FillInBetweenRenderer.bokeh_ds_keys
          • FillInBetweenRenderer.on_set_view()
          • FillInBetweenRenderer.update_bokeh_data_source()
          • FillInBetweenRenderer.indices_callback()
        • MultiLineRenderer
          • MultiLineRenderer.__init__()
          • MultiLineRenderer.bokeh_ds_keys
          • MultiLineRenderer.on_set_view()
          • MultiLineRenderer.update_bokeh_data_source()
          • MultiLineRenderer.index_callback()
          • MultiLineRenderer.line_style_callback()
          • MultiLineRenderer.line_width_callback()
        • BackgroundDataRenderer
          • BackgroundDataRenderer.__init__()
          • BackgroundDataRenderer.bokeh_ds_keys
          • BackgroundDataRenderer.on_set_view()
          • BackgroundDataRenderer.update_bokeh_data_source()
          • BackgroundDataRenderer.y_range()
          • BackgroundDataRenderer.redraw_callback()
          • BackgroundDataRenderer.values_color_map_callback()
      • shyft.dashboard.time_series.sources
        • shyft.dashboard.time_series.sources.source
          • DataSource
            • DataSource.ts_adapter
            • DataSource.__init__()
          • TsAdapterRequestParameter
            • TsAdapterRequestParameter.__init__()
            • TsAdapterRequestParameter.create_empty()
            • TsAdapterRequestParameter.is_empty
            • TsAdapterRequestParameter.is_equiv()
            • TsAdapterRequestParameter.request_time_axis
            • TsAdapterRequestParameter.request_parameter
          • 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
          • TsAdapter
            • TsAdapter.__call__()
          • BasicTsAdapter
            • BasicTsAdapter.__init__()
            • BasicTsAdapter.__call__()
      • shyft.dashboard.time_series.state
        • State
          • State.unit_registry
          • State.Quantity
          • State.unit_convert
        • Quantity
          • Quantity.__init__()
          • Quantity.magnitude
          • Quantity.units
          • Quantity.to()
      • shyft.dashboard.time_series.tools
        • shyft.dashboard.time_series.tools.base
          • BaseTool
            • BaseTool.__init__()
            • BaseTool.on_bind()
        • shyft.dashboard.time_series.tools.figure_tools
          • FigureToolError
          • FigureTool
            • FigureTool.__init__()
            • FigureTool.on_bind()
          • ResetYRange
            • ResetYRange.__init__()
            • ResetYRange.on_bind()
            • ResetYRange.on_click()
            • ResetYRange.layout_components
          • ActiveScroll
            • ActiveScroll.X_axis
            • ActiveScroll.Y_axis
          • WheelZoomDirection
            • WheelZoomDirection.__init__()
            • WheelZoomDirection.layout
            • WheelZoomDirection.layout_components
            • WheelZoomDirection.on_bind()
            • WheelZoomDirection.set_active_scroll()
            • WheelZoomDirection.change_active_scroll()
          • ExportLineDataButton
            • ExportLineDataButton.__init__()
            • ExportLineDataButton.on_bind()
            • ExportLineDataButton.on_click()
            • ExportLineDataButton.js_callback()
            • ExportLineDataButton.layout_components
            • ExportLineDataButton.layout
          • HoverToolToggleDropdown
            • HoverToolToggleDropdown.__init__()
            • HoverToolToggleDropdown.callback_hovertool_info()
          • HoverTool
            • HoverTool.__init__()
            • HoverTool.on_bind()
            • HoverTool.register_view_renderer()
            • HoverTool.remove_renderer()
            • HoverTool.get_all_hover_tools()
          • 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
            • ShowTsLabel.__init__()
            • ShowTsLabel.layout
            • ShowTsLabel.layout_components
            • ShowTsLabel.on_bind()
            • ShowTsLabel.on_click()
          • Actions
            • Actions.freeze
            • Actions.move
            • Actions.extend_right
            • Actions.extend_left
          • Modes
            • Modes.fixed_dt
            • Modes.snap_to_dt
            • Modes.free_range
          • TimePeriodSelectorSlider
            • TimePeriodSelectorSlider.__init__()
            • TimePeriodSelectorSlider.on_bind()
            • TimePeriodSelectorSlider.on_click()
            • TimePeriodSelectorSlider.layout_components
            • TimePeriodSelectorSlider.update_selected_area()
            • TimePeriodSelectorSlider.update_title()
            • TimePeriodSelectorSlider.layout
          • 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
          • TableToolError
          • TableTool
            • TableTool.__init__()
            • TableTool.on_bind()
          • ExportTableDataButton
            • ExportTableDataButton.__init__()
            • ExportTableDataButton.on_bind()
            • ExportTableDataButton.on_click()
            • ExportTableDataButton.js_callback()
            • ExportTableDataButton.layout_components
            • ExportTableDataButton.layout
        • shyft.dashboard.time_series.tools.ts_viewer_tools
          • TsViewerTool
            • TsViewerTool.__init__()
            • TsViewerTool.on_bind()
          • ResetTool
            • ResetTool.__init__()
            • ResetTool.layout_components
            • ResetTool.on_bind()
            • ResetTool.on_click()
        • shyft.dashboard.time_series.tools.view_time_axis_tools
          • ViewTimeAxisToolError
          • ViewTimeAxisTool
            • ViewTimeAxisTool.__init__()
            • ViewTimeAxisTool.on_bind()
          • DeltaTSelectorTool
            • DeltaTSelectorTool.__init__()
            • DeltaTSelectorTool.layout_components
            • DeltaTSelectorTool.on_bind()
          • ViewPeriodSelector
            • ViewPeriodSelector.__init__()
            • ViewPeriodSelector.on_bind()
            • ViewPeriodSelector.layout
            • ViewPeriodSelector.layout_components
            • ViewPeriodSelector.jump_to_next_period()
            • ViewPeriodSelector.jump_to_previous_period()
      • 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
        • ViewError
        • BaseView
          • BaseView.__init__()
          • BaseView.view_container
        • LegendItem
          • LegendItem.__init__()
        • TableView
          • TableView.__init__()
        • FigureView
          • FigureView.__init__()
          • FigureView.renderer_class
          • FigureView.y_axis
        • Line
          • Line.__init__()
          • Line.indices
        • Scatter
          • Scatter.__init__()
          • Scatter.indices
        • DiamondScatter
          • DiamondScatter.__init__()
        • CircleScatter
          • CircleScatter.__init__()
        • SquareScatter
          • SquareScatter.__init__()
        • TriangleScatter
          • TriangleScatter.__init__()
        • FillInBetween
          • FillInBetween.__init__()
        • MultiLine
          • MultiLine.__init__()
        • BackgroundData
          • BackgroundData.__init__()
      • 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
          • Legend
            • Legend.__init__()
            • Legend.layout
            • Legend.layout_components
            • Legend.add_view()
            • Legend.label_callback()
            • Legend.update_view_data()
            • Legend.clear()
            • Legend.clear_views()
            • Legend.update_data_source()
            • Legend.visible_callback()
            • Legend.expand_callback()
        • 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
            • StatisticsTable.__init__()
            • StatisticsTable.prepare_data_and_update_data_source()
            • StatisticsTable.update_data_source()
            • StatisticsTable.reset_columns()
            • StatisticsTable.view_range_callback()
        • shyft.dashboard.time_series.view_container.view_container_base
          • BaseViewContainer
            • BaseViewContainer.__init__()
            • BaseViewContainer.set_unit_registry()
            • BaseViewContainer.layout
            • BaseViewContainer.layout_components
            • BaseViewContainer.add_view()
            • BaseViewContainer.update_view_data()
            • BaseViewContainer.clear()
            • BaseViewContainer.clear_views()
            • BaseViewContainer.visible
      • shyft.dashboard.time_series.view_time_axes
        • create_view_time_axis()
        • period_union()
        • ViewTimeAxisProperties
          • ViewTimeAxisProperties.dt
          • ViewTimeAxisProperties.cal
          • ViewTimeAxisProperties.view_period
          • ViewTimeAxisProperties.padded_view_period
          • ViewTimeAxisProperties.extend_mode
          • ViewTimeAxisProperties.__init__()
    • shyft.dashboard.graph
      • shyft.dashboard.graph.category_graph
        • BaseGraphObject
          • BaseGraphObject.__init__()
        • GraphConnectionData
          • GraphConnectionData.edge_objects
          • GraphConnectionData.start_objects
          • GraphConnectionData.end_objects
          • GraphConnectionData.edge_layout_keys
          • GraphConnectionData.revers_dirs
        • GraphContainerData
          • GraphContainerData.node_objects
          • GraphContainerData.object_layout_keys
        • ExpandCollapseIcons
          • ExpandCollapseIcons.__init__()
          • ExpandCollapseIcons.layout
          • ExpandCollapseIcons.glyphs
          • ExpandCollapseIcons.layout_components
          • ExpandCollapseIcons.add_icons()
          • ExpandCollapseIcons.update_data_source()
          • ExpandCollapseIcons.clear()
          • ExpandCollapseIcons.expand_collapse()
        • CategoryGraph
          • CategoryGraph.__init__()
          • CategoryGraph.layout
          • CategoryGraph.generate_graph()
          • CategoryGraph.tag_children_visibility
          • CategoryGraph.draw_graph()
          • CategoryGraph.clear_figure()
          • CategoryGraph.layout_components
    • shyft.dashboard.maps
      • shyft.dashboard.maps.base_map
        • BaseMap
          • BaseMap.tiles
        • BBoxTileBaseMap
          • BBoxTileBaseMap.__init__()
          • BBoxTileBaseMap.incomplete_url
          • BBoxTileBaseMap.url
          • BBoxTileBaseMap.tiles
      • shyft.dashboard.maps.layer_data
        • LayerDataError
        • LayerDataHandle
          • LayerDataHandle.__init__()
          • LayerDataHandle.map_layer
          • LayerDataHandle.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
        • MapLayerError
        • MapLayerType
          • MapLayerType.POINT
          • MapLayerType.POLYGON
          • MapLayerType.LABEL
        • find_tags_from_tooltips()
        • MapLayer
          • MapLayer.__init__()
          • MapLayer.on_bind()
          • MapLayer.bbox
          • MapLayer.check_data_compatibility()
          • MapLayer.updated_data()
          • MapLayer.visible
      • shyft.dashboard.maps.map_viewer
        • MapViewer
          • MapViewer.__init__()
          • MapViewer.add_layer()
          • MapViewer.update_axes()
    • shyft.dashboard.widgets
      • shyft.dashboard.widgets.date_selector
        • DateSelector
          • DateSelector.__init__()
          • DateSelector.layout
          • DateSelector.layout_components
          • DateSelector.convert_str_to_date()
          • DateSelector.convert_date_to_str()
      • shyft.dashboard.widgets.logger_box
        • LogLevel
          • LogLevel.CRITICAL
          • LogLevel.ERROR
          • LogLevel.WARNING
          • LogLevel.INFO
          • LogLevel.DEBUG
          • LogLevel.NOTSET
        • 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
        • MessageViewer
          • MessageViewer.__init__()
          • MessageViewer.receive_info_message()
          • MessageViewer.receive_warning_message()
          • MessageViewer.add_message()
      • shyft.dashboard.widgets.selector_models
        • LabelDataSelectorClickPolicy
          • LabelDataSelectorClickPolicy.SEND_SELECTED
          • LabelDataSelectorClickPolicy.REMOVE_SELECTED_AND_SEND_REST
        • LabelDataSelector
          • LabelDataSelector.__init__()
          • LabelDataSelector.on_change_selected()
      • shyft.dashboard.widgets.sliders
        • SliderData
          • SliderData.start
          • SliderData.end
          • SliderData.step
          • SliderData.value
          • SliderData.callback
        • RangeSliderData
          • RangeSliderData.start
          • RangeSliderData.end
          • RangeSliderData.step
          • RangeSliderData.range
          • RangeSliderData.callback
        • SliderSelect
          • SliderSelect.__init__()
          • SliderSelect.layout
          • SliderSelect.layout_components
          • SliderSelect.on_change()
        • RangeSliderSelect
          • RangeSliderSelect.__init__()
          • RangeSliderSelect.layout
          • RangeSliderSelect.layout_components
          • RangeSliderSelect.on_change()
      • shyft.dashboard.widgets.water_route_widget
        • WaterRouteWidget
          • WaterRouteWidget.__init__()
          • WaterRouteWidget.layout
          • WaterRouteWidget.layout_components
      • shyft.dashboard.widgets.zoomables
        • LabelSetZoomable
          • LabelSetZoomable.__init__()
          • LabelSetZoomable.update_zoom_visibility()
          • LabelSetZoomable.set_update_callback()
        • CheckboxGroupZoomable
          • CheckboxGroupZoomable.__init__()
          • CheckboxGroupZoomable.layout
          • CheckboxGroupZoomable.layout_components
          • CheckboxGroupZoomable.update_zoom_visibility()
    • shyft.dashboard.util
      • shyft.dashboard.util.find_free_port
        • find_free_port()
      • shyft.dashboard.util.plot_connections
        • plot_ports()
        • plot_ports_notebook()
    • shyft.dashboard
  • Start bokeh apps
    • start_bokeh_apps()

Indices and tables

• Index

• Module Index

• Search Page