Ipynb benchmarking

[aqitya]

Jupyter Notebook for Benchmarking Example.

[github-actions]

Thank you for your contributions. If you haven't already, please send a signed Contributor License Agreement (CLA) to Christopher Teubert ([email protected]). CLAs can be found here: https://github.com/nasa/prog_models/tree/master/forms. Also, make sure you're familiar with the developer notes and contributing sections of our developers guide, https://nasa.github.io/progpy/dev_guide.html#notes-for-developers

[github-actions]

Thank you for opening this PR. Each PR into dev requires a code review. For the code review, look at the following:

• Reviewer (someone other than author) should look for bugs, efficiency, readability, testing, and coverage in examples (if relevant).
• Ensure that each PR adding a new feature should include a test verifying that feature.
• All errors from static analysis must be resolved.
• Review the test coverage reports (if there is a change) - will be added as comment on PR if there is a change
• Review the software benchmarking results (if there is a change) - will be added as comment on PR
• Any added dependencies are included in requirements.txt, setup.py, and dev_guide.rst (this document)
• All warnings from static analysis must be reviewed and resolved - if deemed appropriate.

[codecov-commenter]

Codecov Report

Merging #2 (5309a9b) into dev (334b190) will not change coverage.
Report is 19 commits behind head on dev.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev       #2   +/-   ##
=======================================
  Coverage   84.17%   84.17%           
=======================================
  Files          99       99           
  Lines       10106    10106           
=======================================
  Hits         8507     8507           
  Misses       1599     1599           

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[kjjarvis]

Nice start! This looks very good. Here are a few comments, and we'll also need to address the extra files (I think Chris said he'd help with this).

[kjjarvis]

Is this supposed to show up at the top? (the answer might be yes, I'm not very familiar enough with jupyter notebooks)

[aqitya]

Typically, no, but I think with how we are formatting the Jupyter Notebooks, we want that cell there.

[teubert]

I remember us talking about it at one point in the past, but I can't remember why it's here. Can you explain it for me?

[aqitya]

We mentioned how the automated notebooks had this at the top. But from what I can tell, this does not serve a purpose for us, so I'll remove this cell.

[kjjarvis]

@aqitya there are still some outstanding comments from the last review that need to be addressed. Please take a look, and let me know if you don't agree and we can brainstorm solutions together.

[teubert]

Looking good. A few suggestions

[kjjarvis]

This notebook is looking great, approved. One idea for the future - now that ProgPy is combined, we have two 'benchmarking' examples. Should we rename these files with something more specific for clarity?

[teubert]

Looks great. Good work!