Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mrosskopf committed Oct 10, 2024
1 parent f97ea39 commit ce625a3
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/data_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ adjacent files are expected to match exactly timing wise.

## StationXML Meta Data

Meta data, e.g. location and instrument response information, must be available
Metadata, e.g., location and instrument response information, must be available
for each channel. The channel identifiers must exactly match the channel
identifiers in the ASDF files.

Expand Down
5 changes: 5 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,14 @@ edited with the [Qt Creator](https://www.qt.io/product/development-tools).

Once the UI files have been edited they can be converted to Python files like this:

For windows:
```bash
pyside6-uic .\main_window.ui -o main_window.py
```
For Linux/Mac:
```bash
pyside6-uic ./main_window.ui -o main_window.py
```

It works the same for the other UI files.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* `scipy`
* `tqdm`

Furthermore `git` is required to get the `DUGSeis` code.
Furthermore `git` is an option to download the `DUGSeis` code. Alternatively, the code can be downloaded as a zip file from the GitHub repository.

## Installation Instructions

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ authors = [
{ name = "ETHZ" },
{ name = "Joseph Doetsch"},
{ name = "Linus Villiger", email = "[email protected]" },
{ name = "Martina Rosskopf", email = "martina.rosskopf@erdw.ethz.ch" },
{ name = "Martina Rosskopf", email = "martina.rosskopf@eaps.ethz.ch" },
{ name = "Virginie Durand"},
{ name = "Anne Obermann"},
{ name = "Lion Krischer"},
Expand Down

0 comments on commit ce625a3

Please sign in to comment.