Skip to content

Commit 3778d67

Browse files
committed
Merged PR 1260: [docs]: Updated README
- [docs]: fixed typos
1 parent a0f29b1 commit 3778d67

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The typical workflow involves:
3333
### Command-Line Interface
3434
Run a scenario with:
3535
```bash
36-
pypsa_canada run -f config/[your-scenario].yaml
36+
(env) >> pypsa_canada run -f config/[your-scenario].yaml
3737
```
3838

3939
Available example scenarios in the `example/scenarios/` directory:
@@ -68,17 +68,18 @@ For NRCAN internal users:
6868
$ git clone https://nrcan-eets-cev-renouvelable-devops@dev.azure.com/nrcan-eets-cev-renouvelable-devops/Canadian_Scenarios_Analysis/_git/pypsa_canada
6969
```
7070

71-
1. Create the virtual environment with either Conda or Python with Python 3.11
71+
1. Create the virtual environment with either Conda or Python with Python 3.12. Feel free to choose the name of your environment.
7272

7373
1-a) **For Anaconda/Miniconda users only, create a virtual environment with the following command:
7474
```bash
75-
$(base) conda create --name pypsa_cad_p312 python=3.12.10
75+
$(base) conda create --name pypsa_canada_p312 python=3.12.10
7676
```
7777

7878
1-b) **For Python users only, assuming you have a Python 3.12 installed, execute the following command to create a new virtual environment:
7979
```bash
80-
$(base) python -m venv pypsa_cad_p312
80+
$(base) python -m venv pypsa_canada_p312
8181
```
82+
8283
1-b) Proceed to activate the environment
8384

8485
2. Go into the project folder
@@ -88,7 +89,7 @@ $(base) python -m venv pypsa_cad_p312
8889
3. Install the package/library:
8990

9091
```bash
91-
(pypsa-cad_py312) >> pip install -e .[dev]
92+
(env) >> pip install -e .[dev]
9293
```
9394

9495
Following these steps, most dependencies should be installed and you should be able to use pypsa_canada
@@ -101,12 +102,12 @@ Following these steps, most dependencies should be installed and you should be a
101102

102103
2. To execute an example
103104
```bash
104-
(pypsa-cad_py312) >> pypsa_canada run -f scenarios\Canada-National-no-CER.yaml
105+
(env) >> pypsa_canada run -f config\minimal_model.yaml
105106
```
106107

107108
3. If the process is stale, you will need to unlock it with the following command
108109
```bash
109-
(pypsa-cad_py312) >> pypsa_canada run -f scenarios\Canada-National-no-CER.yaml --unlock
110+
(env) >> pypsa_canada run -f sconfig\minimal_model.yaml --unlock
110111
```
111112

112113
## Developers

0 commit comments

Comments
 (0)