Skip to content

Commit

Permalink
Merge pull request #49 from Emre-Yorat89/main
Browse files Browse the repository at this point in the history
added ramp package installation guide and correction of syntax of installation.rst file for bash code displaying
  • Loading branch information
davide-f authored Sep 7, 2024
2 parents 64f873c + fa95d0f commit c5832b1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,13 @@ The recurrent meeting on PyPSA-Distribution is every second Tuesday at 15:00 AM
Java(TM) SE Runtime Environment (build 1.8.0_341-b10)
Java HotSpot(TM) 64-Bit Server VM (build 25.341-b10, mixed mode)
```
6. Extra python package requirements are satisfied by manually installing them. Currently the ramp package is added to existing pypsa-earth environment by using:

```bash
.../pypsa-distribution % conda activate pypsa-earth
(pypsa-earth) pip install rampdemand
```

## Test run

- In the folder open a terminal/command window to be located at this path `~/pypsa-distribution/`
Expand Down
11 changes: 11 additions & 0 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,25 @@ The python package requirements are curated in the `pypsa-earth/envs/environment
The environment can be installed using:

.. code:: bash
.../pypsa-distribution % conda env create -f pypsa-earth/envs/environment.yaml
If the above takes longer than 30min, you might want to try mamba for faster installation:

.. code:: bash
(base) conda install -c conda-forge mamba
.../pypsa-distribution % mamba env create -f pypsa-earth/envs/environment.yaml
Extra python package requirements are satisfied by manually installing them. Currently the ramp package is added to existing pypsa-earth environment by using:

.. code:: bash
.../pypsa-distribution % conda activate pypsa-earth
(pypsa-earth) pip install rampdemand
Install the pre-commit (for developers)
=======================================
Expand All @@ -69,6 +79,7 @@ The tool provide automated ways to keep the code clean and consistent.
To make sure to install the tool, please run:

.. code:: bash
.../pypsa-distribution % conda activate pypsa-earth
.../pypsa-distribution % pre-commit install
Expand Down

0 comments on commit c5832b1

Please sign in to comment.