[Usecase] DesignSafe Use Cases Review

[Silvia Mazzoni]

 All,here is the easy-to-click link:
https://docs.google.com/spreadsheets/d/1mZB91I7j4UW1rkbQTEOo6QkMA7jGMYKdkDqIlcUrfho/edit?usp=sharing

Silvia


    On Monday, November 18, 2024 at 04:28:02 PM PST, Silvia Mazzoni <silviamazzoni at yahoo.com> wrote:  
 
 
NHERI-DesignSafe Use-Case Developers,

I have reviewed each Use-Case. I reviewed the documentationin terms of format and links (I have updated some links to the Jupyter notebooks).I also copied the Jupyter notebook(s) and the associated files into my localpath and ran each notebook(s). 

I have provided use-case-specific review notes in a googlesheet as well as some general notes below that apply to all. Keep in mind thatfixing the issues I found will likely reveal others, so please make sure youaddress them as well. 

I would like to have a follow-up meeting with each use caseduring the first or second week of December.

USE-CASE-SPECIFIC NOTES: https://docs.google.com/spreadsheets/d/1mZB91I7j4UW1rkbQTEOo6QkMA7jGMYKdkDqIlcUrfho/edit?usp=sharing

GENERAL NOTES:

·      Headers: Each notebook should have atitle, author names, affiliation and contact.

·      Publication Date: It is very importantthat you include publication date. This way new versions can be easily identifiedand compared to existing ones.

·      Notebook Documentation: Please make sureeach notebook is as self-contained as possible – Very few people read documentation.

·      Missing or External Files: Some notebooksare missing files or are connecting to archive data that is not available tothe public.

·      Python Libraries: Please make sure youinclude the required pip-installation commands in the first cells of yournotebook. Here is a simple example: !pip install folium

·      Tapis V3: If your notebook submits a jobto the HPC system, the code needs to be updated for Tapis V3. Profs Kumar &Arduino have developed template Notebooks in CommunityData/Jupyter-templates

·      Use-Case documentation: Wesley has createda step-by-step instructions on how to contribute/modify the documentation. I'm happy to walk through this process with you:

https://github.com/DesignSafe-CI/DS-User-Guide/tree/main/user-guide/docs/usecases#readme

 

Thank you,

Silvia Mazzoni

DesignSafe Applications Specialist

  
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.designsafe-ci.org/pipermail/usecase/attachments/20241119/b2be9554/attachment-0001.html>