Package: pyansys-tools-report
PyAnsys Tools ReportAnsys tool for reporting your Python environment's package versions and hardware resources in a standardized way.Table of contentsPyAnsys Tools ReportTable of contentsIntroductionDocumentation and issuesHow does it work?InstallationStandard installationOffline installationRendering the docsRunning the testsRequirementsIntroductionThe 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 issuesSee thedocumentationpage for more details.You are welcome to help contribute to it in any possible way. Please submitherean 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):importansys.tools.reportaspyansys_reportOnce imported, you can then start playing around with it:# Instantiate a "default" Reportrep=pyansys_report.Report()Refer to theonline documentationto see the details of the module.InstallationThis 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.Thepyansys-tools-reportpackage currently supports Python >=3.9 on Windows, Mac OS, and Linux.Standard installationInstall the latest release fromPyPiwith:pipinstallpyansys-tools-reportAlternatively, install the latest from GitHub via:pipinstallgit+https://github.com/ansys/pyansys-tools-report.gitFor a local "development" version, install with (requires pip >= 22.0):gitclonehttps://github.com/ansys/pyansys-tools-report.gitcdpyansys-tools-reportpipinstall.Offline installationIf you lack an internet connection on your install machine, the recommended way
of installing PyAnsys Tools Report is downloading the wheelhouse archive from theReleases Pagefor 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.9. You can install
this on an isolated system with a fresh python or on a virtual environment.For example, on Linux with Python 3.9, unzip it and install it with the following:unzippyansys-tools-report-v0.7.0-wheelhouse-Linux-3.9.zipwheelhousepipinstallpyansys-tools-report-fwheelhouse--no-index--upgrade--ignore-installedIf you're on Windows with Python 3.9, unzip to awheelhousedirectory and
install using the same command as before.Consider installing using avirtual environment.
More information on general PyAnsys development can be found in thePyAnsys Developer's Guide.Rendering the docsIn case you were interested in rendering the docs locally, you need to clone the repository and
install the docs requirements first:gitclonehttps://github.com/ansys/pyansys-tools-report.gitcdpyansys-tools-reportpipinstall-e.[doc]Once you have the requirements, render the docs by running the following:make-CdochtmlThis generates the HTML version of the docs, which you may find in the following directory:cddoc/_build/htmlYou can also clean the build directory by running the following command:make-CdoccleanRunning the testsIn case you were interested in running the tests locally, you need to clone the repository and
install the test requirements first:gitclonehttps://github.com/ansys/pyansys-tools-report.gitcdpyansys-tools-reportpipinstall-e.[test]Once you have the requirements, run the tests by running the following:pytestThepyproject.tomlfile 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.RequirementsThis Python package does not contain specific requirements files. Instead, its requirements may
be found within thepyproject.tomlfile which defines the package. Thus, when the package is
installed it automatically detects the dependencies needed and installs them.