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-05-31 05:13 pm] – hcho | file_naming_conventions [2026-05-31 06:21 pm] (current) – [Technical identifiers] hcho | ||
|---|---|---|---|
| Line 8: | Line 8: | ||
| * Use only lowercase letters (a-z), digits (0-9), hyphens (-), and underscores (_). | * Use only lowercase letters (a-z), digits (0-9), hyphens (-), and underscores (_). | ||
| * Avoid spaces and other special characters. | * Avoid spaces and other special characters. | ||
| - | * Use **hyphens (-)** for named entities intended primarily for human reading. | + | * Use **hyphens (-)** for named entities intended primarily for human reading |
| * Use **underscores (_)** for technical identifiers intended primarily for software, programming languages, databases, GIS, and other computational environments. | * Use **underscores (_)** for technical identifiers intended primarily for software, programming languages, databases, GIS, and other computational environments. | ||
| Line 38: | Line 38: | ||
| Hyphens improve readability and match conventions commonly used in documentation, | Hyphens improve readability and match conventions commonly used in documentation, | ||
| - | |||
| - | ===== Command-line tools ===== | ||
| - | |||
| - | Command-line interface (CLI) programs use **hyphens** in executable names because they are user-facing commands. | ||
| - | |||
| - | Examples: | ||
| - | |||
| - | flow-direction | ||
| - | longest-flow-path | ||
| - | mesh-builder | ||
| ===== Workflow scripts ===== | ===== Workflow scripts ===== | ||
| Line 62: | Line 52: | ||
| 4-postprocess-results.sh | 4-postprocess-results.sh | ||
| - | ===== Generated files ===== | + | ===== Command-line tools ===== |
| - | Generated files should normally keep the same base name as their source files. | + | Command-line interface (CLI) programs use **hyphens** in executable names because they are user-facing commands. |
| - | Example: | + | Examples: |
| + | |||
| + | flow-direction | ||
| + | longest-flow-path | ||
| + | mesh-builder | ||
| - | cover-letter.tex → cover-letter.pdf | ||
| ===== Software source code ===== | ===== Software source code ===== | ||
| Line 80: | Line 73: | ||
| grid_utils.h | grid_utils.h | ||
| - | ===== Technical | + | ===== GIS datasets and technical |
| - | Technical | + | GIS datasets and technical |
| Examples: | Examples: | ||
| gcn10_amc_i.tif | gcn10_amc_i.tif | ||
| + | gcn10_amc_ii.tif | ||
| nm_hydro_basins.gpkg | nm_hydro_basins.gpkg | ||
| + | stream_order.parquet | ||
| + | |||
| + | ===== Generated files ===== | ||
| + | |||
| + | Generated files should normally keep the same base name as their source files. | ||
| + | |||
| + | Example: | ||
| + | |||
| + | cover-letter.tex → cover-letter.pdf | ||
file_naming_conventions.1780269231.txt.gz · Last modified: by hcho