As noted by @greschd, we can incorporate the use of pyproject.toml and "pin" certain pyansys packages that we know have been tested and are compatible to allow the user to install the the latest pyansys packages for a certain release. Potentially in the following manner (up for discussion):

pip install pyansys==2022R1

We could also install individual packages with:

pip install pyansys[mapdl]

or

pip install pyansys[pymapdl]

https://docs.pyansys.com/version/stable/

If you click PyMechanical from the link above, it goes to https://mechanical.docs.pyansys.com/version/0.8/ instead of https://mechanical.docs.pyansys.com/version/stable

This happens for all of the cards on this page

Landing page of the help indicates to:
pip install ansys-dpf-reader
but ansys-dpf-reader is not a package.

As title says.

Now that PySeascape is public, they should be included in the metapackage. The same goes for the GitHub landing page and documentation.

After public release, PyDynamicReporting has to be added. It also has to be included in the 2023.2.* metapackage

Pinging @margalva for visibility.

📝 Description of the feature

The Python install should be a 64bit--> VTK package has no 32bit version for most of the python installs

💡 Steps for implementing the feature

No response

🔗 Useful links and references

No response

📝 Description of the feature

It would be nice to give support to community users that want to share their examples by having a place for the examples to be uploaded.

💡 Steps for implementing the feature

• Set up a way for PyAnsys user to upload examples.
• Set up a review process to accept/decline examples.
• Set up a webpage/GH pages/documentation section to present the examples.

🔗 Useful links and references

No response

On dev, our links point to version/stable whenever multi-version is enabled.

We should come up with a simple script that will update those links on release branches. It can be run locally, no big deal. The goal is that the script checks the current versions of the packages and changes the stable subfolder for the major.minor folder associated to its package version.

This might imply moving all links to a single file, so that it is easier to maintain.

Python script should be failry simple:

1. Use importlib metadata to check the version of the different packages.
2. Given the version, strip the major.minor value
3. Parse the links file and whenever there is a link associated to this library (we might need a dictionary where the keys are the libraries and the values, the URL to the main CNAME) modify version/stable by version/major.minor

This will only be applicable to those sites that have multi version enabled

As title says. Working on it as soon as I'm back

• Update our setup.py to become a metapackage. This package is guaranteed to work with a certain release of Ansys, (e.g. 2023R1).

"""Metapackage for pyansys packages."""
import sys
import os
from io import open as io_open

from setuptools import setup

# Get version from version info: execute file from raw string
__version__ = None
this_file = os.path.dirname(__file__)
version_file = os.path.join(this_file, 'pyansys', '_version.py')
with io_open(version_file, mode='r') as fd:
    exec(fd.read())


setup(
    name='pyansys',
    packages=['pyansys'],
    author='Ansys',
    maintainer_email='[email protected]',
    version=__version__,
    description='Pythonic interfaces to Ansys products',
    long_description=open('README.rst').read(),
    long_description_content_type='text/x-rst',
    license='MIT',
    classifiers=[
        'Development Status :: 4 - Beta',
        'Intended Audience :: Science/Research',
        'Topic :: Scientific/Engineering :: Information Analysis',
        'License :: OSI Approved :: MIT License',
        'Operating System :: Microsoft :: Windows',
        'Operating System :: POSIX',
        'Operating System :: MacOS',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
        'Programming Language :: Python :: 3.10',
    ],
    url='https://github.com/pyansys',
    keywords='Ansys PyAnsys',
    install_requires=[
        'ansys-mapdl-core==0.62.4',
        'ansys-fluent-core==0.1.4',
        'ansys-dpf-core==0.1.4',
        'pyaedt==0.6.0',
    ],
    extras_require={
        'all': ['ansys-fluent-visualization==0.1.4', 'ansys-mapdl-reader==0.20.0'],
        'fluent': ['ansys-fluent-visualization==0.1.4'],
        'mapdl': ['ansys-mapdl-reader==0.20.0'],
    },
)

• Setup CI/CD. Validate the packages can all be installed and imported. Test with the pip pyansys[all] case as well as just the pip install pyansys. Create the PR as release/2023R1, when merged, tag as v23.1.<PATCH>.
• Add wheelhouse for Python 3.7 - Python 3.10 for Windows and Linux

As discussed in the PyAnsys API meeting, we should check that the dependencies included in the PyAnsys projects do not include any copyleft or similar products. Those must be identified and removed as soon as possible.

@PProfizi mentioned that it is possible to have a bot causing the workflow to fail if any of them are present. We should consider implementing it.

Description of the modifications

As the title says.

Useful links and references

No response

From edge if we are searching for pyansys , sometimes it is showing the old page

liking to the old repo because of the https://github.com/ansys/pyansys/tree/gh-pages/dev folder. Remove the dev folder.

https://github.com/ansys/pysherlock has just gone public! Adding it to the metapackage

ansys-local-productlauncher
ansys-tools-filetransfer
...

Revisit the list and update

From Costas Vogiatzis at Honeywell (Phoenix):
As we are starting to use PyAnsys for Methods work we are trying to determine the best way to support multiple ANSYS versions. For context, most of PyAnsys Methods work so far involves only MAPDL. We are using PyAnsys to read RST/RTH results and to a lesser extent drive MAPDL. Python literacy among ANSYS users is low so we are wrapping PyAnsys functionality in MATLAB code so users can perform these operations from within MATLAB without using Python/PyAnsys directly. These utilities are distributed as part of a larger, general purpose MATLAB library that I maintain.

We typically have users using releases going back up to 3-4 years and we also have archived data that go back even more. Depending on ANSYS version, users would need different PyAnsys module versions and possibly different Python versions. Often times the same user would need to work with multiple ANSYS versions depending on project. Managing dependencies for different ANSYS versions can be done with virtual environments and tools like pyenv for multiple Python versions. However that becomes too complex for a casual ANSYS user: users would need to be guided through Python and module installation and virtual environment use. Also, managing the environments is somewhat fragile because of version conflicts depending on what else the user has installed on that box.

This will be an issue with deployment of PyAnsys based utilities. The concern is that it will be complex for end users to manage and they will not work reliably. We would like to understand how ANSYS envisions multiple versions of ANSYS+PyAnsys would be managed on a single computer in a robust way. Ideally we would like everything relating to PyAnsys to be included in the MAPDL installation so users would not need to manage that.

A related issue is that per the docs the legacy RST reader will be phased out. However DPF does not seem to support older ANSYS versions. That will be an issue if we transition tools to PyAnsys and then find that we cannot use them with some earlier ANSYS result. We would like to understand what tool version can read what MAPDL result file version.

Regards,

Costas Vogiatzis
Aero & Mechanical Sciences
Honeywell Aerospace

Description of the modifications

This page mentions that all pyansys packages can be installed thanks to pip install pyansys, but this command does not work:

Also the error messages does not return instructions for installation of all pyansys packages (pydpf core and post, pyprime mesh, etc), I don't know if this is wanted.

Useful links and references

No response

📝 Description of the feature

We should be able to notify all the core dependencies (at the very least) that they should prepare to have a milestone ready before Ansys release (e.g. 23R1, 23R2...).

This should be done as a GH Actions workflow using the PyGithub package (allows to automatically interact with GitHub's API from Python)

💡 Steps for implementing the feature

To be determined

🔗 Useful links and references

No response

🐞 Problem
Some links are pointing to invalid directions due to the old multi-version logic. See #170. These links need to point to the stable documentation as soon as the new multi-version logic gets released and adopted by projects.

    > I'm also having a hard time understanding what to include in API Reference or Examples for this landing page... the PyAnsys metapackage is not expected to have an API or examples...

Reasonable, though we could probably provide a brief overview of other packages APIs in a smart way... or just do what you did and point out that you should really reference the rest of the pyansys documentation.

@RobPasMue, As a follow-up, let's put better pictures on the landing and reference pages.

Originally posted by @akaszynski in #118 (comment)

MAPDL bullet points should not be mentioned in the PyAEDT section.

Pinging @Revathyvenugopal162 @jorgepiloto

We should implement the search on all public facing indices inside the main PyAnsys docs. Could you two take care of this?

📝 Description of the feature

At the moment, CI/CD is only checking on Python 3.7 to 3.9. We should also include support for Python 3.10 but this also requires updating ansys-dpf-* mainly, since it is the most restrictive in terms of dependencies.

💡 Steps for implementing the feature

Activating commented lines in CI/CD file and updating reqs on pyproject.toml file

🔗 Useful links and references

No response

💡 Idea

Just thought it would be great to have the PyAnsys logo in the README of this repo.

From https://docs.pyansys.com/# the right panel displays as follows:

But I believe the "Connect to Desktop from Python" section should be within the "PyAEDT" section.

Description of the modifications

Create better illustrations for the ansys-dpf-core and ansys-dpf-post thumbnail images on the PyAnsys documentation landing page.

Change the pydpf-core picture here.
Add a pydpf-post picture and link it here.

Useful links and references

No response

📝 Description of the feature

At this very moment, the main README just contains a bunch of information on how to install the different PyAnsys libraries on their own. This is no longer the purpose of this repository.

This README file should be reworked to contain information on: how to install the metapackage, how the versions work, what are the different available targets (all, fluent, mapdl...) and so on.

💡 Steps for implementing the feature

🔗 Useful links and references

🔍 Before submitting the issue

• I have searched among the existing issues
• I am using a Python virtual environment

🐞 Description of the bug

I tried to run a sample code in the Jupyter Notebook as below.
import os
import matplotlib.pyplot as plt
import ansys.aedt.core as pyaedt
if "QT_API" in os.environ:
os.environ["QT_API"] = "pyqt"

I am seeing the below error.
ModuleNotFoundError Traceback (most recent call last)
Input In [16], in
1 import os
3 import matplotlib.pyplot as plt

----> 5 import ansys.aedt.core as pyaedt
7 if "QT_API" in os.environ:
8 os.environ["QT_API"] = "pyqt"

ModuleNotFoundError: No module named 'ansys'

📝 Steps to reproduce

Copy paste the below code in the Jupyter notebook.
import os
import matplotlib.pyplot as plt
import ansys.aedt.core as pyaedt
if "QT_API" in os.environ:
os.environ["QT_API"] = "pyqt"

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

Ver.2023R1.1

🐍 Which Python version are you using?

3.7

📦 Installed packages

ansys-api-fluent==0.3.12
ansys-api-mapdl==0.5.1
ansys-api-mechanical==0.1.0
ansys-api-meshing-prime==0.1.1
ansys-api-platform-instancemanagement==1.0.0b3
ansys-api-systemcoupling==0.1.0
ansys-corba==0.1.1
ansys-dpf-composites==0.2.0
ansys-dpf-core==0.8.1
ansys-dpf-gate==0.3.1
ansys-dpf-gatebin==0.3.1
ansys-dpf-post==0.4.0
ansys-fluent-core==0.14.0
ansys-grantami-bomanalytics==1.1.3
ansys-grantami-bomanalytics-openapi==1.0.0
ansys-grpc-dpf==0.7.1
ansys-mapdl-core==0.64.1
ansys-mapdl-reader==0.52.15
ansys-math-core==0.1.1
ansys-mechanical-core==0.8.0
ansys-meshing-prime==0.3.2
ansys-motorcad-core==0.1.3
ansys-openapi-common==1.2.1
ansys-optislang-core==0.2.1
ansys-platform-instancemanagement==1.1.1
ansys-pythonnet==3.1.0rc1
ansys-seascape==0.2.0
ansys-systemcoupling-core==0.1.3
appdirs==1.4.4
cachetools==5.3.1
certifi==2022.9.24
cffi==1.15.1
charset-normalizer==2.1.1
click==8.1.3
clr-loader==0.2.5
colorama==0.4.6
contourpy==1.1.0
cryptography==41.0.1
cycler==0.11.0
fonttools==4.40.0
google-api-core==2.11.1
google-api-python-client==2.89.0
google-auth==2.20.0
google-auth-httplib2==0.1.0
googleapis-common-protos==1.59.1
grpcio==1.54.2
grpcio-status==1.48.2
h5py==3.8.0
httplib2==0.22.0
idna==3.4
importlib-metadata==4.13.0
importlib-resources==5.12.0
kiwisolver==1.4.4
lxml==4.9.2
matplotlib==3.7.1
numpy==1.23.3
packaging==23.1
pandas==2.0.2
Pillow==9.5.0
platformdirs==3.5.3
plumbum==1.8.2
pooch==1.7.0
protobuf==3.20.3
protoc-gen-swagger==0.1.0
psutil==5.9.5
pyaedt==0.6.76
pyansys==2023.2.3
pyansys-tools-versioning==0.3.3
pyasn1==0.5.0
pyasn1-modules==0.3.0
pycparser==2.21
pyiges==0.3.0
pyparsing==3.0.9
pypiwin32==223
pyspnego==0.9.1
python-dateutil==2.8.2
pythonnet==3.0.1
pytwin==0.3.0
pytz==2023.3
pyvista==0.39.1
pywin32==304
PyYAML==6.0
requests==2.28.1
requests-negotiate-sspi==0.5.2
requests-ntlm==1.2.0
rpyc==5.3.1
rsa==4.9
scipy==1.9.1
scooby==0.7.2
six==1.16.0
tqdm==4.65.0
tzdata==2023.3
uritemplate==4.1.1
urllib3==1.26.12
vtk==9.2.6
zipp==3.15.0

🔍 Before submitting the issue

• I have searched among the existing issues
• I am using a Python virtual environment

🐞 Description of the bug

PyAnsys — PyAnsys
link still pointing to 0.3.2 docs for PyPrimeMesh. Please can we update to 0.4.0.

📝 Steps to reproduce

Click on link to PyPrimeMesh in PyAnsys — PyAnsys

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

N/A

🐍 Which Python version are you using?

3.7

📦 Installed packages

N/A

📝 Description of the feature

This consists on activating the commented line for all, fluent-all extra dependencies and the optional requirement for ansys-fluent-visualization once the issues with ansys-dpf-* have been solved.

💡 Steps for implementing the feature

Activating commented lines in pyproject.toml file

🔗 Useful links and references

No response

Description of the modifications

The banner conveys information regarding the default redirect path, now set to 'version/dev.' the banner can be reuse from pydata or we can write own own banner.

Useful links and references

https://pydata-sphinx-theme.readthedocs.io/en/latest/index.html

Following ADR for Python version support (added or dropped) : https://github.com/ansys-internal/architecture-decision-records/pull/114

We should be able to create issues on all repos (same way we do for the milestones) to inform about new Python version support or dropping old Python versions.

Recommended to use PyGitHub =)

https://github.com/pyansys/pymotorcad PyMotorcad is public now, this should ad in meta package , landing page and docs.

we use the ansys fork: ansys-pythonnet

https://github.com/ansys/grantami-recordlists

🔍 Before submitting the issue

• I have searched among the existing issues
• I am using a Python virtual environment

🐞 Description of the bug

A pinned package should be added along with ansys-dpf-core and ansys-dpf-post.

The ansys-dpf-gate package is specific to ANSYS releases (see here).

This would need to be added to the pinned packages, otherwise once 232 is out with its equivalent ansys-dpf-gate, this will become the latest and people installing with pyansys package will gather the latest instead of the compatible one.

The question now is, ansys-dpf-gate==0.2.1 is the one compatible with ansys-dpf-core==0.6.0.
Otherwise, ansys-dpf-gate==0.2.3 is the latest, to be used with ansys-dpf-core==0.6.2.

📝 Steps to reproduce

None

💻 Which operating system are you using?

Windows

🐍 Which Python version are you using?

3.8

📦 Installed packages

None