Skip to content

Commit d4fb613

Browse files
authored
Update readme for installation from lock envs (#1691)
1 parent 1e26c9a commit d4fb613

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,19 +89,30 @@ There are multiple ways to get involved and learn more about our work:
8989
```bash
9090
.../some/path/without/spaces % git clone https://github.com/pypsa-meets-earth/pypsa-earth.git
9191
```
92-
2. The python package requirements are curated in the `envs/environment.yaml` file.
93-
The environment can be installed using:
94-
95-
```bash
96-
.../pypsa-earth % conda env create -f envs/environment.yaml
97-
```
92+
2. The python package requirements are curated in the `envs/{your operating system}64.lock.yaml` file.
93+
- On linux, the environment can be installed using:
94+
```bash
95+
.../pypsa-earth % conda env create -f envs/linux-64.lock.yaml
96+
```
97+
- On newest macOS (arm-based), the environment can be installed using:
98+
```bash
99+
.../pypsa-earth % conda env create -f envs/osx-arm64.lock.yaml
100+
```
101+
On non-arm macOS, the environment can be installed using:
102+
```bash
103+
.../pypsa-earth % conda env create -f envs/osx-64.lock.yaml
104+
```
105+
- On Windows, the environment can be installed using:
106+
```bash
107+
.../pypsa-earth % conda env create -f envs/win-64.lock.yaml
108+
```
98109

99110
If the above takes longer than 30 min, you might want to try mamba for faster installation:
100111

101112
```bash
102113
(base) conda install -c conda-forge mamba
103114
104-
.../pypsa-earth % mamba env create -f envs/environment.yaml
115+
.../pypsa-earth % mamba env create -f envs/{{your operating system}}64.lock.yaml.yaml
105116
```
106117

107118
3. (optional) In step 2, three solvers are installed: HiGHs, glpk and gurobi. HiGHs is the recommended open-source solver. Gurobi is generally faster, but requires a license for full functionality, which is [freely available to academics](https://www.gurobi.com/features/academic-named-user-license/) (see instructions website).
@@ -129,10 +140,10 @@ There are multiple ways to get involved and learn more about our work:
129140

130141
## Running the model in previous versions
131142

132-
The model can be run in previous versions by checking out the respective tag. For instance, to run the model in version 0.6.0, which is the last version before the recent PyPSA update, the following command can be used:
143+
The model can be run in previous versions by checking out the respective tag. For instance, to run the model in version 0.8.0, which is the last version before the recent PyPSA update, the following command can be used:
133144

134145
```bash
135-
git checkout v0.6.0
146+
git checkout v0.8.0
136147
```
137148
After checking out the tag, the model can be run as usual. Please make sure to use the environment built for the respective version.
138149

0 commit comments

Comments
 (0)