Skip to content

Commit 60c75ed

Browse files
committed
Commit remaining PY files for examples and other misc. edited files
1 parent c9c33f1 commit 60c75ed

File tree

22 files changed

+355
-270
lines changed

22 files changed

+355
-270
lines changed

README.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
PyDYNA
2-
######
3-
1+
PyDYNA Overview
2+
===============
43
PyDYNA is a Pythonic package for providing a more convenient and complete way to
54
build an Ansys DYNA input deck, submit it to the Ansys LS-DYNA solver, and
65
finally postprocess the results.
76

8-
Overview
9-
========
107
In the PyDYNA installation, the ``docker`` directory has two child
118
directories:
129

@@ -35,6 +32,11 @@ a simplified Python interface to DPF, thus enabling rapid postprocessing
3532
without ever leaving a Python environment. For more information on DPF-Post,
3633
see the `DPF-Post documentation <https://post.docs.pyansys.com>`_.
3734

35+
Installation
36+
============
37+
To use PyDYNA, you must install Docker images for the ``pre`` and ``solver``
38+
services and the package.
39+
3840
Install Docker image for the ``pre`` service
3941
--------------------------------------------
4042
To launch the ``pre`` service locally, you must have Docker installed
@@ -146,7 +148,7 @@ If you're on Windows with Python 3.8, unzip thw wheelhouse archive to a ``wheelh
146148
directory and install PyDYNA using the preceding command.
147149

148150
Documentation
149-
-------------
151+
=============
150152
For comprehesive information on PyDYNA, see the latest release
151153
`documentation <https://dyna.docs.pyansys.com/>`_.
152154

@@ -155,7 +157,7 @@ issues to submit questions, report bugs, and request new features. To reach
155157
the PyAnsys support team, email `[email protected] <[email protected]>`_.
156158

157159
Usage
158-
-----
160+
=====
159161
Here is a basic preprocessing example:
160162

161163
.. code:: python
@@ -268,7 +270,7 @@ For more examples, see `Examples <https://dyna.docs.pyansys.com/version/stable/e
268270
in the PyDYNA documentation.
269271

270272
License
271-
-------
273+
=======
272274
PyDYNA is licensed under the MIT license.
273275

274276
PyDYNA makes no commercial claim over Ansys whatsoever. This libray extends the functionality of

docker/pre/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Build the Docker image for the ``pre`` service
2-
----------------------------------------------
2+
==============================================
33

44
You must build the Docker image for the PyDNA ``pre`` service and then
55
run the image as a container.
66

77
Prerequisites
8-
~~~~~~~~~~~~~
8+
-------------
99

1010
* Ensure that you have cloned the PyDYNA repository locally with these commands:
1111

@@ -28,7 +28,7 @@ Prerequisites
2828

2929

3030
Build the Docker image
31-
~~~~~~~~~~~~~~~~~~~~~~
31+
----------------------
3232

3333
Once all prerequisites are met, perform these steps to build the Docker image:
3434

@@ -57,7 +57,7 @@ Once all prerequisites are met, perform these steps to build the Docker image:
5757
5858
5959
Run the image as a container
60-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60+
----------------------------
6161

6262
Perform these steps to run the image as a container:
6363

docker/solver/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Build the Docker image for the ``solver`` service
2-
-------------------------------------------------
2+
=================================================
33

44
You must build the Docker image for the PyDNA ``solver`` service and then
55
run the image as a container.
66

77
Prerequisites
8-
~~~~~~~~~~~~~
8+
-------------
99

1010
* Ensure that you have cloned the PyDYNA repository locally with these commands:
1111

@@ -31,7 +31,7 @@ Prerequisites
3131

3232

3333
Build the Docker image
34-
~~~~~~~~~~~~~~~~~~~~~~
34+
----------------------
3535

3636
Once all prerequisites are met, perform these steps to build the Docker image:
3737

@@ -59,7 +59,7 @@ Once all prerequisites are met, perform these steps to build the Docker image:
5959
6060
6161
Run the image as a container
62-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
62+
----------------------------
6363

6464
Perform these steps to run the image as a container:
6565

examples/Airbag/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Airbag examples
22
~~~~~~~~~~~~~~~~
33

4-
These examples show how to create and use an airbag model.
4+
These examples show how to create and use airbag models.

examples/Airbag/airbag_deploy.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
# Manually start the ``pre`` service
3434
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3535
# Copy the ``pyDyna/src/ansys/dyna/core/pre/Server``folder to a desired location.
36-
# Start the ``pre``service at this location by running this command:
36+
# Start the ``pre`` service at this location by running this command:
3737
#
3838
# ``python kwserver.py``
3939
#
@@ -66,7 +66,7 @@
6666
# Create standard explicit control cards
6767
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6868
# This code uses the ``set_termination`` method to set the termination time
69-
# to ``0.03`` in ``*CONTROL_TERMINATION*``. The ``DynaMech`` class
69+
# to ``0.03`` in *CONTROL_TERMINATION*. The ``DynaMech`` class
7070
# automatically generates the common control cards used in
7171
# explicit problems. ``CONTROL_ACCURACY``, ``CONTACT``, ``BULK VISCOCITY``,
7272
# and ``CONTACT``are all automatically generated.

examples/EM/em_rlc_define_func.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
"""
2-
Define RLC circuit by function
3-
==============================
2+
RLC circuit by function
3+
=======================
44
This example shows how the ``Funtion`` object can be used to define an
55
RLC circuit as an inlet boundary condition. The executable file for
6-
LS-DYNA is : ls-dyna_smp_d_R13.1_138-g8429c8a10f_winx64_ifort190.exe.
6+
LS-DYNA is ``ls-dyna_smp_d_R13.1_138-g8429c8a10f_winx64_ifort190.exe``.
77
88
"""
99

examples/EM/em_rlc_isopotential.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
2-
Define R,L,C circuit by isopotential
3-
====================================
2+
RLC circuit by isopotential
3+
===========================
44
This example shows how to use the corresponding ``contype`` in the
55
``connect_isopotential()`` method to define an RLC circuit as an
66
inlet boundary condition. The executable file for LS-DYNA is

examples/ICFD/README.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
ICFD examples
22
~~~~~~~~~~~~~~
33

4-
These examples show how to create and use ICFD (Incompressible
5-
Comutation Fluid Dynamics) models.
4+
These examples show how to create and use ICFD
5+
incompressible computational fluid dynamics) models.

examples/ISPH/README.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
ISPH examples
22
~~~~~~~~~~~~~
33

4-
These examples show how to create ISPH model.
4+
These examples show how to create and use ISPH (incompressible
5+
smooth particle hydrodynamics) models.

examples/ISPH/rigidtest.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
"""
2-
Rigid test example
3-
=====================
2+
Rigid test
3+
==========
44
5-
This example show how to create an ISPH model with Pydyna-pre module. \n
6-
LS-DYNA version : ls-dyna_mpp_d_R13.0_365-gf8a97bda2a_winx64_ifort190_msmpi.exe
5+
This examples show how to use the PyDYNA ``pre`` service to create
6+
an ISPH model. The executable file for LS-DYNA is
7+
``ls-dyna_mpp_d_R13.0_365-gf8a97bda2a_winx64_ifort190_msmpi.exe``.
78
"""
89

910
import os

0 commit comments

Comments
 (0)