Skip to content

Commit 99769cd

Browse files
authored
Updated the getting started file (#20)
1 parent 935e983 commit 99769cd

2 files changed

Lines changed: 25 additions & 48 deletions

File tree

‎GettingStarted.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Clone the repository
2+
Run the following command to clone the repository and navigate into it:
3+
4+
git clone https://github.com/hydroframe/cssi_evaluation.git
5+
6+
cd cssi_evaluation
7+
8+
## Set up the recommended local environment
9+
10+
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).
11+
12+
mamba env create -f cssi_env.yml
13+
14+
conda activate cssi_evaluation
15+
16+
python -m ipykernel install --user --name=cssi_evaluation
17+
18+
The environment file installs the local `cssi_evaluation` package in editable mode with the
19+
`[notebooks,dev]` extras, so package imports, notebooks, and development tools are available in
20+
the same environment.
21+
22+
## Notes
23+
24+
- `pyproject.toml` is the package metadata file used by `pip install -e .`. It contains core library dependencies.
25+
- `cssi_env.yml` is the single Conda environment file intended for running examples and it contains heavy Conday/system dependencies.

‎getting_started.md‎

Lines changed: 0 additions & 48 deletions
This file was deleted.

0 commit comments

Comments
 (0)