ansys-dpf-composites 0.1.0

A python wrapper for ansys dpf composites

PyDPF Composites is a Python wrapper for Ansys DPF composites. It implements classes on top of DPF Composites operators and data accessors for short fiber and layered composites (layered shell and solid elements). This module can be used to postprocess fiber reinforced plastics and layered composites and to implement custom failure criteria and computation. For examples demonstrating the behavior and usage of PyDPF Composites, see PyDPF Composites - Examples.

Contribute

Install in development mode

Installing PyDPF Composites in development mode allows you to modify the source and enhance it.

Before attempting to contribute to PyDPF Composites, ensure that you are thoroughly familiar with the PyAnsys Developer’s Guide.

1. Clone the repository:

   git clone https://github.com/pyansys/pydpf-composites
   cd pydpf-composites

2. Install dependencies:

   python -m pip install pipx
   pipx ensurepath
   # Minimum required poetry version is 1.2.0
   pipx install poetry
   pipx install pip
   pipx install tox

3. Create a virtual environment and install the package with development dependencies. PyDPF Composites uses Poetry to manage the development environment.

   poetry install --all-extras

4. Activate the virtual environment:

   poetry shell

Test

Note

The Docker container referenced in the first option is not yet publicly available.

There are three ways to run the PyDPF Composites tests, depending on how the DPF server is started.

1. Run tests with a Docker container.

   docker pull ghcr.io/pyansys/pydpf-composites:231
   pytest .

2. Run tests with a DPF server started from the Ansys installer. The Ansys version must be 2023 R1 or later.

   pytest . --ansys-path "C:\Program Files\Ansys Inc\v231"

3. Run tests with a local gRPC server executable:

   pytest . --server-bin dpf_composites/bin/lib/deps/Ans.Dpf.Grpc.exe

   This currently works only on Windows and with the directory structure of the Ansys internal dpf_composites package. The runtime dependencies of the Ans.Dpf.Grpc.exe file must be in its folder and the parent folder.

Build documentation

Note

The Docker container referenced in this section is not yet publicly available.

On Windows, build documentation with this code:

docker pull ghcr.io/pyansys/pydpf-composites:231
docker run -d -p 21002:50052  ghcr.io/pyansys/pydpf-composites:231
tox -e doc-windows

On Linux, build documentation with this code:

docker pull ghcr.io/pyansys/pydpf-composites:231
docker run -d -p 21002:50052  ghcr.io/pyansys/pydpf-composites:231
tox -e doc-linux

Run style checks

The style checks use pre-commit and can be run through tox:

tox -e style

The style checks can also be configured to run automatically before each git commit:

pre-commit install