- Prepare Python environment
Download Anaconda from https://www.anaconda.com/download. Choose the Python 3.7 version and follow the installer instructions. For help regarding installation, please refer to the Anaconda installation guide. Anaconda includes most of the required python libraries, however some packages need to be installed manually. To do that, start an Anaconda prompt from the Start Menu (Windows) or re-open a terminal (Linux, MacOS) and type the following:
pip install opencv-python
conda install scikit-image dill
- Download Gepard
Download the Gepard bundle from the repository at https://gitlab.ipfdd.de/GEPARD/gepard. Be careful to download the master branch, unless you know what you're doing:
Extract all files into your preferred location. You should now have created a folder named gepard-master
. Rename the folder to gepard
.
- Build the tsp module
The following step requires a C compiler. In the Anaconda prompt (Windows) or the terminal (Linux, MacOS), navigate to the gepard-subfolder named external
. Then type:
python setuptsp.py
If a compiler is not available in your system, the above command will produce an error. The exact wording depends on your operating system.
- Start Gepard
In the Anaconda prompt (Windows) or terminal (Linux, MacOS) navigate to the location containing the folder gepard
. You can now start using Gepard in Simulated Raman Mode by typing:
python -m gepard
Possible errors and solutions
Errors related to the compiling process
Import error: cannot import name 'tsp' from 'gepard.external'
: The tsp module has not been compiled (properly). Try compiling again or use a pre-compiled module.
error: command 'gcc' failed with exit status 1
(Linux): Your system's C-compiler, gcc
, is not installed or not up to date. Install the corresponding packages or update your system and try again.
If that doesn't work, the issue might be Anaconda not linking to the external gcc compiler. Try again after installing the Anaconda compiler with:
conda install gcc_linux-64
Errors related to Gepard operation
no module named gepard
: Please make sure thet you are attempting to start Gepard from it's parent folder, i.e. the location containing the folder "gepard".