diff --git a/README.rst b/README.rst index 107d6e991a..90bf66b7ab 100644 --- a/README.rst +++ b/README.rst @@ -10,10 +10,10 @@ 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 @@ -21,7 +21,7 @@ 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, diff --git a/doc/source/index.rst b/doc/source/index.rst index bca21ad579..4f2c29bb0b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,7 +2,8 @@ PyDyna documentation |version| =============================== .. include:: ../../README.rst - +.. include:: ../../docker/pre/README.rst +.. include:: ../../docker/solver/README.rst .. jinja:: main_toctree diff --git a/docker/pre/README.rst b/docker/pre/README.rst index eeeccf4e14..2e51a9c8f7 100644 --- a/docker/pre/README.rst +++ b/docker/pre/README.rst @@ -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. diff --git a/docker/solver/README.rst b/docker/solver/README.rst index b29bcd6f34..a6c44c3448 100644 --- a/docker/solver/README.rst +++ b/docker/solver/README.rst @@ -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.