Skip to content

Commit

Permalink
README.md file adjusted
Browse files Browse the repository at this point in the history
  • Loading branch information
Wail Samjouni committed Mar 21, 2024
1 parent b55c72a commit 647d320
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,28 +119,28 @@ To simulate this Building object, the CSV or Excel file must have the following
To simulate using default values for the optional arguments:

```bash
python dibs_cli.py simulate-one-building /path/to/file.csv/or/to/file.csv
dibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv
```

To simulate using custom values for all arguments:

```bash
python dibs_cli.py simulate-one-building /path/to/file.csv/or/to/file.csv din18599 mid sia2024 2007-2021
dibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv --profile_from_norm din18599 --gains_from_group_values mid --usage_from_norm sia2024 --weather_period 2007-2021
```

The below command will use the default values for `--profile_from_norm`, `--usage_from_norm`, and `--weather_period`, while using
the provided value for `--gains_from_group_values`.

```bash
python dibs_cli.py simulate-one-building /path/to/file.csv/or/to/file.csv --gains_from_group_values mid
python dibs_cli simulate-one-building /path/to/file.csv/or/to/file.csv --gains_from_group_values mid
```

### Calling for Help

To get help on the available commands and options, use the `--help` flag. For example:

```bash
python dibs_cli.py --help
dibs_cli --help
```

This will display an overview of the available commands and their options.
Expand Down

0 comments on commit 647d320

Please sign in to comment.