Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## Clone the repository
Run the following command to clone the repository and navigate into it:

git clone https://github.com/hydroframe/cssi_evaluation.git

cd cssi_evaluation

## Set up the recommended local environment

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

conda activate 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
the same environment.

## Notes

- `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.
48 changes: 0 additions & 48 deletions getting_started.md

This file was deleted.

Loading