Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jun 23, 2024
1 parent bbe05fe commit a36a54c
Show file tree
Hide file tree
Showing 189 changed files with 33,927 additions and 19,882 deletions.
Binary file added _images/cross-sections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/cross-sections1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions _sources/examples/anl_blade_cs_rcas/anl_blade_cs_rcas.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. _example-anl_blade_cs_rcas:

.. include:: /../../examples/anl_blade_cs_rcas/README.rst
40 changes: 27 additions & 13 deletions _sources/examples/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Analysis
.. grid-item-card::
:link: example-anl_distr_cs_box
:link-type: ref
:img-bottom: /../../examples/anl_distr_cs_box/cross-sections.png

:ref:`example-anl_distr_cs_box`

Expand All @@ -36,6 +37,13 @@ Analysis

:ref:`example-anl_box_beam_eigen`

.. grid-item-card::
:link: example-anl_blade_cs_rcas
:link-type: ref
:img-bottom: /../../examples/anl_blade_cs_rcas/cross-sections.png

:ref:`example-anl_blade_cs_rcas`


Parametric study
----------------
Expand Down Expand Up @@ -70,22 +78,28 @@ Parametric study
.. Optimization
.. ------------
Optimization
------------

.. grid:: 1 1 2 2
:gutter: 4

.. grid-item-card::
:link: example-opt_cs_box_lam
:link-type: ref

.. .. grid:: 1 1 2 2
.. :gutter: 4
:ref:`example-opt_cs_box_lam`

.. .. grid-item-card::
.. :link: example-opt_distr_cs_airfoil_stf
.. :link-type: ref
.. :img-bottom: opt_distr_cs_airfoil_stf/ivabs_ex_uh60_sopt_stf_result_prop_compare.png
.. .. grid-item-card::
.. :link: example-opt_distr_cs_airfoil_stf
.. :link-type: ref
.. :img-bottom: opt_distr_cs_airfoil_stf/ivabs_ex_uh60_sopt_stf_result_prop_compare.png
.. :ref:`example-opt_distr_cs_airfoil_stf`
.. :ref:`example-opt_distr_cs_airfoil_stf`
.. .. grid-item-card::
.. :link: example-opt_distr_cs_airfoil_stf_mobj
.. :link-type: ref
.. .. grid-item-card::
.. :link: example-opt_distr_cs_airfoil_stf_mobj
.. :link-type: ref
.. :ref:`example-opt_distr_cs_airfoil_stf_mobj`
.. :ref:`example-opt_distr_cs_airfoil_stf_mobj`
4 changes: 4 additions & 0 deletions _sources/examples/opt_cs_box_lam/opt_cs_box_lam.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. _example-opt_cs_box_lam:

.. include:: /../../examples/opt_cs_box_lam/README.rst

66 changes: 64 additions & 2 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,17 +1,79 @@

.. only:: msg

.. include:: main_msg.rst
.. .. include:: main_msg.rst
Welcome to msg-design's documentation!
======================================
.. toctree::
:maxdepth: 1
:caption: Guide
guide/intro_yaml
guide/input_analysis
guide/input_study
guide/custom_script
.. toctree::
:maxdepth: 1
:caption: Examples
examples/example_quickstart_param_study
examples/example_uh60_mopt_stf
examples/example_uh60_sopt_stf
.. toctree::
:maxdepth: 1
:caption: Reference manual
ref/keyword/index
ref/beam_properties
.. only:: ivabs

.. include:: main_ivabs.rst









.. only:: dev

.. include:: main_dev.rst
.. .. include:: main_dev.rst
Welcome to msg-design's documentation!
======================================
.. toctree::
:maxdepth: 2
dev/workflow
dev/data_transfer
dev/python/index
.. toctree::
:maxdepth: 2
:caption: Reference
ref/vabs/index
ref/swiftcomp/index
.. Indices and tables
Expand Down
25 changes: 4 additions & 21 deletions _sources/ref/keyword/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,9 @@ Keywords

.. toctree::
:maxdepth: 1
:glob:

kw-*


analysis
builder
data
data_form
design
distribution
function
kind
location
main_file
model
name
parameter
sg_assign
sg
step
steps
structure
study
tool
type

81 changes: 81 additions & 0 deletions _sources/ref/keyword/kw-analysis.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
.. _kw-analysis:



analysis
========================

As the root keyword
--------------------


Define analysis process.

.. code-block:: yaml
analysis:
steps:
- step: "step 1"
...
- step: "step 2"
...
Specification
^^^^^^^^^^^^^^

:Arguments: None
:Default: None


Child keywords
^^^^^^^^^^^^^^^

.. list-table::
:header-rows: 1

* - Keyword
- Requirements
- Description
* - :ref:`kw-steps`
- Required
- Specification of analysis steps





As the child keyword of analysis step
---------------------------------------

Specify the |structure genetic| analysis type.

.. code-block:: yaml
analysis:
steps:
- step: "..."
type: "cs"
analysis: "..."
Specification
^^^^^^^^^^^^^^

:Parent keyword: :ref:`kw-steps`
:Arguments: Choose one from h\|fi

* ``h``: Homogenization.
* ``fi``: Initial failure index and strength ratio analysis.





.. literalinclude:: /_static/main_input_ref.yml
:caption: Example
:language: yaml
:start-after: [analysis]
:end-before: [analysis_end]
:linenos:

25 changes: 25 additions & 0 deletions _sources/ref/keyword/kw-args.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.. _kw-args:

args
=======

.. Use under::
.. analysis:
.. steps:
.. - step: "..."
.. type: "script"
.. args:
.. - arg1
.. - arg2
.. - ...
.. Extra positional arguments passed to the custom Python function.
.. * **Optional**
.. * **Type**: List
.. Related pages
.. * :ref:`section-guide_analysis_script`
22 changes: 22 additions & 0 deletions _sources/ref/keyword/kw-base_file.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _kw-base_file:

base_file
==========================

File name of the |structure genetic| base design, such as a PreVABS template.

.. code-block:: yaml
cs:
- name: "my_cs"
design:
base_file: "..."
...
...
Specification
-------------

:Parent keyword: :ref:`kw-design`
:Arguments: String
:Default: None
24 changes: 24 additions & 0 deletions _sources/ref/keyword/kw-builder.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _kw-builder:

builder
=========

Method or tool to create the |structure gene|.

.. code-block:: yaml
cs:
- name: "my_cs"
builder: "..."
...
...
Specification
-------------

:Parent keyword: :ref:`kw-sg`
:Arguments: String
:Default: None



6 changes: 6 additions & 0 deletions _sources/ref/keyword/kw-data.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _kw-data:

data
======


5 changes: 5 additions & 0 deletions _sources/ref/keyword/kw-data_form.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. _kw-data_form:

data_form
=============

Loading

0 comments on commit a36a54c

Please sign in to comment.