NSF ExFAB BioFoundry Wiki

User Tools

Site Tools

Trace:
nasfilestructure

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
nasfilestructure [2026/08/14 01:12] – created alexnnasfilestructure [2026/08/14 01:21] (current) – alexn
Line 1: Line 1:
-# File Naming Convention+====== File Naming Convention ======
  
 How run folders are named and organized on the NAS. Follow this whenever you set up a run. How run folders are named and organized on the NAS. Follow this whenever you set up a run.
  
-## The Path+ 
 + 
 +==== The Path ====
  
 <code> <code>
 +# General Form
 <nas_root>/<equipment_name>/<project_id>/{EXPERIMENT|TEST}/<DATE>_<NICKNAME>/ <nas_root>/<equipment_name>/<project_id>/{EXPERIMENT|TEST}/<DATE>_<NICKNAME>/
  
-//nas01/lab/CONFOCAL_01/cortex-q3/EXPERIMENT/2026-04-17-14_layer5-sweep/+ 
 +# Example 
 +//nas01/data/ucr_liquid_handler/UCR-005-I-D_Wheeldon/EXPERIMENT/2026-04-17-14_layer5-sweep/
 </code> </code>
  
Line 18: Line 23:
 | `<DATE>_<NICKNAME>` | The run | Date from the clock; nickname is yours | | `<DATE>_<NICKNAME>` | The run | Date from the clock; nickname is yours |
  
-## Why It Matters+==== Why It Matters ====
  
 Analysis picks up work by pattern-matching the tree. `*/*/EXPERIMENT/*` should be a complete list of every experimental run in the lab. A folder named off-convention doesn't error — it is silently skipped, which is worse. Analysis picks up work by pattern-matching the tree. `*/*/EXPERIMENT/*` should be a complete list of every experimental run in the lab. A folder named off-convention doesn't error — it is silently skipped, which is worse.
  
-## Equipment and Project+==== Equipment and Project ====
  
 **`<equipment_name>`** is fixed per instrument and spelled the same way every time. Use the exact string the lab has agreed on for that machine, not a variation. **`<equipment_name>`** is fixed per instrument and spelled the same way every time. Use the exact string the lab has agreed on for that machine, not a variation.
Line 29: Line 34:
  
 <code> <code>
-UCR-005-I-D-Wheeldon+UCR-005-I-D_Wheeldon
 </code> </code>
  
Line 38: Line 43:
 Both use the same character rules as the nickname, below. Neither may be the literal word `EXPERIMENT` or `TEST`. Both use the same character rules as the nickname, below. Neither may be the literal word `EXPERIMENT` or `TEST`.
  
-## EXPERIMENT vs TEST+==== EXPERIMENT vs TEST ====
  
 Two literal uppercase folders between the project and the run. Every run goes in one of them; a run folder never sits directly under the project folder. Two literal uppercase folders between the project and the run. Every run goes in one of them; a run folder never sits directly under the project folder.
Line 52: Line 57:
 **The run folder name carries no marker of which one it is.** `2026-04-17-14_calib` looks identical whether it's real data or a calibration sweep; only its parent folder tells you. So never classify a run by its name alone, and be careful when copying a run folder out of the tree — it loses that context. **The run folder name carries no marker of which one it is.** `2026-04-17-14_calib` looks identical whether it's real data or a calibration sweep; only its parent folder tells you. So never classify a run by its name alone, and be careful when copying a run folder out of the tree — it loses that context.
  
-## The Date+==== The Date ====
  
 **Year, month, and day are required. Hour, minutes, and seconds are optional.** All zero-padded, 24-hour clock, hyphen-separated. **Year, month, and day are required. Hour, minutes, and seconds are optional.** All zero-padded, 24-hour clock, hyphen-separated.
Line 86: Line 91:
 </code> </code>
  
-## The Nickname+==== The Nickname ====
  
 **Anything you want.** If the date in front is correct, nothing cares what comes after the underscore. No vocabulary, no keywords. Nothing parses it. **Anything you want.** If the date in front is correct, nothing cares what comes after the underscore. No vocabulary, no keywords. Nothing parses it.
Line 111: Line 116:
 **Suggestions, not rules:** describe the run, not the date or the project — both are already in the path. Reusing the same nickname across many runs is fine and reads well; the date makes them unique. Say *why* a run is unusual (`rerun-after-laser-swap`) rather than *what number* it is (`run2b-final-FINAL`). **Suggestions, not rules:** describe the run, not the date or the project — both are already in the path. Reusing the same nickname across many runs is fine and reads well; the date makes them unique. Say *why* a run is unusual (`rerun-after-laser-swap`) rather than *what number* it is (`run2b-final-FINAL`).
  
-## Bad Names+==== Bad Names ====
  
 | | | | | |
Line 123: Line 128:
 | `2026-04-17-14_.hidden` | Starts with a dot | | `2026-04-17-14_.hidden` | Starts with a dot |
 | `2026-04-17-14_NUL` | Windows reserved name | | `2026-04-17-14_NUL` | Windows reserved name |
-| `cortex-q3/2026-04-17-14_sweep` | Missing the `EXPERIMENT`/`TEST` folder | +| `UCR-005-I-D/2026-04-17-14_sweep` | Missing the `EXPERIMENT`/`TEST` folder | 
-| `cortex-q3/Experiment/...` | Must be uppercase | +| `UCR-005-I-D/Experiment/...` | Must be uppercase | 
-| `cortex-q3/EXPERIMENTS/...` | Singular | +| `UCR-005-I-D/EXPERIMENTS/...` | Singular |
- +
-## Older Folders +
- +
-The previous convention used a `Run_` prefix and an ISO timestamp, with test runs in a `TestRuns/` subfolder: +
- +
-| Old | New | +
-|---|---| +
-| `CONFOCAL_01/cortex-q3/Run_2026-04-17T14-32-00/` | `CONFOCAL_01/cortex-q3/EXPERIMENT/2026-04-17-14_<nickname>/` | +
-| `CONFOCAL_01/cortex-q3/TestRuns/TestRun_2026-04-17T08-05-00/` | `CONFOCAL_01/cortex-q3/TEST/2026-04-17-08_<nickname>/` | +
- +
-Leave existing folders alone. This convention applies to new runs.+
  
-## Cheat Sheet+==== Cheat Sheet ====
  
 <code> <code>
nasfilestructure.1786669947.txt.gz · Last modified: by alexn