Skip to content

Commit 9877557

Browse files
Update from develop
2 parents fdaa644 + 2637689 commit 9877557

File tree

160 files changed

+4531
-3330
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

160 files changed

+4531
-3330
lines changed

README.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ navigate
1111
[![Tests](https://github.com/TheDeanLab/navigate/actions/workflows/push_checks.yaml/badge.svg)](https://github.com/TheDeanLab/navigate/actions/workflows/push_checks.yaml)
1212
[![codecov](https://codecov.io/gh/TheDeanLab/navigate/branch/develop/graph/badge.svg?token=270RFSZGG5)](https://codecov.io/gh/TheDeanLab/navigate)
1313

14-
Navigate is an open source Python package for control of light-sheet microscopes. It allows for easily reconfigurable hardware setups and automated acquisition rotuines.
14+
**navigate** is an open source Python package for control of light-sheet microscopes.
15+
It allows for easily reconfigurable hardware setups and automated acquisition rotuines.
1516

1617
### Quick install
1718

@@ -31,23 +32,27 @@ Please refer to and contribute to the documentation, which can be found on GitHu
3132

3233
### Command Line Arguments
3334

34-
* optional arguments:
35-
* -h, --help show this help message and exit
36-
37-
* Input Arguments:
38-
* -sh, --synthetic_hardware
39-
* --config_file CONFIG_FILE
40-
* --experiment_file EXPERIMENT_FILE
41-
* --etl_const_file ETL_CONST_FILE
42-
* --rest_api_file REST_API_FILE
43-
* --logging_config LOGGING_CONFIG
44-
45-
### Authors
46-
* Kevin Dean
47-
* Zach Marin
48-
* Xiaoding 'Annie' Wang
49-
* Dax Collison
50-
* Sampath Rapuri
51-
* Samir Mamtani
52-
* Renil Gupta
53-
* Andrew Jamieson
35+
Below are the optional arguments that can be passed to the navigate software:
36+
37+
- `-h, --help`
38+
Provides information on the optional arguments that can be passed to **navigate**.
39+
- `-sh, --synthetic_hardware`
40+
Open the software without any hardware attached for testing
41+
and setting up a new system.
42+
- `-c, --configurator`
43+
Open the **navigate** configuration wizard, which provides a
44+
graphical interface for setting up the hardware configuration.
45+
- `-d`
46+
Enables the debugging menu in the software.
47+
- `--config-file`
48+
Pass a non-default `configuration.yaml` file to **navigate**.
49+
- `--experiment_file`
50+
Pass a non-default `experiment.yaml` file to **navigate**.
51+
- `--gui-config-file`
52+
Pass a non-default `gui_config.yaml` file to **navigate**.
53+
- `--waveform-constants-file`
54+
Pass a non-default waveform constants file to **navigate**.
55+
- `--rest_api_file`
56+
Pass a non-default REST API file to **navigate**.
57+
- `--logging_config`
58+
Pass a non-default logging configuration file to **navigate**.

docs/source/user_guide/case_studies/acquire_exASLM.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ To achieve this, **navigate** receives a `trigger signal <http://www.asiimaging.
1212
from the stage controller to start image acquisition once
1313
the stage has reached the desired position and velocity. Thereafter, **navigate** acquires images
1414
at a constant rate until the stage has reached the end position. This mode of acquisition is termed
15-
"Constant Velocity Acquisition", and is implemented as a feature in **navigate**.
15+
"Constant Velocity Acquisition", and is implemented as a plugin in **navigate**. To
16+
download the plugin, please visit `navigate-constant-velocity-acquisition
17+
<https://github.com/TheDeanLab/navigate-constant-velocity-acquisition>`_.
1618

17-
Furthermore, since the stage moves at a 45 degree angle relative to the microscope detection axis,
19+
Since the stage moves at a 45 degree angle relative to the microscope detection axis,
1820
computational shearing of the data is necessary. For large data sets, this can become computationally challenging and
1921
unnecessarily results in greater data overhead owing to empty space introduced in the data.
2022
To avoid this, we also provide a guide on how to perform two axis stage

docs/source/user_guide/file_formats.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Image Writing Benchmarks
5858
------------------------
5959

6060
To evaluate the performance of saving imaging data in different formats, we conducted
61-
benchmarks on a RedHat Linux system. We assessed the median disk write time for TIFF,
61+
benchmarks on a Windows 10 system. We assessed the median disk write time for TIFF,
6262
OME-TIFF, H5, N5, and OME-Zarr formats across image resolutions of 512x512,
6363
1024x1024, and 2048x2048 under two conditions: (A) capturing 1000 single-plane
6464
images and (B) acquiring a single z-stack composed of 1000 planes. All times

docs/source/user_guide/hardware/configurations/configuration_mesospimbt.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# Only one microscope can be active in the GUI at a time, but all microscopes will be accessible
21
microscopes:
32
BTMesoSPIM:
43
daq:
@@ -45,7 +44,7 @@ microscopes:
4544
filter_wheel:
4645
hardware:
4746
type: ASI #SyntheticFilterWheel #SutterFilterWheel
48-
wheel_number: 1
47+
wheel_number: 0
4948
port: COM8
5049
baudrate: 115200
5150
filter_wheel_delay: .030 # in seconds

0 commit comments

Comments
 (0)