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.

Sign up for GitHub

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

Fixed paths to code in docs #443

Merged
merged 3 commits into from
Aug 4, 2024
Merged

Fixed paths to code in docs #443

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11abc71
Fixed paths to tests in docs
eytanadler Aug 2, 2024
e73f81b
Fixed paths to tests in docs that use embed-code
eytanadler Aug 2, 2024
9d8c4e5
Had to switch from embed-code to literalinclude since tests no longer…
eytanadler Aug 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions openaerostruct/docs/advanced_features/multipoint_parallel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Then, let's set up the problem in the same way as the serial runscript.

Next, we need to add AS_points under a ``ParallelGroup`` instead of directly under the ``prob.model``.

.. literalinclude:: ../../tests/test_multipoint_parallel.py
.. literalinclude:: /../../tests/integration_tests/test_multipoint_parallel.py
:dedent: 8
:start-after: # [rst Setup ParallelGroup (beg)]
:end-before: # [rst Setup ParallelGroup (end)]
Expand All @@ -55,7 +55,7 @@ Among 6 functions, 4 depend only on AS_point_0, and 2 depend only on AS_point_1.
Therefore, we can form 2 pairs and perform linear solves in parallel.
We specify ``parallel_deriv_color`` to tell OpenMDAO which function's derivatives can be solved for in parallel.

.. literalinclude:: ../../tests/test_multipoint_parallel.py
.. literalinclude:: /../../tests/integration_tests/test_multipoint_parallel.py
:dedent: 8
:start-after: # [rst Parallel deriv color setup 1 (beg)]
:end-before: # [rst Parallel deriv color setup 1 (end)]
Expand All @@ -64,15 +64,15 @@ Furthermore, we will add another dummy (nonsense) constraint to explain how para
This dummy constraint (sum of the fuel burns from AS_point_0 and AS_point_1) depends on both AS points.
In this case, the linear solves of AS_point_0 and AS_point_1 will be parallelized.

.. literalinclude:: ../../tests/test_multipoint_parallel.py
.. literalinclude:: /../../tests/integration_tests/test_multipoint_parallel.py
:dedent: 8
:start-after: # [rst Parallel deriv color setup 2 (beg)]
:end-before: # [rst Parallel deriv color setup 2 (end)]

Finally, let's change the linear solver from default.
This step is not necessary and not directly relevant to parallelization, but the ``LinearBlockGS`` solver works better on a fine mesh than the default ``DirectSolver``.

.. literalinclude:: ../../tests/test_multipoint_parallel.py
.. literalinclude:: /../../tests/integration_tests/test_multipoint_parallel.py
:dedent: 8
:start-after: # [rst Change linear solver (beg)]
:end-before: # [rst Change linear solver (end)]
Expand Down
8 changes: 4 additions & 4 deletions openaerostruct/docs/user_reference/v1_v2_conversion.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ v1 Script
v2 Script
^^^^^^^^^

.. literalinclude:: /../tests/test_v1_aero_opt.py
.. literalinclude:: /../../tests/integration_tests/test_v1_aero_opt.py
:start-after: checkpoint 0
:end-before: checkpoint 1
:dedent: 8
Expand All @@ -64,7 +64,7 @@ v1 Script
v2 Script
^^^^^^^^^

.. literalinclude:: /../tests/test_v1_aero_opt.py
.. literalinclude:: /../../tests/integration_tests/test_v1_aero_opt.py
:start-after: checkpoint 2
:end-before: checkpoint 3
:dedent: 8
Expand Down Expand Up @@ -92,7 +92,7 @@ v1 Script
v2 Script
^^^^^^^^^

.. literalinclude:: /../tests/test_v1_aero_opt.py
.. literalinclude:: /../../tests/integration_tests/test_v1_aero_opt.py
:start-after: checkpoint 4
:end-before: checkpoint 5
:dedent: 8
Expand Down Expand Up @@ -143,7 +143,7 @@ v1 Script
v2 Script
^^^^^^^^^

.. literalinclude:: /../tests/test_v1_aero_opt.py
.. literalinclude:: /../../tests/integration_tests/test_v1_aero_opt.py
:start-after: checkpoint 0
:end-before: checkpoint 5
:dedent: 8