ansys-platform-instancemanagement 0.1.0

Installation

The ansys-platform-instancemanagement package is tested for Python 3.7 through Python 3.10 on Windows and Linux.

pip install ansys-platform-instancemanagement

Usage

PyPIM is a single module called ansys.platform.instancemanagement, shortened to pypim.

Starting MAPDL and communicating with it:

import ansys.platform.instancemanagement as pypim
from ansys.mapdl.core import Mapdl

if pypim.is_configured():
    pim=pypim.connect()
    instance = pim.create_instance(product_name="mapdl", product_version="221")
    instance.wait_for_ready()
    channel = instance.build_grpc_channel(options=[("grpc.max_receive_message_length", 8*1024**2)])
    mapdl = Mapdl(channel=channel)
    mapdl.prep7()
    ...
    instance.delete()

Cloning the PyPIM Repository

git clone https://github.com/pyansys/pypim.git
cd pypim/

Running the tests

The test automation relies on tox.

They are entirely based on mocks and do not require any external software. Run the tests with:

tox -e py38

Where py38 matches your python version.

Building the documentation

tox -e doc

Building the package

The package is built using flit.

You can build the PyPIM package with:

flit build

You can also directly install PyPIM in your current environment with:

flit install

Release Process

Releasing a new version is driven by git tags, created from the Github release page.

1. Create the release branch, named release/v<version>, where version does not include the patch part. Eg. release/v0.5, release/v1.2

2. In the release/v<version> branch, remove the .dev0 suffix in pyproject.toml and tests/test_metadata.py

3. Create a new release with a new tag named v<full_version>, including the patch part, based on the latest commit of the release/v<version> branch. Eg. v0.5.0, v1.2.0.

4. In the main branch, increase the version, keeping the .dev0 suffix.

Patch versions are created from their release branch, by cherry-picking commits.