Library for process data exchange
Project description
This is the README file of the PdCom library, that is part of the EtherLab project (http://etherlab.org/en). The home of PdCom is http://etherlab.org/en/pdcom. The Library is released under the terms and conditions of the GNU Lesser General Public License (LGPL), version 3 or (at your option) any later version.
Documentation
You can find the documentation online here.
The library documentation resides in the header files and can be brought to HTML, LaTeX and man format with the doxygen tool. To generate the documentation, make sure that doxygen is installed and then call:
git submodule update --init
mkdir build
cd build
cmake -DBUILD_TESTING=OFF ..
make doc
Then point your favourite browser to doc/html/index.html.
Building and Installing
To just build and install the library, call:
mkdir build
cd build
cmake -DBUILD_TESTING=OFF -DCMAKE_BUILD_TYPE=Release ..
make
make install
You'll need the following packages:
- libexpat-devel
- libgnutls-devel
- cyrus-sasl-devel
For running the unit tests, the GTest library is required.
Python API
In the python subdirectory, an asyncio based Python API is provided.
It requires Python >= 3.6, numpy and pybind11 >= 2.6.0.
Please note that make install
does not install this Python module.
Instead, please navigate to the python subdirectory after installing the C++ library
and install the pdcom5 python module using pip3 install .
.
There are also some pre-built wheel packages available.
Use pip3 install pdcom5 --extra-index-url https://gitlab.com/api/v4/projects/etherlab.org%2Fpdcom/packages/pypi/simple
to install pdcom5 from the GitLab package registry.
Please note that libexpat
and libsasl2
are expected to be available on your system,
the PdCom5 library is included in the wheel.
Further Information
For questions of any kind, subscribe to the etherlab-users mailing list at http://etherlab.org/en.
Have fun with PdCom!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for pdcom5-5.0.0a7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9db6a25b3c6806be1340c0118ed3f46d152dc377824c2128449e63c854dbb3f |
|
MD5 | e9e50d32d1a537af128e5940c2beb1b3 |
|
BLAKE2b-256 | 5d02436294828ae0f605b8142088076dabb712a59025f32eb205a864e019993a |