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

Docs update: solvers and parallel multipoint analysis #405

Merged
merged 40 commits into from
May 17, 2023
Merged

Conversation

kanekosh
Copy link
Contributor

@kanekosh kanekosh commented Apr 6, 2023

Purpose

  • Added a documentation page on the solver to cover the default aerostructural solver, solver recommendations, and a way to change the solvers in runscript
  • Changed the linear solver in some examples that uses a large mesh (LinearBlockGS is much faster than the default DirectSolver for these cases)
  • Added a documentation page on the parallel multipoint analysis using MPI and ParallelGroup
  • Added an MPI multipoint test
  • Switched to testflo from pytest to run the MPI test

NOTE: the MPI test does not work with the oldest python/package versions, and I could not fix that. For now, we only run the MPI test on the latest and not on the oldest. This is why the yml looks a little messy.

Expected time until merged

A 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)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

I added a new regression test test_multipoint_parallel.

Checklist

  • I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • 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
Copy link

codecov bot commented Apr 6, 2023

Codecov Report

Merging #405 (32a435e) into main (966f8dc) will increase coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #405      +/-   ##
==========================================
+ Coverage   94.47%   94.52%   +0.04%     
==========================================
  Files         103      103              
  Lines        6412     6412              
==========================================
+ Hits         6058     6061       +3     
+ Misses        354      351       -3     

see 2 files with indirect coverage changes

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

@kanekosh kanekosh changed the title Documentation: solvers and parallel multipoint analysis Docs update: solvers and parallel multipoint analysis Apr 12, 2023
@kanekosh kanekosh marked this pull request as ready for review April 12, 2023 14:55
@kanekosh kanekosh requested a review from a team as a code owner April 12, 2023 14:55
Copy link
Collaborator

@eytanadler eytanadler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great Shugo, thanks so much for adding detailed docs! I learned a lot just by reading these. It looks like a lot of comments, but most are just small grammatical changes.

A separate problem though, do you have any idea what's going on with the build? Something related to the OpenMDAO install seems to be failing. It's definitely not your fault because the same error showed up in the biweekly build that ran recently.

.github/workflows/oas.yml Show resolved Hide resolved
openaerostruct/docs/advanced_features/solver.rst Outdated Show resolved Hide resolved
openaerostruct/docs/advanced_features/solver.rst Outdated Show resolved Hide resolved
openaerostruct/docs/advanced_features/solver.rst Outdated Show resolved Hide resolved
openaerostruct/docs/advanced_features/solver.rst Outdated Show resolved Hide resolved
openaerostruct/docs/advanced_features/solver.rst Outdated Show resolved Hide resolved
@kanekosh
Copy link
Contributor Author

kanekosh commented May 8, 2023

@eytanadler Thanks for catching a lot of types and errors!
No idea about the OM installation error, I'll look into the details this week

@eytanadler
Copy link
Collaborator

@eytanadler Thanks for catching a lot of types and errors! No idea about the OM installation error, I'll look into the details this week

Sounds good! I'm also not sure what's going on with the RTD build, especially since it worked initially for this PR and you haven't changed anything since.

@kanekosh kanekosh mentioned this pull request May 8, 2023
13 tasks
@eytanadler
Copy link
Collaborator

If you don't mind, could you also bump the codecov action to v3 in the github actions file in this PR? Seems like there have been recurring problems recently (but not always), and updating the action might help.

@kanekosh kanekosh requested a review from eytanadler May 17, 2023 13:36
@eytanadler eytanadler merged commit 9f592ae into main May 17, 2023
9 checks passed
@kanekosh kanekosh deleted the solver_update branch May 17, 2023 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants