Remote Procedure Calls
Remote Procedure Calls (
RPC) is a mechanism to transparently execute code in
a remote process or computer. This is especially useful in scenarios where COMPAS
runs inside an IronPython host (eg. Rhino) and needs to execute code that only
runs on CPython (eg. code that requires
COMPAS provides two ways to achieve this:
Xfunc, COMPAS provides a mechanism for calling Python functions through
a separately launched sub-process.
A drawback of the
Xfunc mechanism is that every call launches a new Python
(sub)process with all the overhead that that entails. For infrequent calls to
long-running processes this is not an issue. However, for frequent calls to functions
that are expected to run quickly, this is not ideal.
The second mechanism is the
rpc module. The principle of RPC is to start a server
that handles all requests. The advantage is that once the server is started,
no additional processes have to be launched and the server can handle the requests
without any overhead. Therefore, the response time is much faster than with
The basic usage of RPC is simple. For example, consider a CPython script using the Force Density method.
>>> from compas.numerical import fd_numpy >>> result = fd_numpy(...)
This script does not work in Rhino or GH because Numpy is not available. Therefore, instead of importing and calling the function directly, we call it through a proxy object.
>>> from compas.rpc import Proxy >>> numerical = Proxy('compas.numerical') >>> result = numerical.fd_numpy(...)
To use functions from more than one package in the same script, simply change the package attribute of the proxy object, which determines where the proxy will look for the requested function.
>>> from compas.rpc import Proxy >>> proxy = Proxy() >>> proxy.package = 'compas.numerical' >>> proxy.fd_numpy(...) >>> proxy.package = 'compas.geometry' >>> proxy.bestfit_plane_numpy(...)
The use of
compas.rpc is not restricted to COMPAS packages only.
>>> from compas.rpc import Proxy >>> linalg = Proxy('scipy.linalg') >>> x = linalg.solve(A, b)
Note that Numpy arrays are automatically converted to lists.
Supported data types
compas.rpc uses JSON serialization to transfer data between the “client”
(your script) and the server running the selected CPython environment.
All COMPAS objects (primitives, shapes, data structures, etc.) support JSON
serialization through their
from_json methods. On a lower level,
these methods convert (complex) internal data to simple dictionaries, and
vice versa, with
In combination with custom JSON encoders and decoders this allows for COMPAS objects to be serialized and de-serialized without loss of information on either side of the RPC communication network.
Therefore the data types supported by
compas.rpc include all native Python
data types and COMPAS objects. Numpy arrays are automatically converted to lists.
Starting and Stopping
Once a server is started it will keep running “as long as possible”. There are many reasons to stop and (re)start the server during its lifetime. For example, to load functionality from a different conda environment, or to load changes that were made to the packages in the environment after it was started. This happens frequently while a package is still under active development.
Stopping and starting the server is easy.
>>> from compas.rpc import Proxy >>> proxy = Proxy() >>> proxy.stop_server() >>> proxy.start_server()
To restart the server after every call, you can use a context manager.
When used in this way, RPC behaves much like its predecessor
>>> with Proxy('compas.numerical') as numerical: ... numerical.fd_numpy(...) ...
Starting an RPC server manually
Proxy will try to start an RPC server automatically
if no server is already running, but very often it is recommended
to start it manually from the command-line.
To start a new RPC server use the following command on the terminal
(default port is
$ compas_rpc start [--port PORT]
Conversely, to stop an existing RPC server:
$ compas_rpc stop [--port PORT]
If COMPAS is installed in a virtual environment, make sure it is activated before trying to use this command-line utility.
Currently, the RPC server is launched on the
However, it would also be possible to launch it on a remote computer on a
network, or on a server reachable over the internet.