Grpc4bmi

This software allows you to wrap your BMI implementation (https://github.com/csdms/bmi) in a server process and communicate with it via the included python client. The communication is serialized to protocol buffers by GRPC (https://grpc.io/) and occurs over network ports.

Added

* BmiJulia Python class that wraps bmi class implemented in Julia ([144](https://github.com/eWaterCycle/grpc4bmi/pull/144))

Changed

* Test against apptainer 1.1.9 ([138](https://github.com/eWaterCycle/grpc4bmi/pull/138))

This software allows you to wrap your BMI implementation (https://github.com/csdms/bmi) in a server process and communicate with it via the included python client. The communication is serialized to protocol buffers by GRPC (https://grpc.io/) and occurs over network ports.

The 0.2.x branch has several features that have been merged into the main branch.
This changes the API slightly compared to the previous 0.3.x releases.

Added

* OptionalDestBmi class with get_value(name,dest=None)

Changed
* Renamed master branch to main
* Merged 0.2.x branch to main
* Switch to pyproject.toml
* Upgrade to protobuf v4 https://github.com/eWaterCycle/grpc4bmi/issues/115

Fixed
* Upgrade heat model broke our tests https://github.com/eWaterCycle/grpc4bmi/issues/91
* Dependency conflict with protobuf and grpcio-reflection https://github.com/eWaterCycle/grpc4bmi/issues/120
* Incompatibility with typeguard 3 https://github.com/eWaterCycle/grpc4bmi/issues/128
* Singularity version on Cartesius cluster SURFSara gives ValueError https://github.com/eWaterCycle/grpc4bmi/issues/88
* The initialize method makes a copy of config file in input_dir https://github.com/eWaterCycle/grpc4bmi/issues/68
* Officially support Python 3.8, 3.9, 3.10 + drop python 3.5 support https://github.com/eWaterCycle/grpc4bmi/issues/98

This software allows you to wrap your BMI implementation (https://github.com/csdms/bmi) in a server process and communicate with it via the included python client. The communication is serialized to protocol buffers by GRPC (https://grpc.io/) and occurs over network ports.

To use Singularity it should be version >=3.6.0 .

Fixed

* get_value resource exhausted error ([76](https://github.com/eWaterCycle/grpc4bmi/issues/76))

This software allows you to wrap your BMI implementation (https://github.com/csdms/bmi) in a server process and communicate with it via the included python client. The communication is serialized to protocol buffers by GRPC (https://grpc.io/) and occurs over network ports.

Added

* extra volumes to BmiClientSingularity ([65](https://github.com/eWaterCycle/grpc4bmi/issues/65))

Fixed

* get_value resource exhausted error ([76](https://github.com/eWaterCycle/grpc4bmi/issues/76))

This software allows you to wrap your BMI implementation (https://github.com/csdms/bmi) in a server process and communicate with it via the included python client. The communication is serialized to protocol buffers by GRPC (https://grpc.io/) and occurs over network ports.

Breaking change!

The BMI interface has changed to https://bmi.readthedocs.io/en/latest/bmi.lang.py.html, the model should adapt this interface and users of the grcp4bmi clients should also adjust their code.

Fixed

* Present on [Research Software Directory](https://research-software.nl/software/grpc4bmi) (#42)
* set_value of bmi object on server does not recieve a numpy array (47)
* Improve error responses (11)
* Error in initialize if config file already in input directory (25)

Changed

* Support newest BMI standard ([41 ](https://github.com/eWaterCycle/grpc4bmi/issues/41))
* Default to port 55555 (24)

Added

* Pipe logs of Docker container to client (37)

This software allows you to wrap your BMI implementation (https://github.com/csdms/bmi) in a server process and communicate with it via the included python client. The communication is serialized to protocol buffers by GRPC (https://grpc.io/) and occurs over network ports.

Fixed

* Incompatibility with typeguard https://github.com/eWaterCycle/grpc4bmi/issues/128
* Singularity version on snellius cluster a gives ValueError https://github.com/eWaterCycle/grpc4bmi/issues/88