Welcome to Ansys templates#

PyAnsys Python PyPI CH-CI Codecov MIT Black

The ansys-templates repository holds a collection of useful templates compliant with PyAnsys guidelines. It also provides the ansys-templates command line tool for interactively generating new projects based on previous templates.

The main advantages of using this tool are:

  • Building process is fully interactive. There is no need to manually modify files.

  • Output of the project can easily be customized during the rendering process.

  • Generated projects are compliant with PyAnsys Developer’s Guidelines.

For information on using this tool, see the Ansys Templates Documentation.

https://github.com/ansys/ansys-templates/raw/main/doc/source/_static/basic_usage.gif

How to install#

Users can install ansys-templates by running:

python -m pip install ansys-templates

The usage of pipx is encouraged too. See installing ansys-templates using pipx.

Basic commands#

The following commands are provided with ansys-templates:

  • ansys-templates --help: lists information about the tool.

  • ansys-templates list: lists all available templates.

  • ansys-templates new <template name>: creates a new project from template.

Available templates#

Available templates in ansys-templates are:

  • doc-project: Create a documentation project using Sphinx.

  • pybasic: Create a basic Python Package.

  • pyansys: Create a PyAnsys Python Package project.

  • pyansys-advanced: Create an advanced PyAnsys Python Package project.

  • pyansys-openapi-client: Create an OpenAPI Client Package project.

  • pyace: Create a Python project for any method developers.

  • pyace-flask: Create a Flask project initialized for any developer.

  • pyace-grpc: Create gRPC project initialized for any developer.

  • pyace-fast: Create a FastAPI project initialized for any developer.

  • solution: Create a Solution based on the Solution Application Framework.

Template features#

The following table summarizes the main properties for each of the templates available in ansys-templates:

Template

setup.py

pyproject.toml

Actions

tox.ini

requirements/

Docker

doc-project

X

X

X

pybasic

X

pyansys

X

X

X

pyansys-advanced

X

X

X

X

X

pyansys-openapi-client

pyace

X

X

X

X

X

X

pyace-fast

X

X

X

X

X

X

pyace-flask

X

X

X

X

X

X

pyace-grpc

X

X

X

X

X

X

solution

X

X

X

X

Demo branches#

To have a better idea on how each template will look once it gets rendered, see its corresponding demonstration branch.