Welcome to Mesh Python SDK

Mesh Python SDK is a client library used to communicate with Volue Energy’s Mesh server.

To learn what’s new and noteworthy head on over to our Versions section.

Getting started

If this is your first time using this library, here are some resources to help you get started.

• Quickstart: Quickstart guide

• Installation: Installation

• Examples: Examples

• Authentication: Client authentication

• How to do development Setup for developers

Features

• Communication using gRPC

• SDK using async/await syntax

• Optimised memory sharing by using Apache Arrow

Prerequisites

• Mesh server with gRPC enabled.

• Python [3.9, 3.10, 3.11, 3.12, 3.13]

Getting help

If you’re having trouble, these resources might help.

• Try the Frequently Asked Questions first.

• Report bugs in the issue tracker

Welcome

• Quickstart guide
  • Prerequisites quickstart
  • Installation quickstart
  • First call to Mesh server
  • Next steps
• Installation
  • Git
  • GitHub
  • Python
  • Development environment
    • PyCharm
  • Mesh Python SDK
    • Setup for users (recommended)
    • Setup for users (offline environments)
    • Setup for developers
      • Tests
      • Dependencies
      • Version compatibility
• An introduction to Mesh
• HydSim
  • API documentation
  • Example of simulations
  • Example of inflow calculations
• Examples
  • Best practices
  • Quickstart
  • Authorization
  • Connect
  • Connect, asynchronously
  • Connect using external access token
  • Get version
  • Read time series
  • Read time series, asynchronously
  • Read and process time series, asynchronously
  • Search for time series attributes
  • Traverse model
  • Using time series with pandas
  • Working with link relations
  • Working with model (objects and attributes)
  • Working with rating curves
  • Working with sessions
  • Working with XY sets
  • Write time series
  • Run simulations
  • Run inflow calculations
• Client authentication
  • Kerberos
    • Windows Kerberos
    • MIT Kerberos (Linux/MacOS)
    • Example
    • Internals
  • External authorization
    • Token format
    • Example
    • Internals
• Frequently Asked Questions
  • I get a connection gRPC error.
  • I get an SSL_ERROR_SSL. What am I doing wrong?
  • I get an ImportError: cannot import name ‘auth_pb2’ from ‘volue.mesh.proto.auth.v1alpha’.
  • I get a RESOURCE_EXHAUSTED gRPC error.
  • I get error with building dependencies when installing volue.mesh on Linux.
  • Other
    • Mesh server gRPC configuration
    • I think I found a bug or I have a feature request.
    • I need more help.
• Glossary

Versions

• Versions
  • Mesh Python SDK version 1.14.0-dev
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.13.0
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.12.0
    • Compatible with
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.11.0
    • Compatible with
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.10.0
    • Compatible with
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.9.0
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.8.0
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.7.0
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.6.0
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.5.0
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.4.0
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.3.0
    • Compatible with
    • New features
    • Install instructions
  • Mesh Python SDK version 1.2.1
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.1.1
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 1.0.0
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 0.0.4 (alpha)
    • Compatible with
    • New features
    • Changes
    • Known issues
    • Install instructions
  • Mesh Python SDK version 0.0.3 (alpha)
    • Compatible with
    • New features
    • Changes
    • Install instructions
  • Mesh Python SDK version 0.0.2 (alpha)
    • Compatible with
    • New features
    • Changes
    • Known issues
    • Install instructions

SDK Reference

• API documentation
  • volue.mesh
    • Connection
      • Connection.Session
        • Connection.Session.close()
        • Connection.Session.commit()
        • Connection.Session.create_object()
        • Connection.Session.create_physical_timeseries()
        • Connection.Session.delete_object()
        • Connection.Session.forecast_functions()
        • Connection.Session.get_attribute()
        • Connection.Session.get_mc_file()
        • Connection.Session.get_object()
        • Connection.Session.get_rating_curve_versions()
        • Connection.Session.get_timeseries_attribute()
        • Connection.Session.get_timeseries_resource_info()
        • Connection.Session.get_xy_sets()
        • Connection.Session.history_functions()
        • Connection.Session.list_models()
        • Connection.Session.open()
        • Connection.Session.read_timeseries_points()
        • Connection.Session.rollback()
        • Connection.Session.run_inflow_calculation()
        • Connection.Session.run_simulation()
        • Connection.Session.search_for_attributes()
        • Connection.Session.search_for_objects()
        • Connection.Session.search_for_timeseries_attributes()
        • Connection.Session.statistical_functions()
        • Connection.Session.transform_functions()
        • Connection.Session.update_link_relation_attribute()
        • Connection.Session.update_object()
        • Connection.Session.update_rating_curve_versions()
        • Connection.Session.update_simple_attribute()
        • Connection.Session.update_timeseries_attribute()
        • Connection.Session.update_timeseries_attribute_definition()
        • Connection.Session.update_timeseries_resource_info()
        • Connection.Session.update_versioned_one_to_many_link_relation_attribute()
        • Connection.Session.update_versioned_one_to_one_link_relation_attribute()
        • Connection.Session.update_xy_sets()
        • Connection.Session.write_timeseries_points()
      • Connection.connect_to_session()
      • Connection.create_session()
      • Connection.get_user_identity()
      • Connection.get_version()
      • Connection.insecure()
      • Connection.revoke_access_token()
      • Connection.update_external_access_token()
      • Connection.with_external_access_token()
      • Connection.with_kerberos()
      • Connection.with_tls()
    • AttributeBase
      • AttributeBase.AttributeBaseDefinition
    • AttributesFilter
      • AttributesFilter.name_mask
      • AttributesFilter.namespace_mask
      • AttributesFilter.return_no_attributes
      • AttributesFilter.tag_mask
    • Authentication
      • Authentication.KerberosTokenIterator
        • Authentication.KerberosTokenIterator.__init__()
        • Authentication.KerberosTokenIterator.process_response()
        • Authentication.KerberosTokenIterator.signal_final_response_received()
      • Authentication.Parameters
        • Authentication.Parameters.service_principal
        • Authentication.Parameters.user_principal
      • Authentication.__init__()
      • Authentication.delete_access_token()
      • Authentication.get_token()
      • Authentication.is_token_valid()
    • HydSimDataset
      • HydSimDataset.data
      • HydSimDataset.name
    • LinkRelationAttribute
      • LinkRelationAttribute.LinkRelationAttributeDefinition
    • LinkRelationVersion
      • LinkRelationVersion.target_object_id
      • LinkRelationVersion.valid_from_time
    • LogMessage
      • LogMessage.level
      • LogMessage.message
    • Object
      • Object.attributes
      • Object.id
      • Object.name
      • Object.owner_id
      • Object.owner_path
      • Object.path
      • Object.type_name
    • OwnershipRelationAttribute
      • OwnershipRelationAttribute.OwnershipRelationAttributeDefinition
    • RatingCurveSegment
      • RatingCurveSegment.factor_a
      • RatingCurveSegment.factor_b
      • RatingCurveSegment.factor_c
      • RatingCurveSegment.x_range_until
    • RatingCurveVersion
      • RatingCurveVersion.valid_from_time
      • RatingCurveVersion.x_range_from
      • RatingCurveVersion.x_value_segments
    • SimpleAttribute
      • SimpleAttribute.SimpleAttributeDefinition
    • Timeseries
      • Timeseries.Curve
        • Timeseries.Curve.PIECEWISELINEAR
        • Timeseries.Curve.STAIRCASE
        • Timeseries.Curve.STAIRCASESTARTOFSTEP
        • Timeseries.Curve.UNKNOWN
      • Timeseries.FLAGS_PA_FIELD_NAME
      • Timeseries.PointFlags
        • Timeseries.PointFlags.MISSING
        • Timeseries.PointFlags.NOT_OK
        • Timeseries.PointFlags.OK
        • Timeseries.PointFlags.SUSPECT
      • Timeseries.Resolution
        • Timeseries.Resolution.BREAKPOINT
        • Timeseries.Resolution.DAY
        • Timeseries.Resolution.HOUR
        • Timeseries.Resolution.MIN15
        • Timeseries.Resolution.MIN30
        • Timeseries.Resolution.MONTH
        • Timeseries.Resolution.UNDEFINED
        • Timeseries.Resolution.UNSPECIFIED
        • Timeseries.Resolution.WEEK
        • Timeseries.Resolution.YEAR
      • Timeseries.TIMESTAMP_PA_FIELD_NAME
      • Timeseries.VALUE_PA_FIELD_NAME
      • Timeseries.__init__()
      • Timeseries.is_calculation_expression_result
      • Timeseries.number_of_points
      • Timeseries.schema
    • TimeseriesAttribute
      • TimeseriesAttribute.TimeseriesAttributeDefinition
    • TimeseriesResource
      • TimeseriesResource.curve_type
      • TimeseriesResource.name
      • TimeseriesResource.path
      • TimeseriesResource.resolution
      • TimeseriesResource.temporary
      • TimeseriesResource.timeseries_key
      • TimeseriesResource.unit_of_measurement
      • TimeseriesResource.virtual_timeseries_expression
    • UserIdentity
      • UserIdentity.display_name
      • UserIdentity.identifier
      • UserIdentity.source
    • VersionInfo
      • VersionInfo.name
      • VersionInfo.version
    • VersionedLinkRelationAttribute
      • VersionedLinkRelationAttribute.VersionedLinkRelationEntry
        • VersionedLinkRelationAttribute.VersionedLinkRelationEntry.versions
    • XyCurve
      • XyCurve.xy
      • XyCurve.z
    • XySet
      • XySet.valid_from_time
      • XySet.xy_curves
  • volue.mesh.availability
    • Availability
      • Availability.add_revision_recurrence()
      • Availability.create_restriction()
      • Availability.create_revision()
      • Availability.delete_availability_events()
      • Availability.delete_availability_events_by_id()
      • Availability.delete_revision_recurrence()
      • Availability.get_availability_event()
      • Availability.search_availability_events()
      • Availability.search_instances()
      • Availability.update_restriction()
      • Availability.update_revision()
  • volue.mesh.aio
    • Connection
      • Connection.Session
        • Connection.Session.close()
        • Connection.Session.commit()
        • Connection.Session.create_object()
        • Connection.Session.create_physical_timeseries()
        • Connection.Session.delete_object()
        • Connection.Session.forecast_functions()
        • Connection.Session.get_attribute()
        • Connection.Session.get_mc_file()
        • Connection.Session.get_object()
        • Connection.Session.get_rating_curve_versions()
        • Connection.Session.get_timeseries_attribute()
        • Connection.Session.get_timeseries_resource_info()
        • Connection.Session.get_xy_sets()
        • Connection.Session.history_functions()
        • Connection.Session.list_models()
        • Connection.Session.open()
        • Connection.Session.read_timeseries_points()
        • Connection.Session.rollback()
        • Connection.Session.run_inflow_calculation()
        • Connection.Session.run_simulation()
        • Connection.Session.search_for_attributes()
        • Connection.Session.search_for_objects()
        • Connection.Session.search_for_timeseries_attributes()
        • Connection.Session.statistical_functions()
        • Connection.Session.transform_functions()
        • Connection.Session.update_link_relation_attribute()
        • Connection.Session.update_object()
        • Connection.Session.update_rating_curve_versions()
        • Connection.Session.update_simple_attribute()
        • Connection.Session.update_timeseries_attribute()
        • Connection.Session.update_timeseries_attribute_definition()
        • Connection.Session.update_timeseries_resource_info()
        • Connection.Session.update_versioned_one_to_many_link_relation_attribute()
        • Connection.Session.update_versioned_one_to_one_link_relation_attribute()
        • Connection.Session.update_xy_sets()
        • Connection.Session.write_timeseries_points()
      • Connection.connect_to_session()
      • Connection.create_session()
      • Connection.get_user_identity()
      • Connection.get_version()
      • Connection.insecure()
      • Connection.revoke_access_token()
      • Connection.update_external_access_token()
      • Connection.with_external_access_token()
      • Connection.with_kerberos()
      • Connection.with_tls()
  • volue.mesh.calc
    • Timezone
      • Timezone.LOCAL
      • Timezone.STANDARD
      • Timezone.UTC
    • Mesh calculation forecast functions
    • ForecastFunctions
      • ForecastFunctions.get_all_forecasts()
      • ForecastFunctions.get_forecast()
    • ForecastFunctionsAsync
      • ForecastFunctionsAsync.get_all_forecasts()
      • ForecastFunctionsAsync.get_forecast()
    • Mesh calculation history functions.
    • HistoryFunctions
      • HistoryFunctions.get_ts_as_of_time()
      • HistoryFunctions.get_ts_historical_versions()
    • HistoryFunctionsAsync
      • HistoryFunctionsAsync.get_ts_as_of_time()
      • HistoryFunctionsAsync.get_ts_historical_versions()
    • Mesh calculation statistical functions.
    • StatisticalFunctions
      • StatisticalFunctions.sum()
      • StatisticalFunctions.sum_single_timeseries()
    • StatisticalFunctionsAsync
      • StatisticalFunctionsAsync.sum()
      • StatisticalFunctionsAsync.sum_single_timeseries()
    • Mesh calculation transformation functions.
    • Method
      • Method.AVG
      • Method.AVGI
      • Method.FIRST
      • Method.LAST
      • Method.MAX
      • Method.MIN
      • Method.SUM
      • Method.SUMI
    • TransformFunctions
      • TransformFunctions.transform()
    • TransformFunctionsAsync
      • TransformFunctionsAsync.transform()

Indices and tables

• Index

• Module Index