-
Notifications
You must be signed in to change notification settings - Fork 55
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
ESP tutorial #152
ESP tutorial #152
Conversation
Codecov Report
@@ Coverage Diff @@
## main #152 +/- ##
=======================================
Coverage 63.75% 63.75%
=======================================
Files 47 47
Lines 11786 11786
=======================================
Hits 7514 7514
Misses 4272 4272
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting together the tutorial! Looks good overall. I just have two minor questions.
doc/esp_airfoil.rst
Outdated
For information on how to install ESP and its dependencies for use in pyGeo, see the :ref:`installation page<install>`. | ||
|
||
The FFD approach is sometimes preferred because it is easy to set up and has a lot of freedom in how the design variables can change the geometry. | ||
Unfortunately, the FFD control points are the primary representation of the geometry, and in some cases it is preferred to have both an input geometry and an output geometry in more traditional formats, like CAD models. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"are" or "are not"? Or maybe it's just not clear to what you're trying to say here.
doc/install.rst
Outdated
------------- | ||
The simplest way to install ESP so that it works with pyGeo is to use the Docker image mentioned above, which will have pyGeo and ESP both installed. | ||
The ESP GUI can then be installed on your local machine for Mac, Windows, and Linux following the instructions in their README to view ESP models. | ||
Our currently supported version is 1.20, which can be installed from the `archive <https://acdl.mit.edu/ESP/archive/>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this link does not seem to show properly in the built doc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I made a quick commit to fix the script bug and I did not notice you had a fix for it already
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
Testing
The new example script should run in a docker image and produce a new CSM file,
modified.csm
.Checklist
flake8
andblack
to make sure the code adheres to PEP-8 and is consistently formatted