use cases: broke down into separate files and fixed some headers that…

… had not been updated. (#63) We do need to check the links from the nav because they want to connect to an anchor, not a file, which is how they are set up now. Co-authored-by: Wesley B <[email protected]>
DesignSafe-CI · Aug 12, 2024 · 7529183 · 7529183
1 parent ab26f1f
commit 7529183
Show file tree

Hide file tree

Showing 12 changed files with 95 additions and 46 deletions.
diff --git a/user-guide/docs/usecases/brandenberg-api/usecase.md b/user-guide/docs/usecases/brandenberg-api/usecase.md
@@ -1,10 +1,19 @@
+/// html | header
+
 ## Application Programming Interfaces
 
-__Scott J. Brandenberg and Meera Kota, UCLA__
+Integration of QGIS and Python Scripts to Model and Visualize Storm Impacts on Distributed Infrastructure Systems
+
+/// 
+
+**Scott J. Brandenberg - UCLA** <br>
+**Meera Kota - UCLA** <br>
+<br>
+_Keywords: API, Application Programming Interface, Jupyter, Python, requests, US Census, USGS, NASA, NOAA_
 
 This use case provides some background information on application programming interfaces (API's) followed by examples that utilize the Python requests package to pull data from API's maintained by NASA, the US Census Bureau, the US Geological Survey, and the National Oceanic and Atmospheric Administration. 
 
-Key Words: API, Application Programming Interface, Jupyter, Python, requests, US Census, USGS, NASA, NOAA
+
 
 ### Resources
 

diff --git a/user-guide/docs/usecases/brandenberg-ngl/usecase.md b/user-guide/docs/usecases/brandenberg-ngl/usecase.md
@@ -1,6 +1,10 @@
+/// html | header
+
 ## NGL Database
 
-**Next Generation Liquefaction (NGL) Database Jupyter Notebooks**   
+Next Generation Liquefaction (NGL) Database Jupyter Notebooks
+
+/// 
 
 **Brandenberg, S.J. - UCLA**<br/>
 **Ulmer, K.J. - Southwest Research Institute**<br/>

diff --git a/user-guide/docs/usecases/haan/usecase-2.md b/user-guide/docs/usecases/haan/usecase-2.md
@@ -1,9 +1,15 @@
-<!-- # Grouping and Tagging Image Files -->
+/// html | header
+
 ## Taggit User Guide: Grouping and Tagging Image Files
 
-**Using Taggit to categorize image files with groups and tags**  
-**Fred Haan – Calvin University**
-**Key Words: Taggit, HazMapper, image tagging, image grouping, image labeling**
+Using Taggit to categorize image files with groups and tags
+/// 
+
+
+**Fred Haan – Calvin University **
+
+_Keywords: Taggit, HazMapper, image tagging, image grouping, image labeling_
+
 
 ### Resources 
 

diff --git a/user-guide/docs/usecases/haan/usecase-3.md b/user-guide/docs/usecases/haan/usecase-3.md
@@ -1,10 +1,15 @@
-<!--# Multi-Data Set Image Analysis in Taggit -->
+/// html | header
+
 ## Multi-Data Set Image Analysis in Taggit
 
+Combining Taggit analysis results with external data sets to do further analysis on image files
+/// 
+
+
+**Fred Haan – Calvin University **
+
+_Keywords: Taggit, QGIS, NWS Damage Assessment Toolkit (DAT), image tagging_
 
-**Combining Taggit analysis results with external data sets to do further analysis on image files**
-**Fred Haan – Calvin University**  
-**Key Words: Taggit, QGIS, NWS Damage Assessment Toolkit (DAT), image tagging**  
 
 ### Resources
 

diff --git a/user-guide/docs/usecases/haan/usecase.md b/user-guide/docs/usecases/haan/usecase.md
@@ -1,6 +1,15 @@
+/// html | header
+
 ## Taggit User Guide: Basic Image Browsing and Mapping
-**Using HazMapper and Taggit to browse thumbnails of large numbers of images and map their locations**   
-**Fred Haan – Calvin University Key Words: Taggit, HazMapper, image browsing**
+
+Using HazMapper and Taggit to browse thumbnails of large numbers of images and map their locations
+
+/// 
+
+
+**Fred Haan – Calvin University **
+
+_Keywords: Taggit, HazMapper, image browsing_
 
 ### Resources 
 

diff --git a/user-guide/docs/usecases/kumar/usecase.md b/user-guide/docs/usecases/kumar/usecase.md
@@ -1,5 +1,11 @@
+/// html | header
+
 ## MPM Landslide
 
+Material Point Method for Landslide Modeling
+
+///
+
 **Material Point Method for Landslide Modeling**   
 **Krishna Kumar - University of Texas at Austin**  
 

diff --git a/user-guide/docs/usecases/mosqueda/erler-mosqueda.md b/user-guide/docs/usecases/mosqueda/erler-mosqueda.md
@@ -9,7 +9,7 @@ Leveraging Machine Learning for Identification of Shake Table Data and Post Proc
 **Kayla Erler – University of California San Diego** <br>
 **Gilberto Mosqueda – University of California San Diego**
 
-*Key Words: machine learning, shake table, friction, data modeling*
+_Keywords: machine learning, shake table, friction, data modeling_
 
 ### Resources
 

diff --git a/user-guide/docs/usecases/mosqueda/usecase.md b/user-guide/docs/usecases/mosqueda/usecase.md
@@ -9,7 +9,7 @@ Integrated Workflow of Experiments using Jupyter Notebooks: *From Experimental D
 **Enrique Simbort - University of California, San Diego** <br>
 **Gilberto Mosqueda - University of California, San Diego**  
 
-*Key Words: Jupyter, Interactive Data Analysis, UCSD NHERI Facility*
+_Keywords: Jupyter, Interactive Data Analysis, UCSD NHERI Facility_
 
 
 Jupyter Notebooks can provide fully integrated workflows of experiments from documentation of experimental design through analysis and publishing of data using the DesignSafe cyberinfrastructure. A series of Notebooks are being developed to demonstrate their use in the experimental workflow including notebooks showing how to view and analyzed past published data and data from testing of a reconfigurable, modular test bed building planned to be tested on the NHERI@UC San Diego Experimental Facility. The Python-based code is implemented in a modular fashion so that components can be used as desired in other experiments and are transferable to other experimental facilities. In the examples provided, the Notebook can be used to evaluate shake table performance as well as dynamic properties of the structure. A key functionality is to increase the integration and collaboration between researchers at local or remote sites to view and analyze the experimental data during and after testing including after the data is published. As Notebooks are developed to view experimental data by the research team, they can also be published with the data allowing other researchers to quickly view the data for promoting data reuse. Examples are providing for viewing data from past shake table experiments including NEES and more current NHERI data repositories.  

diff --git a/user-guide/docs/usecases/pinelli/2usecase.md b/user-guide/docs/usecases/pinelli/2usecase.md
@@ -10,7 +10,7 @@ Geospatial Hurricane Disaster Reconnaissance Data Integration and Visualization
 **Sziklay, E. – Florida Tech**  <br> 
 **Ajaz, M.A. – Florida Tech**   
 
-*Key Words: Hurricane, Disaster Reconnaissance, StEER Network, NSI Database, wind field, JupyterLab, API, JSON, KeplerGI*
+_Keywords: Hurricane, Disaster Reconnaissance, StEER Network, NSI Database, wind field, JupyterLab, API, JSON, KeplerGI_
 
 ### Resources 
 

diff --git a/user-guide/docs/usecases/rathje/usecase.md b/user-guide/docs/usecases/rathje/usecase.md
@@ -9,7 +9,7 @@ Integration of OpenSees-STKO-Jupyter to Simulate Seismic Response of Soil-Struct
 **Yu-Wei Hwang - University of Texas at Austin**  <br>
 **Ellen Rathje - University of Texas at Austin**  
 
-*Key Words: OpenSees, STKO, Jupyter, HPC*
+_Keywords: OpenSees, STKO, Jupyter, HPC_
 
 
 This use case example shows how to run an OpenSeesMP analysis on the high-performance computing (HPC) resources at [DesignSafe](https://www.designsafe-ci.org){:target="_blank"}  (DS) using the [STKO](https://asdeasoft.net/?product-stko){:target="_blank"}  graphical user interface and a Jupyter notebook. The example also post-processes the output results using python scripts, which allows the entire analysis workflow to be executed within DesignSafe without any download of output.

diff --git a/user-guide/docs/usecases/vantassel_and_zhang/usecase.md b/user-guide/docs/usecases/vantassel_and_zhang/usecase.md
@@ -1,6 +1,11 @@
+/// html | header
+
 ## ML and AI
 
-**An Example-Based Introduction to Common Machine Learning Approaches**   
+An Example-Based Introduction to Common Machine Learning Approaches
+
+///
+
 **Joseph P. Vantassel and Wenyang Zhang, Texas Advanced Computing Center - The University of Texas at Austin**  
 
 With the increasing acquisition and sharing of data in the natural hazards community, solutions from 

diff --git a/user-guide/mkdocs.yml b/user-guide/mkdocs.yml
@@ -84,40 +84,45 @@ nav:
 #        - 4. Jupyter & HPC: tools/simulation/opensees/openseesRunJupyterHPC.md
 #        - 5. TACC: tools/simulation/opensees/openseesRunTACC.md
 
+  # - Use Cases Flat:
+  #   - Overview: usecases/overview.md
+  #   - Data Analytics: usecases/dataanalyticsusecases.md
+  #   - GeoHazard: usecases/geohazardusecases.md
+  #   - Seismic: usecases/seismicusecases.md
+  #   - Wind and Storm Surge: usecases/windstormsurgeusecases.md
+
+
   - Use Cases:
     - Overview: usecases/overview.md
-    - Data Analytics: usecases/dataanalyticsusecases.md
-    - GeoHazard: usecases/geohazardusecases.md
-    - Seismic: usecases/seismicusecases.md
-    - Wind and Storm Surge: usecases/windstormsurgeusecases.md
+    - Data Analytics: 
+      - Basic Image Browsing and Mapping: usecases/haan/usecase.md
+      - Grouping and Tagging Image Files: usecases/haan/usecase-2.md
+      - Multi-Data Set Image Analysis in Taggit: usecases/haan/usecase-3.md
+      - ML and AI: usecases/vantassel_and_zhang/usecase.md
+      - Application Programming Interfaces: usecases/brandenberg-api/usecase.md
+      - Visualization of spatially distributed data: usecases/padgett/usecase_JN_viz.md
+    - GeoHazard:
+      - NGL Database: usecases/brandenberg-ngl/usecase.md
+      - MPM Landslide: usecases/kumar/usecase.md
+    - Seismic: 
+      - Seismic Response of Concrete Walls: usecases/lowes/usecase.md
+      - Soil Structure Interaction: usecases/rathje/usecase.md
+      - Experimental Shake Table Testing: usecases/mosqueda/usecase.md
+      - Shake Table Data Analysis Using ML: usecases/mosqueda/erler-mosqueda.md
+      - OpenSees Model Calibration: usecases/arduino/usecase.md
+    - Wind and Storm Surge: 
+      - Field Sensing Wind Events: usecases/pinelli/usecase.md
+      - Hurricane Data Integration Visualization: usecases/pinelli/2usecase.md
+      - ADCIRC Datasets: usecases/dawson/usecase2.md
+      - Large-Scale Storm Surge: usecases/dawson/usecase.md
+      - CFD Analysis of Winds on Structures: usecases/kareem/usecase.md
+      - CFD Analysis of Winds on Low-Rise Building: usecases/kareem/usecase2.md
+      - Tamkang Database: usecases/kareem/usecase3.md
+      - Visualizing Surge for Regional Risks: usecases/padgett/usecase.md
 
   - Advanced:
     - API Developer's Guide: https://tapis-cli.readthedocs.io/en/latest/
     - Cybersecurity Policy: tools/advanced/cybersecurity.md
     - DesignSafe FAQ: tools/advanced/dsfaq.md
     - HPC Allocations Policy: tools/advanced/hpcallocations.md
 
-
-# Old navigation for unflattened use cases
-#    - Data Analytics: usecases/dataanalytics-usecases.md
-#      - Basic Image Browsing and Mapping: usecases/haan/usecase.md
-#      - Grouping and Tagging Image Files: usecases/haan/usecase-2.md
-#      - Multi-Data Set Image Analysis in Taggit: usecases/haan/usecase-3.md
-#      - ML and AI: usecases/vantassel_and_zhang/usecase.md
-#      - API: usecases/brandenberg-api/usecase.md
-#    - GeoHazard: usecases/geohazard-usecases.md
-#      - NGL Database: usecases/brandenberg-ngl/usecase.md
-#      - MPM Landslide: usecases/kumar/usecase.md
-#    - Wind and Storm Surge: usecases/windstormsurge-usecases.md
-#      - Field Sensing Wind Events: usecases/pinelli/usecase.md
-#      - Hurricane Data Integration Visualization: usecases/pinelli/2usecase.md
-#      - ADCIRC Datasets: usecases/dawson/usecase2.md
-#      - Large-Scale Storm Surge: usecases/dawson/usecase.md
-#      - Visualizing Surge for Regional Risks: usecases/padgett/usecase.md
-#      - CFD Analysis of Winds on Structures: usecases/kareem/usecase.md
-#    - Seismic: usecases/seismic-usecases.md
-#      - OpenSees Model Calibration: usecases/arduino/usecase.md
-#      - Seismic Response of Concrete Walls: usecases/lowes/usecase.md
-#      - Soil Structure Interaction: usecases/rathje/usecase.md
-#      - Experimental Shake Table Testing: usecases/mosqueda/usecase.md
-#      - Shake Table Data Analysis Using ML: usecases/mosqueda/erler-mosqueda.md