OpenSees documentation

Author: kks32

README.md

@@ -1,13 +1,14 @@
 # DesignSafe API (dapi)
 
-![dapi](https://raw.githubusercontent.com/DesignSafe-CI/dapi/main/dapi.png)
-
 [![build and test](https://github.com/DesignSafe-CI/dapi/actions/workflows/build-test.yml/badge.svg)](https://github.com/DesignSafe-CI/dapi/actions/workflows/build-test.yml)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
 [![Docs](https://img.shields.io/badge/view-docs-8A2BE2?color=8A2BE2)](https://designsafe-ci.github.io/dapi/dapi/index.html)
 
 `dapi` is a library that simplifies the process of submitting, running, and monitoring [TAPIS v3](https://tapis.readthedocs.io/en/latest/) jobs on [DesignSafe](https://designsafe-ci.org) via [Jupyter Notebooks](https://jupyter.designsafe-ci.org).
 
+<img src="https://raw.githubusercontent.com/DesignSafe-CI/dapi/main/dapi.png" alt="dapi" width="300">
+
+
 ## Features
 
 ### Jobs
@@ -153,5 +154,5 @@ This will start a local server at `http://127.0.0.1:8000/dapi/` where you can vi
 To generate API docs:
 
 ```
-pdoc --html --output-dir docs dapi --force
+pdoc --html --output-dir api-docs dapi --force
 ```

docs/examples.md

@@ -0,0 +1,87 @@
+# Examples
+
+Welcome to the DAPI examples collection! These comprehensive tutorials demonstrate how to use DAPI for various computational workflows on DesignSafe. Each example includes complete, runnable code that you can try directly in DesignSafe's Jupyter environment.
+
+
+## 🚀 Ready to Start?
+
+Choose an example above and click "Try on DesignSafe" to begin your computational research journey!
+
+Each example is self-contained and includes:
+- ✅ Complete, runnable code
+- ✅ Step-by-step explanations
+- ✅ Real-world applications
+- ✅ Troubleshooting guides
+- ✅ Performance optimization tips
+
+*Happy computing!* 🎉
+
+### 📱 Application Management
+Discover and manage applications available on DesignSafe.
+
+[![Try on DesignSafe](https://raw.githubusercontent.com/DesignSafe-CI/dapi/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/dapi/apps.ipynb)
+
+**What you'll learn:**
+- Searching for available applications
+- Getting detailed app information
+- Understanding app parameters and requirements
+
+---
+
+### 🌊 Material Point Method (MPM) Jobs
+Submit and monitor MPM simulations for large deformation problems.
+
+[![Try on DesignSafe](https://raw.githubusercontent.com/DesignSafe-CI/dapi/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/dapi/mpm/mpm-minimal.ipynb)
+
+**What you'll learn:**
+- Setting up MPM job parameters
+- Submitting jobs with resource optimization
+- Monitoring job progress and status
+- Downloading and analyzing results
+
+**[📖 View Full Documentation →](examples/mpm.md)**
+
+---
+
+### 🏗️ OpenSees Structural Analysis
+Perform earthquake engineering simulations with OpenSees.
+
+[![Try on DesignSafe](https://raw.githubusercontent.com/DesignSafe-CI/dapi/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/dapi/opensees/opensees-mp/OpenSeesMP-dapi.ipynb)
+
+**What you'll learn:**
+- Configuring OpenSees Multi-Free Field Analysis
+- Custom archive management for organized results
+- Advanced postprocessing with response spectra
+- Parametric studies across soil profiles
+
+**[📖 View Full Documentation →](examples/opensees.md)**
+
+---
+
+### 📊 Database Queries
+Access and analyze research data from DesignSafe databases.
+
+[![Try on DesignSafe](https://raw.githubusercontent.com/DesignSafe-CI/dapi/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/dapi/db.ipynb)
+
+**What you'll learn:**
+- Connecting to research databases
+- Writing efficient SQL queries
+- Data visualization and analysis
+- Working with geotechnical datasets
+
+**[📖 View Full Documentation →](examples/database.md)**
+
+---
+
+## 🎯 Getting Started
+
+### Prerequisites
+- DesignSafe account (free registration at [designsafe-ci.org](https://designsafe-ci.org))
+- Basic Python knowledge
+- Familiarity with Jupyter notebooks
+
+### Quick Start
+1. **Click any "Try on DesignSafe" button** above
+2. **Log in** to your DesignSafe account
+3. **Run the notebook** cell by cell
+4. **Modify parameters** to explore different scenarios

docs/examples/mpm.md

@@ -2,7 +2,7 @@
 
 This comprehensive example demonstrates how to submit and monitor a Material Point Method (MPM) job using dapi. MPM is a particle-based method for simulating large deformation problems in geomechanics and fluid mechanics.
 
-[![Try on DesignSafe](https://raw.githubusercontent.com/DesignSafe-CI/dapi/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/Training/dapi/examples/mpm.ipynb)
+[![Try on DesignSafe](https://raw.githubusercontent.com/DesignSafe-CI/dapi/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/dapi/mpm/mpm-minimal.ipynb)
 
 ## 🎯 Overview