|
1. Prepare Python environment
|
|
## 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:
|
|
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:
|
|
|
|
|
... | @@ -6,8 +6,7 @@ Download Anaconda from https://www.anaconda.com/download. Choose the Python 3.7 |
... | @@ -6,8 +6,7 @@ Download Anaconda from https://www.anaconda.com/download. Choose the Python 3.7 |
|
pip install opencv-python
|
|
pip install opencv-python
|
|
conda install scikit-image dill
|
|
conda install scikit-image dill
|
|
```
|
|
```
|
|
|
|
## Download Gepard
|
|
2. 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:
|
|
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:
|
|
|
|
|
... | @@ -15,24 +14,49 @@ Download the Gepard bundle from the repository at https://gitlab.ipfdd.de/GEPARD |
... | @@ -15,24 +14,49 @@ Download the Gepard bundle from the repository at https://gitlab.ipfdd.de/GEPARD |
|
|
|
|
|
Extract all files into your preferred location. You should now have created a folder named `gepard-master`. Rename the folder to `gepard`.
|
|
Extract all files into your preferred location. You should now have created a folder named `gepard-master`. Rename the folder to `gepard`.
|
|
|
|
|
|
3. Build the tsp module
|
|
## Build the tsp module
|
|
|
|
|
|
|
|
The following step requires a C compiler. On Windows you will need to install Build Tools for Visual Studio. Most Linux distributions include GCC.
|
|
|
|
|
|
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:
|
|
In the Anaconda prompt (Windows) or the terminal (Linux, MacOS), navigate to the gepard-subfolder named `external`. Then type:
|
|
|
|
|
|
```
|
|
```
|
|
python setuptsp.py
|
|
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.
|
|
|
|
|
|
|
|
4. Start Gepard
|
|
If a compiler is not available in your system, the 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:
|
|
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
|
|
python -m gepard
|
|
```
|
|
```
|
|
|
|
|
|
|
|
## Connect to a Raman microscope
|
|
|
|
|
|
|
|
If you plan on using the WITec Raman interface to control your device, please note: **You use this interface at your OWN RISK!**
|
|
|
|
|
|
|
|
Make sure, that no obstacles block the objective and that you UNDERSTAND and VALIDATE the code that controls the microscope! Start with "witectesting.py", which should read and move within small margins.
|
|
|
|
|
|
|
|
You will need to create a Gepard configuration file. In a text editor write the following (edit the magnification to match your used objective):
|
|
|
|
```
|
|
|
|
[Interface]
|
|
|
|
raman_interface = WITEC_CONTROL
|
|
|
|
|
|
|
|
[General Microscope Setup]
|
|
|
|
magnification = 20
|
|
|
|
```
|
|
|
|
Save it as `gepard.cfg` in the Gepard folder.
|
|
|
|
|
|
|
|
To return to Simulated Raman Mode, set:
|
|
|
|
```
|
|
|
|
raman_interface = SIMULATED_RAMAN_CONTROL
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Possible errors and solutions
|
|
Errors and solutions
|
|
=============================
|
|
=============================
|
|
|
|
|
|
## Errors related to the compiling process
|
|
## Errors related to the compiling process
|
... | | ... | |