Skip to content

Commit 756eacb

Browse files
committed
typos
1 parent 54861db commit 756eacb

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/config.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Config
22

3-
The main functionality of pySimdeum is to build and populate houses with users and water end-use devices according to region (e.g. country, city, state) specific statistics as well as to simulate water usage and demand stochastically based on these statistics. To do this, the project uses a set of `.toml` config files that contain region specific statistics, stored in the `pysimdeum/data/` folder. Under the data folder default statistics are provided for the NL and UK. Alternatively users can copy this structure and provide config files of their own.
3+
The main functionality of pySimdeum is to build and populate houses with users and water end-use devices according to region (e.g. country, city, state) specific statistics, as well as to simulate water usage and demand stochastically based on these statistics. To do this, the project uses a set of `.toml` config files that contain region-specific statistics, stored in the `pysimdeum/data/` folder. Under the data folder, default statistics are provided for the NL and UK. Alternatively users can copy this structure and provide config files of their own.
44

55
## Using Config Files
66

7-
As a default pysimduem will use the NL statistics, with an optional flag to switch to UK data provided in the repo.
7+
By default, pySimduem will use the NL statistics, with an optional flag to switch to UK data provided in the repo.
88

99
Users can either:
10-
1. Select country specific statistics available in the repo, the UK or NL
10+
1. Select country-specific statistics available in the repo, the UK or NL
1111
2. Provide a custom directory path containing `.toml` statistics files, following the structure provided in [Config Schema](schema.md)
1212

1313
To use predefined `.toml` files, specify the country code when initializing the system, or ignore the `country` flag to use default NL data.
@@ -43,9 +43,9 @@ The custom directory must contain `.toml` files structured as follows:
4343

4444
## Description of Files
4545

46-
### Dirunal Patterns
46+
### Diurnal Patterns
4747

48-
The `dirunal_patterns.toml` file contains statistical data for modeling water demand patterns based on different demographic groups and their daily activities.
48+
The `diurnal_patterns.toml` file contains statistical data for modeling water demand patterns based on different demographic groups and their daily activities.
4949
The demographics included are:
5050
- child
5151
- teen

0 commit comments

Comments
 (0)