Getting started

To successfully install ansys-templates, carefully read all instructions on this page.

Before installing

Several requirements must be met before you install ansys-templates.

Upgrading pip

Upgrade pip with:

python -m pip install --upgrade pip

Installing pipx

The ansys-templates tool is built on top of Python. To ensure a clean installation, you can use pipx. It ensures an isolated installation of any Python tool that you want to use.

Install pipx with:

python -m pip install --user pipx

Ensure that pipx is in your PATH with:

python -m pipx ensurepath

If you encounter any issues when installing pipx, see pipx installation guidelines.

Installing ansys-templates

Once pipx is installed, proceed with the installation of ansys-templates with:

python -m pipx install ansys-templates

Upgrading ansys-templates

If you already have ansys-templates installed with pipx, you can upgrade to the latest version with:

python -m pipx upgrade ansys-templates

Verify your installation

Once installed, you can verify your installation with:

ansys-templates --help

The following code is returned:

Usage: ansys-templates [OPTIONS] COMMAND [ARGS]...

Ansys tool for creating new Ansys projects.

Options:
  --help  Show this message and exit.

Commands:
  list     List all available templates names.
  new      Create a new project from desired template.
  version  Display current version.