Skip to content
Snippets Groups Projects

Update README

Merged Lingxin Meng requested to merge lm_update_readme into devel
1 file
+ 11
3
Compare changes
  • Side-by-side
  • Inline
+ 11
3
@@ -7,7 +7,7 @@ the submodules after making a clone of the labRemote repository. You need to
especially update the submodules if you switch to a different branch (ie: `devel`).
```shell
git submodule update --init --recusrive
git submodule update --init --recursive
```
## Commiting code
@@ -37,12 +37,20 @@ Requirements for probe station controller:
* gclib [link](http://galilmc.com/sw/pub/all/doc/gclib/html/osx.html)
Requirements for FTDICom:
* [libftdi](https://www.intra2net.com/en/developer/libftdi/download.php) - Generic FTDI library
* [libftdi](https://www.intra2net.com/en/developer/libftdi/download.php) - Generic FTDI library: ``yum -y install libftdi-devel libftdi-c++-devel``
* [libmpsse](https://github.com/l29ah/libmpsse) - Library that implements common communication protocols (I2C, SPI) using the MPSSE framework on FTDI chips
Requirements for GPIB:
* Linux-GPIB [link](https://linux-gpib.sourceforge.io/)
Requirements for JSON (used by libPS and libEquipConf):
* [nlohmann_json](https://github.com/nlohmann/json) - header-only JSON for Modern C++
Requirements for doxygen:
* Install `graphviz` for `dot` if necessary
For the installation and dependencies also refer to [.gitlab-ci.yml](.gitlab-ci.yml).
# Python Bindings
Python bindings are built via the `_labRemote` target which is enabled by the cmake flag `-DUSE_PYTHON=on`. This will put a `.so` file in `${BUILD}/lib/` that can be directly used in python. As such, it requires the Python libraries to be findable (e.g. `python3-devel` is installed). For example, after building with `make`, while inside the build directory,
@@ -104,4 +112,4 @@ python3 -c "import _labRemote as labRemote"
Note that one can choose to install only labRemote via pip:
```shell
pip install git+https://gitlab.cern.ch/berkeleylab/labRemote.git@devel
```
\ No newline at end of file
```
Loading