Contribute as a user#
Users can contribute in a variety of ways, such as reporting bugs, requesting new features, testing in-development features, starting discussions, answering questions, and sharing their work with the community.
Warning
Do not include any proprietary or sensitive information when reporting bugs or showcasing your work.
Found a bug? Report it here.
Got an idea for a new feature? Share it!
Anxious to try out a new feature? Here’s how you can do it.
Want to discuss something? Start or contribute to a discussion.
Help others by answering their questions.
Share your work with the community.
Report bugs#
If you encounter a bug or an issue while using the project, report it. Your feedback helps to identify problems and get them resolved.
Search the PyAnsys Heart Issues page to see if the issue has already been reported.
Create an issue if one doesn’t already exist.
Include a clear description of the issue.
Provide steps to reproduce the issue.
Mention the version of the project you’re using.
Include screenshots or logs if possible.
Request a new feature#
Do you have an idea for a new feature or an improvement? Your suggestions are welcome. You can request a new feature by creating an issue on the PyAnsys Heart Issues page.
Test a new feature#
You can test a new feature before it is officially released. To do so, you can install PyAnsys Heart from the source code by performing the steps in the following child topics.
Clone the repository#
Clone and install the repository:
git clone https://github.com/ansys/pyansys-heart
Install for users#
Install the latest version of PyAnsys Heart to test the latest features as they are being developed, without having to wait for releases.
Set up a virtual environment#
Navigate to the project’s root directory:
cd pyansys-heart
Create a new virtual environment named .venv to isolate your system’s
Python environment:
python -m venv .venv
Activate this environment:
.venv\Scripts\activate.bat
.venv\Scripts\Activate.ps1
source .venv/bin/activate
Install the latest version#
Install PyAnsys Heart in editable mode:
python -m pip install .
Verify the installation by checking the version of the library:
from ansys.health.heart import __version__
print(f"PyAnsys Heart version is {__version__}.")
>>> PyAnsys Heart version is 0.13.3.
Start a discussion#
Complex topics might require a discussion. Whether you want to know how to use PyAnsys Heart for solving your specific problem or you have a suggestion for a new feature, a discussion is a good place to start. You can open a new discussion on the `PyAnsys Heart Discussions`_ page.
Answer questions#
Another great way to contribute is to help others by answering their questions. Maintain a positive and constructive attitude while answering questions. If you don’t know the answer, you can still help by pointing the person in the right direction.