Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ipo-exe authored Oct 15, 2020
1 parent 51213e8 commit 23522f0
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
## What is included in this repository

- [x] The python files required to run Plans2;
- [x] A directory called 'samples' with examples of all input files;
- [ ] A 'Handbook' in PDF format.
- [x] A directory called '`samples`' with examples of all input files;
- [ ] A '`Plans2_handbook.pdf`' document.

## Python and packages required

Expand All @@ -26,11 +26,11 @@ Plans2 is built on top of:
Go to https://www.python.org/downloads/ and download it. Make sure you add Python to PATH (checkbox on the installation wizard).

### Step 2: install the packages
To run Plans2 you need Numpy, Pandas, Matplotlib and Scipy. If you do not have it already installed, you can do that by using terminal or an IDE, like Pycharm.
To run Plans2 you need `numpy`, `pandas`, `matplotlib` and `scipy`. If you do not have it already installed, you can do that by using terminal or an IDE, like PyCharm.

On Windows terminal:

`C:\Windows\System32\python -m pip install --upgrade pip` (this will update pip)
`C:\Windows\System32\python -m pip install --upgrade pip` (this will update `pip`)

then:
`C:\Windows\System32\python -m pip install numpy`
Expand Down Expand Up @@ -83,7 +83,13 @@ This is a directory that works as a package of modules for very simple unit oper

## Structure of a Plans2 Project

text
In the first time you run it, Plans2 automatically creates a directory in `C:/Plans2`. This is the standard root directory for all Plans2 projetcs.
Projects are subdirectories inside the root folder, like `C:/Plans2/myproject/`. Once a project is named by the user, Plans2 create the project strucutre, which includes:
* A directory for datasets in `C:/Plans2/myproject/datasets/`
* A directory for storing execution files in `C:/Plans2/myproject/runbin`

Datasets are divided in `./datasets/observed` and `./datasets/projected`.
`./datasets/observed` stores all data files for the "present" time of the water system being modelled.

## The Terminal-based interface (TUI)

Expand Down

0 comments on commit 23522f0

Please sign in to comment.