Skip to content
This repository was archived by the owner on Feb 4, 2026. It is now read-only.

Commit c8be696

Browse files
sjbrandenbergkks32
andauthored
Updated NGL documentation (#52)
* Add files via upload * Delete docs/brandenberg/apiusecases/output_9_1.png * Delete docs/brandenberg/apiusecases/output_11_1.png * Delete docs/brandenberg/apiusecases/output_7_1.png * Delete docs/brandenberg/apiusecases/output_8_0.png * Update usecase.md * Update usecase.md * Create license.md * Update usecase.md Adjusting heading levels for use cases so they fall under "Implementation" * Update usecase.md * Update usecase.md * Update usecase.md * Update usecase.md * Update usecase.md * Update usecase.md * Update usecase.md * Update usecase.md Updating hyperlinks and adding table with links to notebooks * Update usecase.md * Update usecase.md * Update usecase.md * Update usecase.md * Update usecase.md * Update usecase.md --------- Co-authored-by: Krishna Kumar <3963513+kks32@users.noreply.github.com>
1 parent 7bc4001 commit c8be696

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

docs/brandenberg/usecase.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ The example makes use of the following DesignSafe resources:
4545
</tr>
4646
<tr>
4747
<td>
48-
Direct Simple Shear Viewer
48+
Laboratory Test Viewer
4949
</td>
5050
<td>
51-
<a href="https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/NGL/DSS_Viewer.ipynb" target="_blank"><img src="https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg"></a>
51+
<a href="https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/NGL/LabTestViewer.ipynb" target="_blank"><img src="https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg"></a>
5252
</td>
5353
</tr>
5454
</table>
@@ -109,11 +109,18 @@ This documentation first demonstrates how to install the database connection scr
109109
## Installing Database Connection Script
110110

111111
Connecting to a relational database requires credentials, like username, password, database name, and hostname.
112-
Rather than requiring users to know these credentials and create their own database connections, we have created a Python package that allows users to
113-
query the database. This code installs the package containing the database connection script for NGL:
112+
Rather than requiring users to know these credentials and create their own database connections, we have created a Python package that allows users to query the database. This code installs the package containing the database connection script for NGL:
114113

115114
```python
116-
!pip install git+https://github.com/sjbrandenberg/designsafe_db
115+
!pip install dsdatabase
116+
```
117+
118+
The connection script can then be invoked by creating an object from the DSDatabase class corresponding to the "ngl" connection, and submitting a query using the ngl.read_sql(sql) function.
119+
120+
```python
121+
from dsdatabase.db import DSDatabase
122+
ngl = DSDatabase("ngl")
123+
df = ngl.read_sql(sql)
117124
```
118125

119126
## Example Queries

0 commit comments

Comments
 (0)