Overall guidance on contributing to a PyAnsys library appears in the
in the PyAnsys Developer’s Guide. Ensure that you are thoroughly familiar
with this guide before attempting to contribute to the
The following contribution information is specific to the
repository, which is for the PyGranta BoM Analytics library. This PyAnsys library name
is often used in place of the repository name to provide clarity and improve
Clone the source repository#
Run the following code to clone and install the latest version of the
repository. It installs the package in editable mode, which ensures changes to the code
are immediately visible in the environment. It also installs the required development
dependencies to run the tests.
git clone https://github.com/ansys/grantami-bomanalytics
Use the Issues page for this repository to submit questions, report bugs, and request new features.
To reach the PyAnsys support team, email email@example.com.
View PyGranta BoM Analytics documentation#
Documentation for the latest stable release of PyGranta BoM Analytics is hosted at PyGranta BoM Analytics Documentation.
Examples are included in the documentation to give you more context around the core capabilities described in API reference. Additional examples are welcomed, especially if they cover a key use case of the package that has not yet been covered.
The example scripts are placed in the
examples directory and are included
in the documentation build if the environment variable
BUILD_EXAMPLES is set
True. Otherwise, the building of examples is skipped and a placeholder page is
inserted in the documentation.
Examples are authored using Jupyter notebooks, but they are converted into Python files before being checked in. As part of the doc build process, the Python files are converted back into Jupyter notebooks and are executed, which populates the output cells.
This conversion between Jupyter notebooks and Python files is performed by nb-convert. For installation instructions, see the nb-convert documentation.