PyAnsys Tools Report

Contents

• API reference
  • Report
    • Report.project_info()
  • version()
• Getting started
  • Installation
  • Offline installation
  • How does it work?
• User guide
  • Using PyAnsys Tools Report
• Contributing
  • Cloning the PyAnsys Tools Report repository
  • Building documentation
  • Posting issues
  • Code style

README file

Find here below the contents of the repository’s main README file.

PyAnsys Tools Report

Ansys tool for reporting your Python environment’s package versions and hardware resources in a standardized way.

Table of contents

• PyAnsys Tools Report

  • Table of contents

  • Introduction

  • Documentation and issues

  • How does it work?

  • Installation

    • Standard installation

    • Offline installation

  • Rendering the docs

  • Running the tests

  • Requirements

Introduction

The PyAnsys Tools Report is a PyAnsys package to homogenize among all the different repositories the output of system and environment reports related to Ansys products. Its main goals are:

• Provide an homogeneous output style to system and environment reports.

• Allows for customization when reporting Ansys variables and libraries.

You are welcome to help contribute to it in any possible way. Please submit an issue with any proposal you may have.

Documentation and issues

See the documentation page for more details.

You are welcome to help contribute to it in any possible way. Please submit here an issue with any proposal you may have. This is the best place to post questions and code.

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 online documentation to see the details of the module.

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.

Standard installation

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.

Rendering the docs

In case you were interested in rendering the docs locally, you need to clone the repository and install the docs requirements first:

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

Once you have the requirements, render the docs by running the following:

   make -C doc html

This generates the HTML version of the docs, which you may find in the following directory:

   cd doc/_build/html

You can also clean the build directory by running the following command:

   make -C doc clean

Running the tests

In case you were interested in running the tests locally, you need to clone the repository and install the test requirements first:

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

Once you have the requirements, run the tests by running the following:

   pytest

The pyproject.toml file already contains some default configuration for running the tests. Please, take a look at it if you may want to run it with your own configuration.

Requirements

This Python package does not contain specific requirements files. Instead, its requirements may be found within the pyproject.toml file which defines the package. Thus, when the package is installed it automatically detects the dependencies needed and installs them.