Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

This library is deprecated and will no longer be maintained. Please consider using alternatives. For more information check this issue.

PyAnsys Python PyPI GH-CI Codecov MIT Black

Library to locate Ansys products in a local machine.

How to install

At least two installation modes are provided: user and developer.

For users

In order to install ansys-tools-path, make sure you have the latest version of pip. To do so, run:

python -m pip install -U pip

Then, you can simply execute:

python -m pip install ansys-tools-path

For developers

Installing ansys-tools-path in developer mode allows you to modify the source and enhance it.

Before contributing to the project, please refer to the PyAnsys Developer’s guide. You need to follow these steps:

  1. Start by cloning this repository:

    git clone https://github.com/ansys/ansys-tools-path
  2. Create a fresh-clean Python environment and activate it:

    # Create a virtual environment
    python -m venv .venv
    
    # Activate it in a POSIX system
    source .venv/bin/activate
    
    # Activate it in Windows CMD environment
    .venv\Scripts\activate.bat
    
    # Activate it in Windows Powershell
    .venv\Scripts\Activate.ps1
  3. Make sure you have the latest required build system and doc, testing, and CI tools:

    python -m pip install .[tests]
    python -m pip install .[doc]
    python -m pip install .[build]
  4. Install the project in editable mode:

    python -m pip install --editable ansys-tools-path

How to testing

If required, you can always call the style commands (black, isort, flake8…) or unit testing ones (pytest) from the command line. However, this does not guarantee that your project is being tested in an isolated environment, which is the reason why tools like tox exist.

A note on pre-commit

The style checks take advantage of pre-commit. Developers are not forced but encouraged to install this tool via:

python -m pip install pre-commit && pre-commit install

Documentation

For building documentation, you can either run the usual rules provided in the Sphinx Makefile, such us:

make -C doc/ html && your_browser_name doc/html/index.html

Distributing

If you would like to create either source or wheel files, start by installing the building requirements and then executing the build module:

python -m pip install .[build]
python -m build
python -m twine check dist/*

Release files for ansys-tools-path 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansys-tools-path 0.8.1
File Size Uploaded
ansys_tools_path-0.8.1.tar.gz 7.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ansys-tools-path 0.8.1
File Interpreter ABI Platform
ansys_tools_path-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 21.8 kB

Release files / ansys_tools_path-0.8.1.tar.gz

Download URL ansys_tools_path-0.8.1.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
92cc3b7eb7640aface42149eb5d5a6d373a50a1e2eac5b61500bdba65521a312
BLAKE2b-256 checksum
How to use checksums
2c5d78a91e43f17965b981e60a8b5e21423dade1775c58eb332e7eacf3f2c7d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.14

Release files / ansys_tools_path-0.8.1-py3-none-any.whl

Download URL ansys_tools_path-0.8.1-py3-none-any.whl
Size 13.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e98726f2c5731cda08d875faded59c79217192759b5103ce184553af29f15799
BLAKE2b-256 checksum
How to use checksums
991732c4873b9b61ce6433da5c0af95c48af195749ec2259aa5f64eb66692a23
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.14
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page