-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #294 from Severson-Group/feature/rearrange_user_guide
Rearrange User Guide Section
- Loading branch information
Showing
13 changed files
with
1,678 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Codebase | ||
########################################## | ||
|
||
In order to begin a design optimization using ``MachEval``, the end user will need to configure or write the implementation of certain classes. | ||
|
||
Designer | ||
* ``Architect``: while ``eMach`` does contain example ``Architect`` classes, oftentimes custom code will be required to match the selected free variables. | ||
|
||
* ``SettingsHandler``: Similar to the architect, this object will likely need to be adjusted to match the optimization requirements. | ||
|
||
Evaluator | ||
* ``EvaluationStep`` s: Custom code for simple evaluations can be written directly as ``EvaluationStep`` objects. For more complicated code, the ``AnalysisStep`` object should be used with the corresponding Analyzers. | ||
|
||
* ``ProblemDefinition``: For each ``AnalysisStep``, the user will be required to write a ``ProblemDefinition`` to convert the input state to the required Problem object. | ||
|
||
* ``PostAnalyzer``: A corresponding ``PostAnalyzer`` is required for each ``Analyzer`` used. | ||
|
||
DesignSpace | ||
* The user must implement the required methods as specified. This is where the objective functions are defined for the optimization. | ||
|
||
Once the user has specified all of the required objects, they can be injected into the ``DesignProblem`` and utilized by the ``pygmo`` optimization code. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.