Skip to content

Commit

Permalink
restyle docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fedem-p committed Apr 15, 2021
1 parent 32f4b7d commit ead3a98
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 72 deletions.
2 changes: 1 addition & 1 deletion docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

- part: Overview
chapters:
- file: intro
- file: timeline

- part: Configuration
chapters:
- file: configuration/installation
- file: configuration/configuration

- part: Development
Expand Down
37 changes: 36 additions & 1 deletion docs/configuration/configuration.md
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.
32 changes: 32 additions & 0 deletions docs/configuration/installation.md
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!
70 changes: 0 additions & 70 deletions docs/intro.md

This file was deleted.

0 comments on commit ead3a98

Please sign in to comment.