docs

pyrocko · Oct 29, 2023 · f5b22b4 · f5b22b4
1 parent 0e3b0c4
commit f5b22b4
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 16 deletions.
diff --git a/docs/components/image_function.md b/docs/components/image_function.md
@@ -4,5 +4,5 @@ For image functions this version of Lassie relies heavily on machine learning pi
 
 ## PhaseNet
 
-!!! abstract "PhaseNet Citation"
+!!! abstract "Citation PhaseNet"
     Zhu, Weiqiang, and Gregory C. Beroza. "PhaseNet: A Deep-Neural-Network-Based Seismic Arrival Time Picking Method." arXiv preprint arXiv:1803.03211 (2018).
diff --git a/docs/components/ray_tracer.md b/docs/components/ray_tracer.md
@@ -4,15 +4,17 @@ The calculation of seismic travel times is a cornerstone for the migration and s
 
 ## Constant Velocity
 
-The constant velocity models is trivial and follows
+The constant velocity models is trivial and follows:
 
 $$
 t_{P} = \frac{d}{v_P}
 $$
 
+This module is used for simple use cases and cross-referencing testing.
+
 ## 1D Layered Model
 
-The 1D ray tracer is based on [Pyrocko Cake](https://pyrocko.org/docs/current/apps/cake/manual.html#command-line-examples).
+Calculation of travel times in 1D layered media is based on the [Pyrocko Cake](https://pyrocko.org/docs/current/apps/cake/manual.html#command-line-examples) ray tracer.
 
 ![Pyrocko Cake Ray Tracer](https://pyrocko.org/docs/current/_images/cake_plot_example_2.png)
 *Pyrocko Cake 1D ray tracer for travel time calculation in 1D layered media*
@@ -22,8 +24,10 @@ The 1D ray tracer is based on [Pyrocko Cake](https://pyrocko.org/docs/current/ap
 We implement the fast marching method for calculating first arrivals of waves in 3D volumes.
 
 * [x] Import [NonLinLoc](http://alomax.free.fr/nlloc/) 3D velocity model
-* [x] 1D Layered 🥼
-* [x] Constant velocity 🥼
+* [x] 1D layered model 🥞
+* [x] Constant velocity, mainly for testing purposes 🥼
+
+### Visualizing 3D Models
 
 For quality check, all 3D velocity models are exported to `vtk/` folder as `.vti` files. Use [ParaView](https://www.paraview.org/) to inspect and explore the velocity models.
 

diff --git a/docs/components/seismic_data.md b/docs/components/seismic_data.md
@@ -4,8 +4,12 @@
 
 The seismic can be delivered in MiniSeed or any other format compatible with Pyrocko.
 
+Organize your data in an [SDS structure](https://www.seiscomp.de/doc/base/concepts/waveformarchives.html) or just a blob if MiniSeed.
+
 ## Meta Data
 
+Meta data is required primarily for station locations and codes.
+
 Supported data formats are:
 
 * [x] [StationXML](https://www.fdsn.org/xml/station/)

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -4,19 +4,13 @@
 
 The installation is straight-forward:
 
-```sh
-pip install lassie-v2
-```
-
-or install from GitHub
-
 ```sh title="From GitHub"
 pip install git+https://github.com/pyrocko/lassie-v2
 ```
 
-## Initializing a new Project
+## Initializing a New Project
 
-Once installed you can run the lassie executeable
+Once installed you can run the lassie executeable to initialize a new project.
 
 ```sh title="Initialize new Project"
 lassie init my-project

diff --git a/docs/index.md b/docs/index.md
@@ -4,14 +4,15 @@ Lassie is an earthquake detection and localisation framework. It combines modern
 
 The detector is leveraging [Pyrocko](https://pyrocko.org) and [SeisBench](https://github.com/seisbench/seisbench), it is highly-performant and can scan massive data sets efficiently.
 
+!!! note "Citation"
+    TDB
+
 ![Reykjanes detections](images/reykjanes-demo.webp)
 
 *Seismic swarm activity at Iceland, Reykjanes Peninsula during a 2020 unrest. 15,000+ earthquakes detected, outlining a dike intrusion, preceeding the 2021 Fagradasfjall eruption. Visualized in [Pyrocko Sparrow](https://pyrocko.org).*
 
 ## Features
 
-!!! note "Citation"
-    TDB
 
 * [x] Earthquake phase detection using machine-learning pickers from [SeisBench](https://github.com/seisbench/seisbench)
 * [x] Octree localisation approach for efficient and accurate search

diff --git a/docs/theme/announce.html b/docs/theme/announce.html
@@ -0,0 +1 @@
+<b>Lassie is in Beta</b> 🧫 <span style="padding-left: 1em;">Please handle with care</span>
diff --git a/docs/theme/main.html b/docs/theme/main.html
@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+<!-- start announce block -->
+{% block announce %}
+  {% include 'announce.html' ignore missing %}
+{% endblock %}
+<!-- end announce block -->
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,10 +1,12 @@
-site_name: Lassie
+site_name: Lassie - Earthquake Detector
 site_description: The friendly earthquake detector
 repo_url: https://github.com/pyrocko/lassie-v2
 repo_name: pyrocko/lassie-v2
+edit_uri: edit/main/docs/
 
 theme:
   name: material
+  custom_dir: docs/theme
   palette:
   - scheme: default
     primary: blue grey
@@ -23,6 +25,7 @@ theme:
   features:
     - navigation.tabs
     - search.suggest
+    - announce.dismiss
     - content.code.copy
 
 markdown_extensions:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<b>Lassie is in Beta</b> 🧫 <span style="padding-left: 1em;">Please handle with care</span>