Installation

Library installation

Install using pip, either system-wide (administrator rights are needed):

pip install tof-simulator

or (usually preferred) for the current user:

pip install --user tof-simulator

Note

The installation as described above does not include GUI systems, they are optional

To install the optional Gtk GUI use:

pip install --user tof-simulator[gtk]

The optional Web GUI uses streamlit ( https://streamlit.io/ ), and can be installed as:

pip install --user tof-simulator[stl]

In order to install from source, you can:

Clone the project

git clone https://github.com/fiolj/tof-simulator

Go to the local folder of the project and build the package:
```
cd tof-simulator
python3 -m build
```

Install the recently created package

pip install --user dist/tofsim-4.0-py3-none-any.whl[gtk,stl]

In order to run the simulator programmatically:
- Only Numpy is required.
- Optionally, matplotlib is needed to use included capabilities for plotting.
To use the Gtk GUI, the requirements are:
- matplotlib
- PyGobject.
  
  Information on how to install PyGobject on different platforms may be found in the documentation
To use the Gtk GUI, the requirements are:
- matplotlib
- streamlit