Skip to content

Commit 31846a0

Browse files
authored
Update README.md
1 parent e438258 commit 31846a0

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ working_directory/
5656
└── outputs/
5757
```
5858

59-
A Python script called "[run_quickstart.py](https://github.com/Critical-Infrastructure-Systems-Lab/PowNet/blob/master/scripts/run_quickstart.py)" provides an example on running a simulation, saving the simulation outputs, and visualizing the outputs.
59+
A tutorial "[quickstart.py](./examples/quickstart.ipynb)" provides an example on running a simulation, saving the simulation outputs, and visualizing the outputs.
6060

6161
### Option 2: Power user (no pun intended)
6262
In case we wish to modify the source code, PowNet should be installed as an editable package. First, download or clone the PowNet repository to your local machine. For example: if we want to clone to "C://user/pownet",
@@ -79,10 +79,9 @@ pip install -e .
7979

8080
This command installs the package in "editable" mode (-e) using pyproject.toml that is located in the root directory of PowNet. The editable mode allows us to edit PowNet codebase when we need to modify or implement new features. The pyproject.toml file specifies the dependencies required to run PowNet.
8181

82-
A quick start tutorial to run a simple case study is provided here: https://pownet.readthedocs.io/en/latest/pages/quickstarter.html
8382

8483
## Overview of PowNet
8584

86-
![overview_pownet](./docs/overview_pownet.png)
85+
![overview_pownet](./joss_submission/overview_pownet.png)
8786

8887

0 commit comments

Comments
 (0)