Review of NWM SWE point notebook

GettingStarted.md

@@ -1,3 +1,5 @@
+# Getting Started
+
 ## Clone the repository
 Run the following command to clone the repository and navigate into it:
 
@@ -9,11 +11,14 @@ Run the following command to clone the repository and navigate into it:
 
 Run these commands from the repository root. This assumes that conda and mamba are already installed (e.g., conda install mamba -n base -c conda-forge).
 
-    mamba env create -f cssi_env.yml
+```bash
+
+$ mamba env create -f cssi_env.yml
 
-    conda activate cssi_evaluation
+$ mamba activate cssi_evaluation
 
-    python -m ipykernel install --user --name=cssi_evaluation
+$ python -m ipykernel install --user --name=cssi_evaluation
+```
 
 The environment file installs the local `cssi_evaluation` package in editable mode with the
 `[notebooks,dev]` extras, so package imports, notebooks, and development tools are available in
@@ -23,3 +28,29 @@ the same environment.
 
 - `pyproject.toml` is the package metadata file used by `pip install -e .`. It contains core library dependencies. 
 - `cssi_env.yml` is the single Conda environment file intended for running examples and it contains heavy Conday/system dependencies.
+
+## Running the Examples
+
+Examples that demonstrate the capabilities of the evaluation framework are located in the `examples` directory:
+
+```text
+cssi_evaluation/
+├── src/cssi_evaluation/         # Core framework code
+├── examples/                    # Example notebooks and supporting assets
+│   ├── collect_observations/    # Demonstrates observation data collection capabilties
+│   ├── nwm/                     # National Water Model examples
+│   ├── parflow/                 # Parflow examples
+├── docs/                        # Project documentation and notes
+├── tests/                       # Package tests
+├── pyproject.toml               # Package metadata and dependencies
+└── README.md
+```
+
+To begin exploring these examples, issue the following command to start a Jupyter Lab interface:
+
+```bash
+$ jupyter lab
+```
+
+This will start up an interactive web interface for you to explore the capabilities of the framework. Simply navigate through the `examples` directory to begin testing.
+

README.md

@@ -174,3 +174,7 @@ The framework is intended to grow by adding:
 - clearer workflows for users bringing their own model outputs, including both physics-based and ML-based models
 
 The long-term aim is to reduce the barrier to reproducible hydrologic model evaluation while keeping the code structure aligned with the scientific workflow.
+
+## Getting Started
+
+To get started using the framework, see the [Getting Started](./GettingStarted.md) page.