This repository has been deprecated in favor of ansys-templates. The new template takes advantage of a dynamic install, allows you to select the build system and is deeply tested.
This repository is a template repository where you can Create a repository from a template and create a new PyAnsys project that follows the guidelines specified in the PyAnsys Developer's Guide.
The following sections should be filled and documented for your project.
Provide a description of your PyAnsys Python library.
Include installation directions. Note that this README will be
included in your PyPI package, so be sure to include pip
directions along with developer installation directions. For example.
Install <PyAnsys Library> with:
pip install ansys-<product/service>-<library>
Alternatively, clone and install in development mode with:
git clone https://github.com/pyansys/ cd <PyAnsys-Library> pip install poetry poetry install
This creates a new virtual environment, which can be activated with
poetry shell
Include a link to the full sphinx documentation. For example PyAnsys
It's best to provide a sample code or even a figure demonstrating the usage of your library. For example:
>>> from ansys.<product/service> import <library>
>>> my_object.<library>()
>>> my_object.foo()
'bar'You can feel free to include this at the README level or in CONTRIBUTING.md
Be sure to point out your license (and any acknowledgments). State that the full license can be found in the root directory of the repository.