ansys-mechanical-env 0.1.17

Overview

PyMechanical-Env contains a package, ansys-mechanical-env, that facilitates the integration of PyMechanical within a Linux environment. The package has the ability to:

• Automatically determine the version and location of the Ansys Mechanical software.

• Offer users the option to manually specify the version number for Mechanical.

• Configure and set the requisite environment variables.

Installation

Two installation modes are provided: user and developer.

python -m pip install -U pip

python -m pip install ansys-mechanical-env

Basic usage

Once the ansys-mechanical-env and ansys-mechanical-core packages are installed, you can run the PyMechanical-Env command-line tool to launch and test embedded instances of PyMechanical on Linux.

Launching a Python shell containing environment variables set up by PyMechanical-Env allows you to run embedded instances of PyMechanical on Linux.

Launch the Python shell with this command:

mechanical-env python

In the Python shell, use this code to run an embedded instance of PyMechanical:

import ansys.mechanical.core as pymechanical
app = pymechanical.App()
print(app)

Run all embedding tests in the PyMechanical repository with this command:

xvfb-run mechanical-env pytest -m embedding

How to test

This project takes advantage of tox. This tool allows you to automate common development tasks (similar to Makefile), but it is oriented towards Python development.

python -m pip install pre-commit && pre-commit install

Distributing

If you would like to create either source or wheel files, start by installing the building requirements and then execute the build module:

python -m pip install -r requirements/requirements_build.txt
python -m build
python -m twine check dist/*

Documentation and issues

Documentation for the latest stable release of this package can be found in this README file.

On the PyMechanical-Env Issues page, you can create issues to report bugs and request new features. On the PyMechanical-Env Discussions page or the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email pyansys.core@ansys.com.

License and acknowledgments

PyMechanical-Env is licensed under the MIT license.

For more information, see the .reuse/dep5 file file, which follows the Reuse specification.

PyMechanical-Env makes no commercial claim over Ansys whatsoever. This tool supports PyMechanical, which extends the functionality of Ansys Mechanical by adding a Python interface to the Mechanical service without changing the core behavior or license of the original software. The use of PyMechanical with an embedded or remote instance of the Mechanical application requires a legally licensed local copy of Ansys.

For more information on the Mechanical application, see the Ansys Mechanical page on the Ansys website.