ESP tutorial

[hajdik]

Purpose

Adding a simple ESP tutorial demonstrating how to use an ESP model with pyGeo and change the design variables

Expected time until merged

1 week

Type of change

• [ ] Bugfix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (non-backwards-compatible fix or feature)
• [ ] Code style update (formatting, renaming)
• [ ] Refactoring (no functional changes, no API changes)
• [X] Documentation update
• [ ] Maintenance update
• [ ] Other (please describe)

Testing

The new example script should run in a docker image and produce a new CSM file, modified.csm.

Checklist

• [X] I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
• [ ] I have run unit and regression tests which pass locally with my changes
• [ ] I have added new tests that prove my fix is effective or that my feature works
• [ ] I have added necessary documentation

[codecov[bot]]

Codecov Report

Merging #152 (de628db) into main (56c5119) will not change coverage. The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #152   +/-   ##
=======================================
  Coverage   63.75%   63.75%           
=======================================
  Files          47       47           
  Lines       11786    11786           
=======================================
  Hits         7514     7514           
  Misses       4272     4272           

Impacted Files	Coverage Δ
pygeo/__init__.py	82.60% <100.00%> (ø)
pygeo/parameterization/DVGeoESP.py	64.88% <100.00%> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more