Skip to content

Commit e6e6eab

Browse files
committed
docs: update readme with additional info
1 parent 69a178f commit e6e6eab

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

scripts/CLUSTER.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,18 @@ running on the cluster.
88
installs miniconda for your cluster environment.
99

1010
2. [Create Environment](stability-cluster/env_creation.sh) -
11-
creates a basic conda environment with the requirements to run experiments.
11+
creates a basic conda environment for experiments.
12+
13+
- Creates a conda environment at the prefix `CONDA_ENV_PATH` path.
14+
> Using the positional argument passed into the script
15+
- Clones `chemnlp` into your personal cluster `USER` directory.
16+
- Installs the current revision of the `chemnlp` repository and
17+
dependencies that are in your personal directory into the conda environment.
18+
19+
```bash
20+
# for creating a personal environment
21+
source scripts/stability-cluster/env_creation.sh ${USER}
22+
23+
# for creating an specific experiment environment
24+
source scripts/stability-cluster/env_creation.sh experiments/my-experiment
25+
```

0 commit comments

Comments
 (0)