diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 49c00c8b04..a03d1ad0ff 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -25,27 +25,18 @@ jobs: runs-on: ubuntu-latest steps: - name: PyAnsys code style checks - uses: pyansys/actions/code-style@v2 + uses: pyansys/actions/code-style@v3 with: python-version: ${{ env.MAIN_PYTHON_VERSION }} - # docs-style: - # name: Documentation Style Check - # runs-on: ubuntu-latest - # steps: - # - uses: actions/checkout@v3 - - # - name: Running Vale - # uses: errata-ai/vale-action@reviewdog - # env: - # GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - # with: - # files: doc - # reporter: github-pr-check - # level: error - # filter_mode: nofilter - # fail_on_error: true - # vale_flags: "--config=doc/.vale.ini" + docs-style: + name: Documentation Style Check + runs-on: ubuntu-latest + steps: + - name: PyAnsys documentation style checks + uses: pyansys/actions/doc-style@v3 + with: + token: ${{ secrets.GITHUB_TOKEN }} smoke-tests: name: Build and Smoke tests @@ -55,11 +46,11 @@ jobs: fail-fast: false matrix: os: [windows-latest, ubuntu-latest] - python-version: ['3.7', '3.8', '3.9', '3.10'] + python-version: ['3.7', '3.8', '3.9', '3.10'] #, '3.11'] # --> At some point we should include Py3.11 steps: - name: Build wheelhouse and perform smoke test - uses: pyansys/actions/build-wheelhouse@v2 + uses: pyansys/actions/build-wheelhouse@v3 with: library-name: ${{ env.PACKAGE_NAME }} library-namespace: ${{ env.PACKAGE_NAMESPACE }} @@ -69,7 +60,7 @@ jobs: docs: name: Documentation runs-on: ubuntu-latest - # needs: [docs-style] + needs: [docs-style] steps: - uses: actions/checkout@v3 @@ -103,7 +94,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Build library source and wheel artifacts - uses: pyansys/actions/build-library@v2 + uses: pyansys/actions/build-library@v3 with: library-name: ${{ env.PACKAGE_NAME }} python-version: ${{ env.MAIN_PYTHON_VERSION }} @@ -115,7 +106,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Release to GitHub - uses: pyansys/actions/release-github@v2 + uses: pyansys/actions/release-github@v3 with: library-name: ${{ env.PACKAGE_NAME }} @@ -126,7 +117,7 @@ jobs: needs: [docs] steps: - name: Deploy the latest documentation - uses: pyansys/actions/doc-deploy-dev@v2 + uses: pyansys/actions/doc-deploy-dev@v3 with: cname: ${{ env.DOCUMENTATION_CNAME }} token: ${{ secrets.GITHUB_TOKEN }} @@ -138,7 +129,7 @@ jobs: needs: [release] steps: - name: Deploy the stable documentation - uses: pyansys/actions/doc-deploy-stable@v2 + uses: pyansys/actions/doc-deploy-stable@v3 with: cname: ${{ env.DOCUMENTATION_CNAME }} token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e48f1fb30d..99a99bd639 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -14,7 +14,7 @@ exclude: | repos: - repo: https://github.com/psf/black - rev: 22.10.0 + rev: 23.1.0 hooks: - id: black args: @@ -34,7 +34,7 @@ repos: - --max-line-length=120 - repo: https://github.com/pycqa/isort - rev: 5.10.1 + rev: 5.12.0 hooks: - id: isort args: diff --git a/doc/source/API/index.rst b/doc/source/API/index.rst index 6ed70ccc98..4a5f5c4cc9 100644 --- a/doc/source/API/index.rst +++ b/doc/source/API/index.rst @@ -3,7 +3,7 @@ API reference ============= This section describes PyDyna core classes, methods, and functions -for Dyna apps and modules. Use the search feature or click links +for LS-Dyna apps and modules. Use the search feature or click links to view API documentation. .. toctree:: diff --git a/doc/source/API/pre.rst b/doc/source/API/pre.rst index 535dca272a..3bbeb848cf 100644 --- a/doc/source/API/pre.rst +++ b/doc/source/API/pre.rst @@ -1,5 +1,6 @@ PyDyna-pre APIs -================ +=============== + The PyDyna-pre API includes classes for apps and modules. .. currentmodule:: ansys.dyna.core diff --git a/doc/source/Resources/Getting_Started.rst b/doc/source/Resources/Getting_Started.rst index 0c2f6b94a0..1ca852cf61 100644 --- a/doc/source/Resources/Getting_Started.rst +++ b/doc/source/Resources/Getting_Started.rst @@ -1,8 +1,9 @@ -Getting Started +Getting started =============== Installation ~~~~~~~~~~~~ + This package is not yet available on PyPI, so for now the only real option is for you to download the code from GitHub: @@ -10,4 +11,4 @@ option is for you to download the code from GitHub: git clone https://github.com/pyansys/pyDyna -and copy the required files +and copy the required files. diff --git a/doc/source/Resources/User_Guide.rst b/doc/source/Resources/User_Guide.rst index 127a2087b7..eccbf28f7d 100644 --- a/doc/source/Resources/User_Guide.rst +++ b/doc/source/Resources/User_Guide.rst @@ -1,30 +1,30 @@ -User Guide +User guide ---------- -There are 3 related packages here, all under the ansys/dyna/ directory. +There are 3 related packages here, all under the ``ansys/dyna`` directory. PyDyna-pre provides interface to create DYNA input deck. PyDyna-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 +capabilities, the code here is similarly limited. The target +use case is that LS-DYNA is 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 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, +files as well as several neutral formats (``.csv``, ``.hdf5``, ``.vtk``, etc.). Various operators are available allowing the manipulation and the transformation of this data. The Python `ansys-dpf-post` package provides a simplified Python interface to DPF, thus enabling rapid postprocessing without ever -leaving a Python environment. +leaving a Python environment. -Visit the [DPF-Post Documentation](https://postdocs.pyansys.com) for a +Visit the `DPF-Post Documentation `_ for a detailed description of the package .. toctree:: diff --git a/doc/source/Resources/pydyna_post.rst b/doc/source/Resources/pydyna_post.rst index f56b59ce50..1450327c91 100644 --- a/doc/source/Resources/pydyna_post.rst +++ b/doc/source/Resources/pydyna_post.rst @@ -1,12 +1,12 @@ -PyDPF-post-for-DYNA -=================== +PyDPF-post for LS-DYNA +====================== -operators +Operators ~~~~~~~~~ -1. d3plot +1. ``d3plot`` -- lsdyna::d3plot::meshes_provider +- ``lsdyna::d3plot::meshes_provider`` .. code:: python @@ -30,7 +30,7 @@ operators meshes = meshOP.outputs.meshes() mesh = meshes.get_mesh({'time':1}) -- lsdyna::d3plot::U +- ``lsdyna::d3plot::U`` .. code:: python @@ -45,7 +45,7 @@ operators coord.inputs.time_scoping.connect([3]) fields = coord.outputs.displacement() -- lsdyna::d3plot::TimeFreqSupportProvider +- ``lsdyna::d3plot::TimeFreqSupportProvider`` .. code:: python @@ -58,7 +58,7 @@ operators time.inputs.data_sources.connect(ds) result_time_freq_support = time.outputs.time_freq_support() -- lsdyna::d3plot::result_info_provider +- ``lsdyna::d3plot::result_info_provider`` .. code:: python @@ -71,7 +71,7 @@ operators resultInfoOp.inputs.data_sources(ds) result_info = resultInfoOp.outputs.result_info() -- lsdyna::d3plot::eng_ke +- ``lsdyna::d3plot::eng_ke`` .. code:: python @@ -86,7 +86,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.global_kinetic_energy() -- lsdyna::d3plot::global_internal_energy +- ``lsdyna::d3plot::global_internal_energy`` .. code:: python @@ -101,7 +101,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.global_internal_energy() -- lsdyna::d3plot::global_total_energy +- ``lsdyna::d3plot::global_total_energy`` .. code:: python @@ -116,7 +116,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.global_total_energy() -- lsdyna::d3plot::global_velocity +- ``lsdyna::d3plot::global_velocity`` .. code:: python @@ -131,7 +131,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.global_velocity() -- lsdyna::d3plot::node_initial_coordinates +- ``lsdyna::d3plot::node_initial_coordinates`` .. code:: python @@ -146,7 +146,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_initial_coordinates() -- lsdyna::d3plot::node_coordinates +- ``lsdyna::d3plot::node_coordinates`` .. code:: python @@ -161,7 +161,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_coordinates() -- lsdyna::d3plot::V +- ``lsdyna::d3plot::V`` .. code:: python @@ -176,7 +176,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_velocities() -- lsdyna::d3plot::A +- ``lsdyna::d3plot::A`` .. code:: python @@ -191,7 +191,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_accelerations() -- lsdyna::d3plot::node_temperature +- ``lsdyna::d3plot::node_temperature`` .. code:: python @@ -206,7 +206,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_temperature() -- lsdyna::d3plot::node_heat_flux +- ``lsdyna::d3plot::node_heat_flux`` .. code:: python @@ -221,7 +221,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_heat_flux() -- lsdyna::d3plot::node_mass_scaling +- ``lsdyna::d3plot::node_mass_scaling`` .. code:: python @@ -236,7 +236,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_mass_scaling() -- lsdyna::d3plot::node_temperature_divide_time +- ``lsdyna::d3plot::node_temperature_divide_time`` .. code:: python @@ -251,7 +251,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_temperature_divide_time() -- lsdyna::d3plot::node_residual_force +- ``lsdyna::d3plot::node_residual_force`` .. code:: python @@ -266,7 +266,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_residual_force() -- lsdyna::d3plot::node_residual_moment +- ``lsdyna::d3plot::node_residual_moment`` .. code:: python @@ -281,7 +281,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_residual_moment() -- lsdyna::d3plot::node_penetration +- ``lsdyna::d3plot::node_penetration`` .. code:: python @@ -296,7 +296,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_penetration() -- lsdyna::d3plot::node_relative_penetration +- ``lsdyna::d3plot::node_relative_penetration`` .. code:: python @@ -311,7 +311,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_relative_penetration() -- lsdyna::d3plot::node_contact_energy_density +- ``lsdyna::d3plot::node_contact_energy_density`` .. code:: python @@ -326,7 +326,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.node_contact_energy_density() -- lsdyna::d3plot::S +- ``lsdyna::d3plot::S`` .. code:: python @@ -341,7 +341,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.stress() -- lsdyna::d3plot::stress_von_mises +- ``lsdyna::d3plot::stress_von_mises`` .. code:: python @@ -356,7 +356,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.stress_von_mises() -- lsdyna::d3plot::effective_plastic_strain +- ``lsdyna::d3plot::effective_plastic_strain`` .. code:: python @@ -371,7 +371,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.effective_plastic_strain() -- lsdyna::d3plot::EPEL +- ``lsdyna::d3plot::EPEL`` .. code:: python @@ -386,7 +386,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.strain() -- lsdyna::d3plot::strain_von_mises +- ``lsdyna::d3plot::strain_von_mises`` .. code:: python @@ -401,7 +401,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.strain_von_mises() -- lsdyna::d3plot::history_var +- ``lsdyna::d3plot::history_var`` .. code:: python @@ -416,7 +416,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.history_var() -- lsdyna::d3plot::thickness +- ``lsdyna::d3plot::thickness`` .. code:: python @@ -431,7 +431,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.thickness() -- lsdyna::d3plot::element_dependent_var_1 +- ``lsdyna::d3plot::element_dependent_var_1`` .. code:: python @@ -446,7 +446,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.element_dependent_var_1() -- lsdyna::d3plot::element_dependent_var_2 +- ``lsdyna::d3plot::element_dependent_var_2`` .. code:: python @@ -461,7 +461,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.element_dependent_var_2() -- lsdyna::d3plot::mx +- ``lsdyna::d3plot::mx`` .. code:: python @@ -476,7 +476,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.mx() -- lsdyna::d3plot::my +- ``lsdyna::d3plot::my`` .. code:: python @@ -491,7 +491,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.my() -- lsdyna::d3plot::mxy +- ``lsdyna::d3plot::mxy`` .. code:: python @@ -506,7 +506,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.mxy() -- lsdyna::d3plot::qx +- ``lsdyna::d3plot::qx`` .. code:: python @@ -521,7 +521,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.qx() -- lsdyna::d3plot::qy +- ``lsdyna::d3plot::qy`` .. code:: python @@ -536,7 +536,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.qy() -- lsdyna::d3plot::nx +- ``lsdyna::d3plot::nx`` .. code:: python @@ -551,7 +551,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.nx() -- lsdyna::d3plot::ny +- ``lsdyna::d3plot::ny`` .. code:: python @@ -566,7 +566,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.ny() -- lsdyna::d3plot::nxy +- ``lsdyna::d3plot::nxy`` .. code:: python @@ -581,7 +581,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.nxy() -- lsdyna::d3plot::axial_force +- ``lsdyna::d3plot::axial_force`` .. code:: python @@ -596,7 +596,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.axial_force() -- lsdyna::d3plot::s_shear_resultant +- ``lsdyna::d3plot::s_shear_resultant`` .. code:: python @@ -611,7 +611,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.s_shear_resultant() -- lsdyna::d3plot::t_shear_resultant +- ``lsdyna::d3plot::t_shear_resultant`` .. code:: python @@ -626,7 +626,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.t_shear_resultant() -- lsdyna::d3plot::s_bending_moment +- ``lsdyna::d3plot::s_bending_moment`` .. code:: python @@ -641,7 +641,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.s_bending_moment() -- lsdyna::d3plot::t_bending_moment +- ``lsdyna::d3plot::t_bending_moment`` .. code:: python @@ -656,7 +656,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.t_bending_moment() -- lsdyna::d3plot::torsional_resultant +- ``lsdyna::d3plot::torsional_resultant`` .. code:: python @@ -671,7 +671,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.torsional_resultant() -- lsdyna::d3plot::axial_stress +- ``lsdyna::d3plot::axial_stress`` .. code:: python @@ -686,7 +686,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.axial_stress() -- lsdyna::d3plot::rs_shear_stress +- ``lsdyna::d3plot::rs_shear_stress`` .. code:: python @@ -701,7 +701,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.rs_shear_stress() -- lsdyna::d3plot::tr_shear_stress +- ``lsdyna::d3plot::tr_shear_stress`` .. code:: python @@ -716,7 +716,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.tr_shear_stress() -- lsdyna::d3plot::axial_plastic_strain +- ``lsdyna::d3plot::axial_plastic_strain`` .. code:: python @@ -731,7 +731,7 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.axial_plastic_strain() -- lsdyna::d3plot::axial_strain +- ``lsdyna::d3plot::axial_strain`` .. code:: python @@ -746,9 +746,9 @@ operators resultOp.inputs.time_scoping.connect([3]) result = resultOp.outputs.axial_strain() -2. binout +2. ``binout`` -- lsdyna::binout::meshes_provider +- ``lsdyna::binout::meshes_provider`` .. code:: python @@ -760,7 +760,7 @@ operators meshOP.inputs.data_sources.connect(ds) meshes = meshOP.outputs.meshes() mesh = meshes.get_mesh({}) -- lsdyna::binout::U +- ``lsdyna::binout::U`` .. code:: python @@ -774,7 +774,7 @@ operators coord.inputs.time_scoping.connect([3]) fields = coord.outputs.displacement() -- lsdyna::binout::TimeFreqSupportProvider +- ``lsdyna::binout::TimeFreqSupportProvider`` .. code:: python @@ -787,7 +787,7 @@ operators op.inputs.data_sources(ds) result_time_freq_support = op.outputs.time_freq_support() -- lsdyna::binout::glstat::TimeFreqSupportProvider +- ``lsdyna::binout::glstat::TimeFreqSupportProvider`` .. code:: python @@ -800,7 +800,7 @@ operators op.inputs.data_sources(ds) result_time_freq_support = op.outputs.time_freq_support() -- lsdyna::binout::matsum::TimeFreqSupportProvider +- ``lsdyna::binout::matsum::TimeFreqSupportProvider`` .. code:: python @@ -813,7 +813,7 @@ operators op.inputs.data_sources(ds) result_time_freq_support = op.outputs.time_freq_support() -- lsdyna::binout::rcforc::TimeFreqSupportProvider +- ``lsdyna::binout::rcforc::TimeFreqSupportProvider`` .. code:: python @@ -826,7 +826,7 @@ operators op.inputs.data_sources(ds) result_time_freq_support = op.outputs.time_freq_support() -- lsdyna::binout::result_info_provider +- ``lsdyna::binout::result_info_provider`` .. code:: python @@ -839,7 +839,7 @@ operators resultInfoOp.inputs.data_sources(ds) result_info = resultInfoOp.outputs.result_info() -- lsdyna::binout::S +- ``lsdyna::binout::S`` .. code:: python @@ -852,7 +852,7 @@ operators stressOp.inputs.data_sources(ds) fields = stressOp.outputs.stress() -- lsdyna::binout::EPEL +- ``lsdyna::binout::EPEL`` .. code:: python @@ -865,7 +865,7 @@ operators resultOp.inputs.data_sources(ds) result = resultOp.outputs.strain() -- lsdyna::binout::glstat +- ``lsdyna::binout::glstat`` .. code:: python @@ -883,7 +883,7 @@ operators field1 = fields.get_field({"component":1}) ... -- lsdyna::binout::matsum +- ``lsdyna::binout::matsum`` .. code:: python @@ -901,7 +901,7 @@ operators field1 = fields.get_field({"component":1}) ... -- lsdyna::binout::rcforc +- ``lsdyna::binout::rcforc`` .. code:: python @@ -919,35 +919,35 @@ operators field1 = fields.get_field({"component":1}) ... -1. nvh +1. ``nvh`` -- lsdyna::d3ssd::meshes_provider +- ``lsdyna::d3ssd::meshes_provider`` -- lsdyna::d3spcm::meshes_provider +- ``lsdyna::d3spcm::meshes_provider`` -- lsdyna::d3psd::meshes_provider +- ``lsdyna::d3psd::meshes_provider`` -- lsdyna::d3rms::meshes_provider +- ``lsdyna::d3rms::meshes_provider`` -- lsdyna::d3zcf::meshes_provider +- ``lsdyna::d3zcf::meshes_provider`` -- lsdyna::d3ssd::result_info_provider +- ``lsdyna::d3ssd::result_info_provider`` -- lsdyna::d3ssd::U +- ``lsdyna::d3ssd::U`` -- lsdyna::d3ssd::V +- ``lsdyna::d3ssd::V`` -- lsdyna::d3ssd::A +- ``lsdyna::d3ssd::A`` -- lsdyna::d3ssd::S +- ``lsdyna::d3ssd::S`` -- lsdyna::d3ssd::EPEL +- ``lsdyna::d3ssd::EPEL`` -- lsdyna::d3ssd::TimeFreqSupportProvider +- ``lsdyna::d3ssd::TimeFreqSupportProvider`` same as d3plot -- lsdyna::moddynout::TimeFreqSupportProvider +- ``lsdyna::moddynout::TimeFreqSupportProvider`` .. code:: python @@ -960,7 +960,7 @@ operators resultOp.inputs.data_sources(ds) result = resultOp.outputs.time_freq_support() -- lsdyna::moddynout::result_info_provider +- ``lsdyna::moddynout::result_info_provider`` .. code:: python @@ -973,7 +973,7 @@ operators resultInfoOp.inputs.data_sources(ds) result_info = resultInfoOp.outputs.result_info() -- lsdyna::moddynout::F +- ``lsdyna::moddynout::F`` .. code:: python @@ -988,7 +988,7 @@ operators disOp.inputs.time_scoping(times) fields = disOp.outputs.moddynout_force() -- lsdyna::moddynout::A +- ``lsdyna::moddynout::A`` .. code:: python @@ -1003,7 +1003,7 @@ operators disOp.inputs.time_scoping(times) fields = disOp.outputs.moddynout_acceleration() -- lsdyna::moddynout::V +- ``lsdyna::moddynout::V`` .. code:: python @@ -1018,7 +1018,7 @@ operators disOp.inputs.time_scoping(times) fields = disOp.outputs.moddynout_velocity() -- lsdyna::moddynout::U +- ``lsdyna::moddynout::U`` .. code:: python diff --git a/doc/source/Resources/pydyna_pre.rst b/doc/source/Resources/pydyna_pre.rst index a77284c893..33edbf9a9d 100644 --- a/doc/source/Resources/pydyna_pre.rst +++ b/doc/source/Resources/pydyna_pre.rst @@ -1,42 +1,42 @@ PyDyna-pre ========== -The PyDyna-pre provide the ability to create keyword inputdeck through gRPC framework. +The PyDyna-pre provide the ability to create keyword ``inputdeck`` through gRPC framework. -Running pyDyna-pre in virtualenv --------------------------------- +Running pyDyna-pre in ``virtualenv`` +------------------------------------ -virtualenv is a CLI tool that needs a Python interpreter to run. +``virtualenv`` is a CLI tool that needs a Python interpreter to run. -Install virtualenv -~~~~~~~~~~~~~~~~~~ +Install ``virtualenv`` +~~~~~~~~~~~~~~~~~~~~~~ .. code:: python pip install virtualenv -Create a python virtual environment of the same version as virtualenv,installed into the subdirectory "venv" +Create a Python virtual environment of the same version as ``virtualenv``, installed into the subdirectory ``venv``. .. code:: python virtualenv venv -Activate venv on Windows by running command: +Activate ``venv`` on Windows by running command: .. code:: python cd venv ./Scripts/activate -Activate venv on Linux by running command: +Activate ``venv`` on Linux by running command: .. code:: python cd venv source bin/activate -Copy pyDyna package in venv folder -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Copy pyDyna package in ``venv`` folder +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code:: python @@ -54,7 +54,7 @@ Copy pyDyna package in venv folder Requirements ------------ -Go to pyDyna/requirements/pythonxx according to your Python version. +Go to ``pyDyna/requirements/pythonxx`` according to your Python version. Then running command: .. code:: python @@ -62,7 +62,7 @@ Then running command: cd pyDyna/requirement/pythonxx pip install -r requirements.txt -Starting the Server +Starting the server ------------------- So far, Python 3.8/3.9 is used to start server, make sure this like below: @@ -72,8 +72,9 @@ So far, Python 3.8/3.9 is used to start server, make sure this like below: (venv) C:\pyDyna\examples\pre> C:\python38\python.exe --version Python 3.8.10 -Here is the minimal content in Server folder +Here is the minimal content in server folder ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. code:: python Server/ @@ -88,8 +89,8 @@ Here is the minimal content in Server folder cp39/keywordreader.pyd -Starting the Server on Windows: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Starting the server on Windows +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Start server by running command: @@ -99,8 +100,8 @@ Start server by running command: (venv) C:\pyDyna\ansys\dyna\pre\Server> python .\kwserver.py kwgrpc Server listening on: localhost:50051 -Starting the server on Linux: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Starting the server on Linux +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Start server by running command: @@ -111,12 +112,12 @@ Start server by running command: Running pyDyna-pre client ------------------------- -See the examples in the examples folder for some basic example. More will be added later. +See the examples in the examples folder for some basic example. More to be added later. Structure ALE demo ~~~~~~~~~~~~~~~~~~ -Go to pyDyna/examples/pre,and run sale_efp.py: +Go to ``pyDyna/examples/pre``,and run ``sale_efp.py``: .. code:: python @@ -140,7 +141,7 @@ Go to pyDyna/examples/pre,and run sale_efp.py: 2022-07-05 08:19:43 : Output Setting... 2022-07-05 08:19:43 : efpcase.k is outputed... -At the same time, corresponding information will be printed in the server side. +At the same time, corresponding information is printed in the server side. .. code:: bash @@ -173,7 +174,7 @@ At the same time, corresponding information will be printed in the server side. Saved Successfully! -After running this file,the result file will be save in pyDyna/ansys/dyna/pre/Server/output +After running this file, the result file is saved in ``pyDyna/ansys/dyna/pre/Server/output``. .. code:: bash @@ -189,4 +190,4 @@ After running this file,the result file will be save in pyDyna/ansys/dyna/pre/Se -a---- 2022/7/5 8:19 2436058 efpcase.k -Submit the result file, efpcase.k, to LS-Dyna for simulation results. \ No newline at end of file +Submit the result file, ``efpcase.k``, to LS-Dyna for simulation results. \ No newline at end of file diff --git a/doc/source/Resources/pydyna_solver.rst b/doc/source/Resources/pydyna_solver.rst index 0e6f044d9a..210e394904 100644 --- a/doc/source/Resources/pydyna_solver.rst +++ b/doc/source/Resources/pydyna_solver.rst @@ -1,12 +1,12 @@ PyDyna-solver -============== +============= -Here's a quick preview for how Python code looks using the +Here is a quick preview for how Python code looks using the ``pyansys-DynaSolver``. For more examples, click the links at the top of the page to see function, method, and class documentation. -Rendered Python Code +Rendered Python code -------------------- .. code:: python diff --git a/doc/source/_static/README.md b/doc/source/_static/README.md index ff7796e464..d2c955ccc3 100644 --- a/doc/source/_static/README.md +++ b/doc/source/_static/README.md @@ -1 +1 @@ -Static files will be found here (like images and other assets). +Static files are found here (like images and other assets). diff --git a/doc/source/_templates/autosummary/class.rst b/doc/source/_templates/autosummary/class.rst index 7a2249515c..1fbe696156 100644 --- a/doc/source/_templates/autosummary/class.rst +++ b/doc/source/_templates/autosummary/class.rst @@ -1,3 +1,5 @@ +.. vale off + {{ fullname | escape | underline}} .. currentmodule:: {{ module }} @@ -32,3 +34,5 @@ {%- endfor %} {% endif %} {% endblock %} + +.. vale on \ No newline at end of file diff --git a/doc/source/_templates/custom-class-template.rst b/doc/source/_templates/custom-class-template.rst index 7a2249515c..1fbe696156 100644 --- a/doc/source/_templates/custom-class-template.rst +++ b/doc/source/_templates/custom-class-template.rst @@ -1,3 +1,5 @@ +.. vale off + {{ fullname | escape | underline}} .. currentmodule:: {{ module }} @@ -32,3 +34,5 @@ {%- endfor %} {% endif %} {% endblock %} + +.. vale on \ No newline at end of file diff --git a/doc/source/_templates/custom-module-template.rst b/doc/source/_templates/custom-module-template.rst index c3e01c7dba..009898a32d 100644 --- a/doc/source/_templates/custom-module-template.rst +++ b/doc/source/_templates/custom-module-template.rst @@ -1,3 +1,5 @@ +.. vale off + {{ fullname | escape | underline}} .. automodule:: {{ fullname }} @@ -64,3 +66,5 @@ {%- endfor %} {% endif %} {% endblock %} + +.. vale on \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 769b3a6592..e4d5cff864 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,4 +1,4 @@ -PyDyna Documentation 0.0.1 +PyDyna documentation 0.0.1 =========================== .. include:: ../../README.rst diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt index 93480e89b8..ac18bcecb7 100644 --- a/doc/styles/Vocab/ANSYS/accept.txt +++ b/doc/styles/Vocab/ANSYS/accept.txt @@ -13,3 +13,15 @@ PyPI Python pyvista setters +PyDyna +pyDyna +PyDyna-pre +pyDyna-pre +PyDyna-solver +pyDyna-solver +LS-Dyna +LS-DYNA +API +APIs +postprocessing +PyDPF-post \ No newline at end of file diff --git a/src/ansys/dyna/core/pre/dynamaterial.py b/src/ansys/dyna/core/pre/dynamaterial.py index 93ab36644c..da900fa362 100644 --- a/src/ansys/dyna/core/pre/dynamaterial.py +++ b/src/ansys/dyna/core/pre/dynamaterial.py @@ -43,7 +43,6 @@ def __init__( initial_relative_volume=1.0, equation_coefficient=[0, 0, 0, 0, 0.4, 0.4, 0], ): - self.mass_density = mass_density self.pressure_cutoff = pressure_cutoff self.initial_internal_energy = initial_internal_energy @@ -94,7 +93,6 @@ def __init__( volume_correction_coefficient=0.47, initial_internal_energy=0, ): - self.mass_density = mass_density self.shear_modulus = shear_modulus self.youngs_modulus = youngs_modulus