Getting started

To install pyansys-tools-report, carefully read all instructions on this page.

Installation

This package may be installed following two procedures: either the pip package manager installation or the manual installation. The process to be followed for each of them is shown in the upcoming sections.

The pyansys-tools-report package currently supports Python >=3.10 on Windows, Mac OS, and Linux.

Install the latest release from PyPi with:

pip install pyansys-tools-report

Alternatively, install the latest from GitHub via:

pip install git+https://github.com/ansys/pyansys-tools-report.git

For a local “development” version, install with (requires pip >= 22.0):

git clone https://github.com/ansys/pyansys-tools-report.git
cd pyansys-tools-report
pip install .

Offline installation

If you lack an internet connection on your install machine, the recommended way of installing PyAnsys Tools Report is downloading the wheelhouse archive from the Releases Page for your corresponding machine architecture.

Each wheelhouse archive contains all the python wheels necessary to install PyAnsys Tools Report from scratch on Windows and Linux for Python >=3.10. You can install this on an isolated system with a fresh python or on a virtual environment.

For example, on Linux with Python 3.10, unzip it and install it with the following:

unzip pyansys-tools-report-v0.8.1-wheelhouse-Linux-3.10.zip wheelhouse
pip install pyansys-tools-report -f wheelhouse --no-index --upgrade --ignore-installed

If you’re on Windows with Python 3.10, unzip to a wheelhouse directory and install using the same command as before.

Consider installing using a virtual environment. More information on general PyAnsys development can be found in the PyAnsys Developer’s Guide.

How does it work?

This repository basically contains a simple Python package which you can import as follows (once installed):

import ansys.tools.report as pyansys_report

Once imported, you can then start playing around with it:

# Instantiate a "default" Report
rep = pyansys_report.Report()

Refer to the API reference to see the details of the module.