file_naming_conventions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| file_naming_conventions [2026-03-10 07:03 pm] – hcho | file_naming_conventions [2026-03-10 07:23 pm] (current) – hcho | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== File naming conventions ====== | ====== File naming conventions ====== | ||
| - | This page defines the filename and directory naming conventions used in lab repositories. | + | This page defines the filename and directory naming conventions used in lab repositories. These conventions apply to new repositories and new files. Existing repositories are not retroactively renamed unless there is a strong practical reason to do so. |
| ===== General principles ===== | ===== General principles ===== | ||
| * Use descriptive names. | * Use descriptive names. | ||
| - | * Avoid spaces in filenames | + | * Use only lowercase letters (a-z), digits (0-9), hyphens (-), and underscores (_). |
| - | * Use lowercase letters. | + | * Avoid spaces and other special characters. |
| * Use **hyphens (-)** by default. | * Use **hyphens (-)** by default. | ||
| * Use **underscores (_)** only for software source code files. | * Use **underscores (_)** only for software source code files. | ||
| Line 37: | Line 37: | ||
| longest-flow-path | longest-flow-path | ||
| mesh-builder | mesh-builder | ||
| + | |||
| + | ===== Workflow scripts ===== | ||
| + | |||
| + | Workflow scripts are treated as command-line tools and therefore also use **hyphens**. | ||
| + | |||
| + | If the execution order matters, a numeric prefix may be used. | ||
| + | |||
| + | Examples: | ||
| + | |||
| + | 1-download-files.sh | ||
| + | 2-preprocess-files.sh | ||
| + | 3-run-model.sh | ||
| + | 4-postprocess-results.sh | ||
| ===== Software source code ===== | ===== Software source code ===== | ||
file_naming_conventions.1773190984.txt.gz · Last modified: by hcho