Versions -------- Depending on the Mesh Server version you intend to communicate with a compatible version of Mesh Python SDK is needed. Mesh Python SDK version 1.13.0-dev ********************************** This is the current master version. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version >= 2.17 **(may change)** - Python [3.9, 3.10, 3.11, 3.12] **(may change)** New features ~~~~~~~~~~~~~~~~~~ - TBA Changes ~~~~~~~~~~~~~~~~~~ - TBA Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python `Mesh Python SDK version 1.12.0 `_ *********************************************************************************************************** Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version >= 2.17 - Python [3.9, 3.10, 3.11, 3.12] Changes ~~~~~~~~~~~~~~~~~~ - Support for new way of sending empty time series. :pull:`538` **This introduces breaking change for use cases with reading time series with no points.** Starting from Mesh 2.17 when an empty time series is read (e.g.: break point time series with no values), instead of raising an `ValueError` with message `No data in time series reply for the given interval`, we will now return `volue.mesh.Timeseries` instance with an empty Arrow table and start/end timestamps set to `None`. Other time series metadata like resolution will be set as usual. - Support for *undefined* time series resolution. :pull:`535` - Do not include tests and examples in the `volue.mesh` package. :pull:`529` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install git+https://github.com/Volue-Public/energy-mesh-python@v1.12.0 `Mesh Python SDK version 1.11.0 `_ *********************************************************************************************************** Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version >= 2.15 - Python [3.9, 3.10, 3.11, 3.12] Changes ~~~~~~~~~~~~~~~~~~ - **Fixed:** Broken installation of volue.mesh package via pip. :issue:`526` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install git+https://github.com/Volue-Public/energy-mesh-python@v1.11.0 `Mesh Python SDK version 1.10.0 `_ *********************************************************************************************************** .. warning:: Due to :issue:`526` it is recommended to use `Mesh Python SDK version 1.11.0 `_ instead. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version >= 2.15 - Python [3.9, 3.10, 3.11, 3.12] Changes ~~~~~~~~~~~~~~~~~~ - **Fixed:** Processing time series objects with unknown curve types. :issue:`519` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install git+https://github.com/Volue-Public/energy-mesh-python@v1.10.0 `Mesh Python SDK version 1.9.0 `_ ********************************************************************************************************* .. warning:: Due to :issue:`526` it is recommended to use `Mesh Python SDK version 1.11.0 `_ instead. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version >= 2.15 - Python [3.9, 3.10, 3.11, 3.12] New features ~~~~~~~~~~~~~~~~~~ - Support for updating versioned one-to-many link relations. :pull:`476` See `update_versioned_one_to_many_link_relation_attribute`. - Configurable gRPC inbound message size. :issue:`421` See :ref:`mesh_client:gRPC communication`. - Support for creating physical time series. :issue:`383` See `create_physical_timeseries`. Changes ~~~~~~~~~~~~~~~~~~ - **Fixed:** Example with searching calculation expressions. :pull:`508` - Changes for Mesh server 2.15 gRPC interface compatibility. :issue:`470` It introduces breaking API change: `update_versioned_link_relation_attribute` is renamed to `update_versioned_one_to_one_link_relation_attribute`. Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install git+https://github.com/Volue-Public/energy-mesh-python@v1.9.0 `Mesh Python SDK version 1.8.0 `_ ********************************************************************************************************* .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.14] - Python [3.9, 3.10, 3.11, 3.12] New features ~~~~~~~~~~~~~~~~~~ - It's now possible to specify the resolution of a hydro simulation or inflow calculation using the optional `resolution` argument to `run_simulation` and `run_inflow_calculation`. See :doc:`hydsim` for more information. Changes ~~~~~~~~~~~~~~~~~~ - Changes for Mesh server 2.14 gRPC interface compatibility. :issue:`464` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install git+https://github.com/Volue-Public/energy-mesh-python@v1.8.0 `Mesh Python SDK version 1.7.0 `_ ********************************************************************************************************* .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.13] - Python [3.9, 3.10, 3.11, 3.12] New features ~~~~~~~~~~~~~~~~~~ - It's now possible to get Marginal Cost input files from Mesh using the new `get_mc_file` method. See :doc:`hydsim` for more information. - `run_simulation`, `run_inflow_calculation` and `get_mc_file` now includes log messages from the server in the response. See :doc:`hydsim` for more information. - It's now possible to specify which scenario to run when using `run_simulation`. See :doc:`hydsim` for more information. Changes ~~~~~~~~~~~~~~~~~~ - Handle MIN30 resolution. :pull:`431` - Changes for Mesh server 2.13 gRPC interface compatibility. (:pull:`427`, :pull:`430`, :pull:`433`, :issue:`384`, :issue:`385`, :issue:`405`, :issue:`423`) Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install git+https://github.com/Volue-Public/energy-mesh-python@v1.7.0 `Mesh Python SDK version 1.6.0 `_ ********************************************************************************************************* .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.12] - Python [3.9, 3.10, 3.11, 3.12] New features ~~~~~~~~~~~~~~~~~~ - Support for Python 3.12 :pull:`413` .. warning:: Python 3.8 is no longer supported. Changes ~~~~~~~~~~~~~~~~~~ - Add example and documentation on removing time series points using `write_timeseries_points`. :pull:`422` - Add example with searching calculation expressions. :pull:`418` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install git+https://github.com/Volue-Public/energy-mesh-python@v1.6.0 `Mesh Python SDK version 1.5.0 `_ ********************************************************************************************************* .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.12] - Python [3.8, 3.9, 3.10, 3.11] New features ~~~~~~~~~~~~~~~~~~ - Experimental support for running hydro simulations and inflow calculations on the Mesh Server. See :doc:`hydsim`. Changes ~~~~~~~~~~~~~~~~~~ - Use prebuilt `winkerberos` wheel for Python 3.11 :issue:`378` .. warning:: Python 3.8 support will dropped in the next Mesh Python SDK release. Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install git+https://github.com/Volue-Public/energy-mesh-python@v1.5.0 `Mesh Python SDK version 1.4.0 `_ ********************************************************************************************************* ------------ .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.10, 2.11] - Python [3.8, 3.9, 3.10, 3.11] New features ~~~~~~~~~~~~~~~~~~ - Implement automatic session lifetime extension :pull:`368` - Implement functionality to get model names :issue:`356` Changes ~~~~~~~~~~~~~~~~~~ - **Fixed:** Handling simple attributes without any values. :pull:`364` - Versions must be sorted in update_rating_curve_versions :pull:`358` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python@v1.4.0 .. warning:: For Python 3.11 on Windows do not use Git BASH for installing Mesh Python SDK. You may get an error when building `wheel` for `winkerberos` which is one of Mesh Python SDK dependencies. For Python 3.11 on Windows make sure you have Microsoft Visual C++ 14.0 or greater installed. Get it with `Microsoft C++ Build Tools `_. `Mesh Python SDK version 1.3.0 `_ ********************************************************************************************************* ------------ .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.9] - Python [3.8, 3.9, 3.10, 3.11] New features ~~~~~~~~~~~~~~~~~~ - Support for Python 3.11 :pull:`359` .. warning:: Python 3.7.1 is no longer supported. Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python@v1.3.0 .. warning:: For Python 3.11 on Windows do not use Git BASH for installing Mesh Python SDK. You may get an error when building `wheel` for `winkerberos` which is one of Mesh Python SDK dependencies. For Python 3.11 on Windows make sure you have Microsoft Visual C++ 14.0 or greater installed. Get it with `Microsoft C++ Build Tools `_. `Mesh Python SDK version 1.2.1 `_ ********************************************************************************************************* ------------ .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.9] - Python [3.7.1, 3.8, 3.9, 3.10] New features ~~~~~~~~~~~~~~~~~~ - Connection using external access token (e.g.: OAuth JWT access token) (:pull:`347` and :pull:`349`) Changes ~~~~~~~~~~~~~~~~~~ - **Fixed:** Parsing root objects. :pull:`354` .. warning:: Python 3.7.1 support will dropped in the next Mesh Python SDK release. Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python@v1.2.1 `Mesh Python SDK version 1.1.1 `_ ********************************************************************************************************* ------------ .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.6.1, 2.7, 2.8] - Python [3.7.1, 3.8, 3.9, 3.10] - Tested with Mesh server version 2.6.1.8 New features ~~~~~~~~~~~~~~~~~~ - Support for Python 3.10 :pull:`93` Changes ~~~~~~~~~~~~~~~~~~ - **Fixed:** Reading empty time series attributes :issue:`346` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python@v1.1.1 `Mesh Python SDK version 1.0.0 `_ ********************************************************************************************************* ------------ .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.6.1, 2.7, 2.8] - Python [3.7.1, 3.8, 3.9] - Tested with Mesh server version 2.6.1.8 New features ~~~~~~~~~~~~~~~~~~ - Implement XY sets. :issue:`230` - Implement link relations. :issue:`229` - Implement RatingCurve attribute. :issue:`228` Changes ~~~~~~~~~~~~~~~~~~ - **Enhancement:** Add example with traversing a model using the relation attributes. :issue:`309` - **Enhancement:** Support for instances of *Object* and *AttributeBase* as *target* for session methods. :issue:`267` - **Enhancement:** Unify arguments of all session methods. :issue:`266` - **Enhancement:** Ownership relation attribute improvements. PR :pull:`296` - **Enhancement:** Improve examples for reading and writing time series. PR :pull:`293` - **Enhancement:** Extend time series point flags. PR :pull:`272` - **Fixed:** Attributes with empty values are instantiated as *AttributeBase*. :issue:`306` - **Fixed:** Fix argument typing hints in *calc* module. PR :pull:`286` - **Fixed:** Fix async *search_for_objects*. PR :pull:`281` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python@v1.0.0 `Mesh Python SDK version 0.0.4 (alpha) `_ ************************************************************************************************************************* ------------ .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.5, 2.6.0] - Python [3.7.1, 3.8, 3.9] - Tested with Mesh server version 2.5.0.14 New features ~~~~~~~~~~~~~~~~~~ - Sum function for single time series. :issue:`161` - Read of virtual timeseries in SmG. :issue:`153` - Logging and audit trail. :issue:`156` - Read and write of objects in the physical Mesh model. :issue:`151` - Implement RPCs for handling attributes. :issue:`203` Changes ~~~~~~~~~~~~~~~~~~ - **Enhancement:** Separate forecasting and history functions. :issue:`113` - **Enhancement:** Readable error for reply with no timeseries data. :issue:`164` - **Enhancement:** Expose transformation functions the same way other calc functions are exposed. :issue:`157` - **Fixed:** Dependencies not set correctly :issue:`178` - **Fixed:** Inconsistent handling of timestamps in time series data point update. :issue:`183` Known issues ~~~~~~~~~~~~~~~~~~ - Lacking support to read and write XYZ attributes and link relations. Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python@Mesh_v2.5 `Mesh Python SDK version 0.0.3 (alpha) `_ ************************************************************************************************************************* ------------ .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.3, 2.4] - Python [3.7.1, 3.8, 3.9] - Tested with Mesh server version 2.3.0.12 New features ~~~~~~~~~~~~~~~~~~ - Read transformed timeseries. :issue:`100` - Read historical timeseries. :issue:`101`, :issue:`102` Changes ~~~~~~~~~~~~~~~~~~ - **Enhancement:** Adding more usecases. :issue:`109` - **Enhancement:** Proto files reorganized. :issue:`133` - **Enhancement:** Various documentation updates. :issue:`138`, :issue:`134` - **Enhancement:** "Expose TLS credential settings" :issue:`135` - **Fixed:** "read_timeseries_points(...) returns either a List[Timeseries] or just Timeseries" :issue:`125` - **Fixed:** "update_timeseries_resource_info(...) is not working as intended" :issue:`116` - **Fixed:** "Writing to a timeseries does not behave as expected" :issue:`115` - **Fixed:** "get_timeseries_attribute(...) won't accept GUIDs from Nimbus" :issue:`120` - **Fixed:** "Visual bug when displaying results for use cases" :issue:`122` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python@Mesh_v2.3 `Mesh Python SDK version 0.0.2 (alpha) `_ ************************************************************************************************************************* ------------ .. warning:: Affected by :issue:`526`. Check the FAQ section: :ref:`I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha' `. Compatible with ~~~~~~~~~~~~~~~~~~ - Mesh server version [2.2] - Python [3.7.1, 3.8, 3.9] - Tested with Mesh server version 2.2.0.9 New features ~~~~~~~~~~~~~~~~~~ - Authenticate with Mesh using the Kerberos protocol towards Active Directory. - Create and/or connect to a session on a running Mesh server using both secure and insecure connection. - Read and write timeseries points using full name, GUID or timskey. - Get and update metadata about physical Oracle timeseries. - Get and update metadata about timeseries objects connected in the Mesh model. - Search for timeseries objects in the Mesh model using the model, a query and either a start path or start guid. - Rollback and/or commit changes made to a Mesh session. - Documentation, guides and examples. - Automatic testing. Changes ~~~~~~~~~~~~~~~~~~ - First alpha version. Known issues ~~~~~~~~~~~~~~~~~~ - **Critical**: "update_timeseries_resource_info(...) is not working as intended" :issue:`116` - **Major/Minor:** "Writing to a timeseries does not behave as expected" :issue:`115` - **Major:** "get_timeseries_attribute(...) won't accept GUIDs from Nimbus" :issue:`120` - **Minor:** "Visual bug when displaying results for use cases" :issue:`122` Install instructions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ See instructions at :ref:`Setup for users` and use the following: .. code-block:: bash python -m pip install --force-reinstall git+https://github.com/Volue-Public/energy-mesh-python@Mesh_v2.2