Skip to content

Commit 064fd5f

Browse files
committed
docs(README.md): Revise to specify location of example input files.
1 parent 1b24a96 commit 064fd5f

File tree

2 files changed

+8774
-6
lines changed

2 files changed

+8774
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,21 @@ The [original Urban Weather Generator](http://urbanmicroclimate.scripts.mit.edu/
2121
This repository is a Python translation of the original [MATLAB Urban Weather Generator](https://github.com/hansukyang/UWG_Matlab).
2222

2323
# Example
24-
Here is a Python example that shows how to create and run an Urban Weather Generator object.
24+
Here is a Python example that shows how to create and run an Urban Weather Generator object.
2525

2626
```python
2727
from uwg import UWG
2828

2929
# Define the .epw, .uwg paths to create an uwg object.
30-
epw_path = "SGP_Singapore.486980_IWEC.epw"
31-
30+
epw_path = "resources/SGP_Singapore.486980_IWEC.epw" # available in resources directory.
31+
3232

3333
# Initialize the UWG model by passing parameters as arguments, or relying on defaults
34-
model = UWG.from_param_args(bldheight=10, blddensity=0.5, vertohor=0.8, grasscover=0.1,
35-
treecover=0.1, zone='1A')
34+
model = UWG.from_param_args(epw_path=epw_path, bldheight=10, blddensity=0.5,
35+
vertohor=0.8, grasscover=0.1, treecover=0.1, zone='1A')
3636

3737
# Uncomment these lines to initialize the UWG model using a .uwg parameter file
38-
# param_path = "initialize_singapore.uwg" # available in the resources directory.
38+
# param_path = "initialize_singapore.uwg" # available in resources directory.
3939
# model = UWG.from_param_file(param_path, epw_path=epw_path)
4040

4141
model.generate()

0 commit comments

Comments
 (0)