https://github.com/royerlab/sample-project
Sample microscope project for ClearControl environment
https://github.com/royerlab/sample-project
clearcontrol tutorial
Last synced: 8 months ago
JSON representation
Sample microscope project for ClearControl environment
- Host: GitHub
- URL: https://github.com/royerlab/sample-project
- Owner: royerlab
- Created: 2018-12-26T12:14:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-28T09:32:18.000Z (over 7 years ago)
- Last Synced: 2025-07-03T09:11:37.905Z (9 months ago)
- Topics: clearcontrol, tutorial
- Language: Java
- Size: 903 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sample Microscope
Sample microscope project for ClearControl environment. This project is
the basis for all ClearControl tutorials.
## Get the project
```bash
git clone https://github.com/ClearControl/sample-project
cd sample-project
```
## Build
You can build the project with or without gradle.
With gradle:
```bash
gradle build
```
Without gradle:
```bash
./gradlew build
```
## Configure
This part is significant. If this is your first time with ClearControl
start with creating a folder `.clearcontrol` under the your user file
on Windows OS ( currently we only have support for the Windows due to driver
dependencies we have ), i.e. `C:\Users\YOURUSERNAME\.clearcontrol`.
Then create a new file in that folder with name `configuration.txt`. This
file will be your main configuration file for your connected hardware.
You can copy the content of `configuration.txt.hide` file as a starting
point. For more details on writing configuration can be found
[here](tutorials/CONFIGURATION.md).
## Run
Run the `SampleMain` class as an application. Then a window will pop up
with several options to start the software:
- options image here
Then depending on your choice main control window will be loaded:
- loaded software image here
.
For more check the further detailed [tutorials](tutorials/README.md).