-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
69 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,36 @@ | ||
# Configuring Sashimi | ||
# Configuring Sashimi | ||
|
||
Sashimi includes the `sashimi-config` module that lets you interact with the hardware and software | ||
settings from command line. You can display the current configuration of the system.: | ||
|
||
sashimi-config show | ||
|
||
You can ask sashimi for help: | ||
|
||
sashimi --help | ||
|
||
More information on its usage can be found by asking `sashimi-config` for help: | ||
|
||
sashimi-config --help | ||
|
||
You can add and modify parameters just from the command line. For example, to set the piezo waveform readout channel to `Dev1/ao0:0` just run: | ||
|
||
sashimi-config edit -n z_board.write.channel -v Dev1/ao0:0 | ||
|
||
Or to modify the minimum and maximum voltage (in Volts) of the channel: | ||
|
||
sashimi-config edit -n piezo.position_write.min_val -v 0 | ||
sashimi-config edit -n piezo.position_write.max_val -v 10 | ||
|
||
|
||
## Starting the software from command line | ||
|
||
Open a new anaconda prompt and activate your environment like above. Then run: | ||
|
||
sashimi | ||
|
||
Add the option `--scopeless`: | ||
|
||
sashimi --scopeless | ||
|
||
If you want to run the software with mock hardware, such as for debugging or developing. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Installation | ||
|
||
[Install the latest Anaconda](https://www.anaconda.com/) distribution of Python 3. | ||
|
||
Clone this repository and navigate to the main folder `../sashimi` | ||
|
||
## Recommended: Create a new environment | ||
|
||
It is a good practice to create an environment for every project. The provided `environment.yml` sets up almost all required dependencies (see below). | ||
|
||
conda env create -f {path to environment.yml} | ||
|
||
You can activate the environment by running: | ||
|
||
conda activate sashimi | ||
|
||
After this you moght have to install two extra dependencies for controlling a Cobolt laser: | ||
|
||
pip install pyvisa | ||
pip install pyvisa-py | ||
|
||
## Install with pip | ||
|
||
For a non-editable installation run: | ||
|
||
pip install . | ||
|
||
Otherwise, if you want to contribute to the project as a developer, for editable installation run: | ||
|
||
pip install -e . | ||
|
||
Now you are ready to go! |
This file was deleted.
Oops, something went wrong.