Skip to content

Commit 22f005c

Browse files
committed
Updated Readme
1 parent 0e9ae55 commit 22f005c

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,14 +152,40 @@ And for the electrochemistry mode:
152152

153153
```csv
154154
scan_number,start_time,end_time
155-
0000, 25.0, 2025-07-02 19:05:59.614000, 2025-07-02 19:06:56.167000
156-
0001, 30.0, 2025-07-02 19:15:03.582000, 2025-07-02 19:15:59.280000
157-
0002, 35.0, 2025-07-02 19:24:07.586000, 2025-07-02 19:25:04.074000
158-
0003, 40.0, 2025-07-02 19:33:12.198000, 2025-07-02 19:34:08.917000
155+
0000, 2025-07-02 19:05:59.614000, 2025-07-02 19:06:56.167000
156+
0001, 2025-07-02 19:15:03.582000, 2025-07-02 19:15:59.280000
157+
0002, 2025-07-02 19:24:07.586000, 2025-07-02 19:25:04.074000
158+
0003, 2025-07-02 19:33:12.198000, 2025-07-02 19:34:08.917000
159159
```
160160

161161
The `<echem folder>` contains one or more electrochemistry files readable by [navani](https://github.com/be-smith/navani), Note if multiple files are present then navani will attempt to stitch them together, so do not upload duplicates (e.g processed and unprocessed versions of the same file). For the XRD usecase it's currently expected that the echem file has a `Timestamp` column containing date-time information for matching to the log file (e.g Neware files).
162162

163+
### Front-end Usage
164+
165+
The following configuration parameters are available in the *datalab* UI:
166+
167+
#### Required Parameters
168+
169+
- **`scan_time`** (UV-Vis only): The time in seconds between each scan, including any rest time. This is used to calculate the time of each scan when no log file is available.
170+
171+
#### Optional Parameters
172+
173+
##### Performance Optimization
174+
175+
- **`data_granularity`**: Controls sampling frequency along the x-axis (wavelength/2θ) of the heatmap to reduce rendering time. Default: automatically calculated to target ~1000 data points.
176+
- XRD: Uses max-pooling interpolation
177+
- UV-Vis: Uses linear interpolation
178+
179+
- **`sample_granularity`**: Controls sampling frequency along the y-axis (time/experiment number) of the heatmap. Uses linear interpolation. Default: automatically calculated to target ~1000 samples.
180+
181+
##### File Selection
182+
183+
- **`glob_str`** (XRD only): A pattern to match specific files in the XRD data folder. Examples:
184+
- `"summed"` → matches files containing "summed" (automatically converted to `*summed*`)
185+
- `"*summed*"` → matches files containing "summed" (explicit wildcards)
186+
- `"*.xy"` → matches all `.xy` files
187+
- Leave empty to process all files in the folder (default behavior)
188+
163189
## License
164190

165191
This project is released under the conditions of the MIT license. Please see [LICENSE](https://github.com/datalab-org/datalab-app-plugin-insitu/blob/main/LICENSE) for the full text of the license.

0 commit comments

Comments
 (0)