grpc4bmi
Purpose
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.
Installation
Optionally, create your virtual environment and activate it, Then, run
pip install grpc4bmi
on the client (python) side. If your server model is implemented in Python, do the same in the server environment (e.g. docker container). If the model is implemented in R, run instead
pip install grpc4bmi[R]
in the server environment. For bleeding edge version from GitHub use
pip install git+https://github.com/eWaterCycle/grpc4bmi.git#egg=grpc4bmi
Finally if the model is implemented in C or C++, clone this git repo and run
make ; make install
in the cpp folder.
Usage
Model written in Python
For inspiration look at the example in the test directory. To start a server process that allows calls to your BMI implementation, type
run-bmi-server --name <PACKAGE>.<MODULE>.<CLASS> --port <PORT> --path <PATH>
where <PACKAGE>, <MODULE> are the python package and module containing your implementation, <CLASS> is your
bmi model class name, <PORT> is any available port on the host system, and optionally <PATH> denotes an
additional path that should be added to the system path to make your implementation work. The name option above is
optional, and if not provided the script will look at the environment variables BMI_PACKAGE, BMI_MODULE and
BMI_CLASS. Similarly, the port can be defined by the environment variable BMI_PORT.
This software assumes that your implementation constructor has no parameters.
Model written in C/C++ (beta)
Create an executable along the lines of cpp/run-bmi-server.cc. You can copy the file and replace the function
Bmi* create_model_instance()
{
/* Return your new BMI instance pointer here... */
}
with the instantiation of your model BMI. The model needs to implement the csdms BMI for C, but you may also implement our more object-oriented C++ interface BmiCppExtension.
Model written in R
The grpc4bmi Python package can also run BMI models written in R if the model is a subclass of AbstractBmi See https://github.com/eWaterCycle/bmi-r for instruction on R and Docker.
Run the R model a server with
run-bmi-server --lang R [--path <R file with BMI model>] --name [<PACKAGE>::]<CLASS> --port <PORT>
For example with WALRUS use
run-bmi-server --lang R --path ~/git/eWaterCycle/grpc4bmi-examples/walrus/walrus-bmi.r --name WalrusBmi --port 50051
The client side
The client side has only a Python implementation. The default BMI client assumes a running server process on a given port.
from grpc4bmi.bmi_grpc_client import BmiClient
import grpc
mymodel = BmiClient(grpc.insecure_channel("localhost:<PORT>"))
print mymodel.get_component_name()
mymodel.initialize(<FILEPATH>)
...further BMI calls...
The package contains also client implementation that own the server process, either as a python subprocess or a docker
image or a singularity image running the run-bmi-server script. For instance
from grpc4bmi.bmi_client_subproc import BmiClientSubProcess
mymodel = BmiClientSubProcess(<PACKAGE>.<MODULE>.<CLASS>)
will automatically launch the server in a sub-process and
from grpc4bmi.bmi_client_subproc import BmiClientDocker
mymodel = BmiClientDocker(<IMAGE>,<PORT>)
will launch a docker container, assuming that a GRPC BMI server will start and exposes the port <PORT>.
from grpc4bmi.bmi_client_singularity import BmiClientSingularity
mymodel = BmiClientSingularity(<IMAGE>,<PORT>)
will launch a singularity container, assuming that a GRPC BMI server will start and exposes the port <PORT>.
Development: generating the grpc code
When developers change the proto-file, it is necessary to install grpc tools python packages in your python environment:
pip install -r requirements.txt
pip install -e .
# For R integration also install the R extras with
pip install -e .[R]
and install the C++ runtime and protoc command as described in https://github.com/google/protobuf/blob/master/src/README.md.
After this, simply executing the proto_gen.sh script should do the job.
Future work
More language bindings are underway.
Metadata
Release files for grpc4bmi 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| grpc4bmi-0.2.1.tar.gz | 27.3 kB | Without provenance | Details for grpc4bmi-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| grpc4bmi-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for grpc4bmi-0.2.1-py3-none-any.whl |
Total release size: 67.0 kB
Release files / grpc4bmi-0.2.1.tar.gz
| Download URL | grpc4bmi-0.2.1.tar.gz |
|---|---|
| Size | 27.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5bc6200ef251516c90143fb8e32d5fdf417d6e6b582a1c7ccc27d99978504560
|
|
BLAKE2b-256 checksum How to use checksums |
1335e4bd96107cc20a29f6c6732b9d047a8b146e8a7be08f4f4d03a901c09b07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.7
|
Release files / grpc4bmi-0.2.1-py3-none-any.whl
| Download URL | grpc4bmi-0.2.1-py3-none-any.whl |
|---|---|
| Size | 39.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
830a62ef1cc3a9482579b98604d1689577570da98f1be737bf447646424f2fbb
|
|
BLAKE2b-256 checksum How to use checksums |
b4cc2499c1a9850a7310f5a406440974ed49f957f4436fc1fb831e5217866e24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.7
|
Security for grpc4bmi 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.