Skip to content

Commit

Permalink
fix typos & clean up language in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vtnate committed Jun 3, 2024
1 parent c9b1ed8 commit ab42e1d
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ bundle exec rake run_high_efficiency[json,csv]
bundle exec rake run_mixed[json,csv]
```

Where, `json` is the name of the FeatureFile `csv` is the name of the
scenario file corresponding to that feature file. For example, to run the `createbar` project for
Where `json` is the name of the FeatureFile and `csv` is the name of the
scenario file corresponding to that feature file. For example, to run the `createbar` project for
baseline scenario, use
the `example_project.json` as json and `createbar_scenario.csv` as csv.

Expand All @@ -78,8 +78,8 @@ the `example_project.json` as json and `createbar_scenario.csv` as csv.
bundle exec rake run_thermal_storage[json,csv]
```

Where, `json` is the `example_project.json` FeatureFile and `csv` is the name of the
baseline, high efficiency or mixed csv for this feature file.
Where `json` is the FeatureFile (such as `example_project.json`) and `csv` is the name of the
baseline, high efficiency or mixed scenario csv for this feature file (for example `thermal_storage_scenario.csv`).

**Post-processing the projects**

Expand All @@ -101,14 +101,14 @@ bundle exec rake post_process_high_efficiency[json,csv]
bundle exec rake post_process_mixed[json,csv]
```

Where, `json` is the is the name of the FeatureFile and `csv` is the name of the scenario file
corresponding to the feature file, that you would like to post-process.
Where `json` is the is the name of the FeatureFile and `csv` is the name of the scenario file
corresponding to the feature file that you would like to post-process.

```ruby
bundle exec rake post_process_thermal_storage[json,csv]
```

Where, `json` is the `example_project.json` FeatureFile and `csv` is the name of a scenario file for this feature file.
Where `json` is the `example_project.json` FeatureFile and `csv` is the name of a scenario file for this feature file.

**Visualizing post-processing results**

Expand Down Expand Up @@ -152,8 +152,8 @@ bundle exec rake clear_high_efficiency[json,csv]
bundle exec rake clear_mixed[json,csv]
```

Where, `json` is the is the name of the FeatureFile and `csv` is the name of the scenario file
corresponding to the feature file, that you would like to clear.
Where `json` is the is the name of the FeatureFile and `csv` is the name of the scenario file
corresponding to the feature file that you would like to clear.

```ruby
bundle exec rake clear_thermal_storage[json,csv]
Expand Down

0 comments on commit ab42e1d

Please sign in to comment.