Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add additional tutorials for UQTestFuns in the docs. #297

Merged
merged 12 commits into from
Aug 24, 2023
Merged

Conversation

damar-wicaksono
Copy link
Owner

  • The tutorials include how functions in UQTestFuns may be used in a sensitivity analysis or reliability analysis exercise.
  • This is part of resolving the issues raised by the reviewer in the JOSS submission.

This PR should resolve Issue #294.

damar-wicaksono and others added 11 commits July 3, 2023 17:12
- Add a GitHub action for building the draft PDF in GitHub.
- Add a list of authors
- Draft the Summary section
- Draft the Acknowledgment section
- Draft the Statement of need section
- Draft the Package overview section
- Remove unnecessary sections from the template
- Revise the Summary section.
- Revise the Statement of need section.
- Revise the opening of the Package overview section.
- Revise the Reliability analysis subsection.
- Revise the Sensitivity analysis subsection.
- Clean up BibTeX file.
- The tutorials include how functions in UQTestFuns may be used
  in a sensitivity analysis or reliability analysis exercise.
- This is part of resolving the issues raised by the reviewer
  in the JOSS submission.
@damar-wicaksono damar-wicaksono added documentation Improvements or additions to documentation JOSS All issues related to the JOSS paper submission labels Aug 23, 2023
@damar-wicaksono damar-wicaksono self-assigned this Aug 23, 2023
@codecov
Copy link

codecov bot commented Aug 23, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (999baba) 98.85% compared to head (11e1674) 98.85%.

❗ Current head 11e1674 differs from pull request most recent head e75d568. Consider uploading reports for the commit e75d568 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #297   +/-   ##
=======================================
  Coverage   98.85%   98.85%           
=======================================
  Files          56       56           
  Lines        1916     1916           
  Branches      139      139           
=======================================
  Hits         1894     1894           
  Misses         11       11           
  Partials       11       11           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- Previous getting started guides are now part of the tutorials.
- Add a reference section in "About UQ Test Functions" and
  "Tutorial: Create Built-in Test Functions".
- Fix Issue #296: the keyword `spatial_dimension` is mandatory to
  create a test function with a specified dimension.
@damar-wicaksono
Copy link
Owner Author

The PR now also includes a fix for Issue #296.

@damar-wicaksono damar-wicaksono merged commit d607ad2 into dev Aug 24, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation JOSS All issues related to the JOSS paper submission
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant