Conventions

Conventions#

This SUM uses the following notation and syntax conventions:

  • Monospace (code font) denotes literal user input, command names, file paths, configuration keys and environment variables — e.g. eo-data-embedding extract, artifacts/embeddings.parquet, GEO_LOG_LEVEL.

  • In command syntax, <placeholder> marks a value the user supplies, and [args] marks optional arguments. Flags use the --flag value form; a vertical bar (a | b) lists mutually exclusive choices.

  • Phase numbers (Phase 0–5) refer to the pipeline stages implemented by the scripts/phaseN_*.py scripts and exposed as CLI subcommands.

  • Cross-references to other manual pages use linked page titles (e.g. Reference manual).

Help & feedback

Documentation

Edit this page on GitHub to fix an error or add an improvement in a pull request.
Create an issue to suggest improvements to this page.

Product

Create an issue if there is something you do not like about this feature or if you would like to propose a functionality by submitting a feature request.