Skip to content

Doc2 #206

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

Merged
merged 8 commits into from
Jul 7, 2023
Merged

Doc2 #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bbc93d4
removed post directory from core
kanthadya Jun 30, 2023
2127ad9
removed docker filed from the top directory since they are moved to p…
kanthadya Jun 30, 2023
d58f37c
included docker doc in index.rst
kanthadya Jun 30, 2023
8fe42d7
docker file and build script added to solver
kanthadya Jun 30, 2023
a1b6658
Landing page update
kanthadya Jul 4, 2023
bc60ab3
Merge branch 'main' into doc2
RobPasMue Jul 4, 2023
d4f5433
Merge branch 'main' into doc2
PipKat Jul 5, 2023
fefd1f6
Merge branch 'main' into doc2
RobPasMue Jul 7, 2023
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
6 changes: 3 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ Project Overview
There are 3 related packages here, pre and solver are all under the ansys/pydyna/ directory,
while pyDPF is used for post-processing.

pre contains highly abstracted APIs for setting up a LS-DYNA input deck, so far,
**pre** contains highly abstracted APIs for setting up a LS-DYNA input deck, so far,
it includes DynaMech, DynaIGA, DynaICFD, DynaSALE, DynaEM, DynaAirbag and so on.

solver contains code for interfacing with the LS-DYNA solver directly.
**solver** contains code for interfacing with the LS-DYNA solver directly.
As LS-DYNA is primarily a batch solver with very limited interactive
capabilities, the code here is similarly limited. The target
use case is that LS-DYNA will be running in a container environment
such as Docker or Kubernetes. The code here then allows for pushing
input files to the container, starting LS-DYNA and monitoring its
progress, and retrieving results files.

The Data Processing Framework (DPF) is designed to provide numerical
The **Data Processing Framework (DPF)** is designed to provide numerical
simulation users/engineers with a toolbox for accessing and
transforming simulation data. DPF can access data from solver result
files as well as several neutral formats (csv, hdf5, vtk,
Expand Down
3 changes: 2 additions & 1 deletion doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ PyDyna documentation |version|
===============================

.. include:: ../../README.rst

.. include:: ../../docker/pre/README.rst
.. include:: ../../docker/solver/README.rst

.. jinja:: main_toctree

Expand Down
4 changes: 2 additions & 2 deletions docker/pre/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Build pydyna-pre service docker container
:::::::::::::::::::::::::::::::::::::::::
Create your own pydyna-pre service docker container
:::::::::::::::::::::::::::::::::::::::::::::::::::

The pydyna-pre service Docker containers can be easily built by following
these steps.
Expand Down
4 changes: 2 additions & 2 deletions docker/solver/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Build pydyna-solver service docker container
::::::::::::::::::::::::::::::::::::::::::::
Create your own pydyna-solver service docker container
::::::::::::::::::::::::::::::::::::::::::::::::::::::

The pydyna-solver service Docker containers can be easily built by following
these steps.
Expand Down