From ce625a3d4496ea8e8bcdb195ad107b557c7e5f93 Mon Sep 17 00:00:00 2001 From: mrosskopf Date: Thu, 10 Oct 2024 09:48:10 +0200 Subject: [PATCH] Updated documentation --- docs/data_requirements.md | 2 +- docs/development.md | 5 +++++ docs/installation.md | 2 +- pyproject.toml | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/data_requirements.md b/docs/data_requirements.md index 1efc162..1126673 100644 --- a/docs/data_requirements.md +++ b/docs/data_requirements.md @@ -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. diff --git a/docs/development.md b/docs/development.md index a99c292..c021c80 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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. diff --git a/docs/installation.md b/docs/installation.md index 76b0ae3..fad901e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 diff --git a/pyproject.toml b/pyproject.toml index ae49ff8..e43cefb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,7 +9,7 @@ authors = [ { name = "ETHZ" }, { name = "Joseph Doetsch"}, { name = "Linus Villiger", email = "linus.villiger@sed.ethz.ch" }, - { 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"},