We absolutely welcome any code contributions and we hope that this guide will facilitate an understanding of the PyMAPDL-Reader code repository. It is important to note that while the PyMAPDL software package is maintained by Ansys and any submissions will be reviewed thoroughly before merging, we still seek to foster a community that can support user questions and develop new features to make this software a useful tool for all users. As such, we welcome and encourage any questions or submissions to this repository.
Cloning the Source Repository¶
You can clone the source repository from PyMAPDL-Reader GitHub and install the latest version in development mode by running:
git clone https://github.com/pyansys/pymapdl-reader cd pymapdl-reader pip install -e .
For general or technical questions about the project, its applications, or about software usage, please create an issue at PyMAPDL-Reader Issues where the community or PyMAPDL-Reader developers can collectively address your questions. The project support team can be reached at email@example.com
By posting on the issues page, your question can be addressed by community members with the needed expertise and the knowledge gained will remain available on the issues page for other users.
If you encounter any bugs or crashes while using PyMAPDL, please report it at PyMAPDL-Reader Issues with an appropriate label so we can promptly address it. When reporting an issue, please be overly descriptive so that we may reproduce it. Whenever possible, please provide tracebacks, screenshots, and sample files to help us address the issue.
We encourage users to submit ideas for improvements to PyMAPDL-Reader! Please create an issue on the PyMAPDL-Reader Issues with a Feature Request label to suggest an improvement. Please use a descriptive title and provide ample background information to help the community implement that functionality. For example, if you would like a reader for a specific file format, please provide a link to documentation of that file format and possibly provide some sample files with screenshots to work with. We will use the issue thread as a place to discuss and provide feedback.
Contributing New Code¶
If you have an idea for how to improve PyMAPDL-Reader, consider first creating an issue as a feature request which we can use as a discussion thread to work through how to implement the contribution.
Once you are ready to start coding, please see the Development Practices section for more details.
All contributed code will be licensed under The MIT License found in the repository. If you did not write the code yourself, it is your responsibility to ensure that the existing license is compatible and included in the contributed files or you can obtain permission from the original author to relicense the code.
This section provides a guide to how we conduct development in the PyMAPDL-Reader repository. Please follow the practices outlined here when contributing directly to this repository.
Consider the following general coding paradigms when contributing:
Follow the Zen of Python. As silly as the core Python developers are sometimes, there’s much to be gained by following the basic guidelines listed in PEP 20. Without repeating them here, focus on making your additions intuitive, novel, and helpful for PyMAPDL-Reader and its users.
When in doubt,
Document it. Include a docstring for any function, method, or class added. Follow the numpydocs docstring guidelines, and always provide a for simple use cases for the new features.
Test it. Since Python is an interperted language, if it’s not tested, it’s probably broken. At the minimum, include unit tests for each new feature within the
testsdirectory. Ensure that each new method, class, or function has reasonable (>90%) coverage.
Additionally, please do not include any data sets for which a license is not available or commercial use is prohibited.
Finally, please take a look at our Code of Conduct
Contributing to PyMAPDL-Reader through GitHub¶
To submit new code to PyMAPDL-Reader, first fork the PyMAPDL-Reader GitHub Repo and then clone the forked repository to your computer. Next, create a new branch based on the Branch Naming Conventions Section in your local repository.
Next, add your new feature and commit it locally. Be sure to commit often as it is often helpful to revert to past commits, especially if your change is complex. Also, be sure to test often. See the Testing Section below for automating testing.
When you are ready to submit your code, create a pull request by following the steps in the Creating a New Pull Request section.
Creating a New Pull Request¶
Once you have tested your branch locally, create a pull request on PyMAPDL-Reader and target your merge to master. This will automatically run continuous integration (CI) testing and verify your changes will work across all supported platforms.
For code verification, someone from the pyansys developers team will review your code to verify your code meets our our standards. Once approved, if you have write permission you may merge the branch. If you don’t have write permission, the reviewer or someone else with write permission will merge the branch and delete the PR branch.
Since it may be necessary to merge your branch with the current
release branch (see below), please do not delete your branch if it
Branch Naming Conventions¶
To streamline development, we have the following requirements for naming branches. These requirements help the core developers know what kind of changes any given branch is introducing before looking at the code.
fix/: any bug fixes, patches, or experimental changes that are minor
feat/: any changes that introduce a new feature or significant addition
junk/: for any experimental changes that can be deleted if gone stale
maint/: for general maintenance of the repository or CI routines
doc/: for any changes only pertaining to documentation
no-ci/: for low impact activity that should NOT trigger the CI routines
testing/: improvements or changes to testing
release/: releases (see below)
Periodically when making changes, be sure to test locally before creating a pull request. The following tests will be executed after any commit or pull request, so we ask that you perform the following sequence locally to track down any new issues from your changes.
pip install -r requirements_test.txt
Run the primary test suite and generate a coverage report with:
pytest -v --cov ansys-mapdl-reader
Spelling and Code Style¶
If you are using Linux or Mac OS, run check spelling and coding style with:
Any misspelled words will be reported. You can add words to be
Documentation for PyMAPDL-Reader is generated from three sources:
Docstrings from the classes, functions, and modules of
Restructured test from docs/
Examples from examples/
General usage and API descriptions should be placed within docs/ and the docstrings. Full examples should be placed in examples.
Documentation Style and Organization¶
Docstrings should follow the numpydocs docstring guidelines. Documentation from docs use reStructuredText format. Examples within the examples/ directory should be PEP8 compliant and will be compiled dynamically during the build process; ensure they run properly locally as they will be verified through the continuous integration performed on GitHub Actions.
Building the Documentation Locally¶
Documentation for PyMAPDL-Reader is hosted at docs.pyansys.com and is
automatically built and deployed using the GitHub Actions. You can
build and verify the html documentation locally by install
and the other documentation build dependencies by running the
following from the PyMAPDL-Reader source directory:
pip install -r requirements_docs.txt
Next, if running Linux/Mac OS, build the documentation with
make -C docs html
Otherwise, if running Windows, build the documentation by running
cd docs make.bat html
Upon the successful build of the documentation, you can open the local
build by opening
Continuous Integration and Continuous Delivery¶
The PyMAPDL-Reader project uses continuous integration and delivery (CI/CD) to automate the building, testing, and deployment tasks. The CI Pipeline is deployed on both GitHub Actions and Azure Pipelines and performs following tasks:
Module wheel build
Core API testing
Spelling and style verification
This project has a branching model that enables rapid development of features without sacrificing stability, and closely follows the Trunk Based Development approach.
The main features of our branching model are:
The master branch is the main development branch. All features, patches, and other branches should be merged here. While all PRs should pass all applicable CI checks, this branch may be functionally unstable as changes might have introduced unintended side-effects or bugs that were not caught through unit testing.
There will be one or many release/ branches based on minor releases (for example release/0.2) which contain a stable version of the code base that is also reflected on PyPi/. Hotfixes from fix/ branches should be merged both to master and to these branches. When necessary to create a new patch release these release branches will have their __version__.py updated and be tagged with a patched semantic version (e.g. 0.2.1). This triggers CI to push to PyPi, and allow us to rapidly push hotfixes for past versions of
ansys.mapdl.readerwithout having to worry about untested features.
When a minor release candidate is ready, a new release branch will be created from master with the next incremented minor version (e.g. release/0.2), which will be thoroughly tested. When deemed stable, the release branch will be tagged with the version (0.2.0 in this case), and if necessary merged with master if any changes were pushed to it. Feature development then continues on master and any hotfixes will now be merged with this release. Older release branches should not be deleted so they can be patched as needed.
Minor Release Steps¶
Minor releases are feature and bug releases that improve the
functionality and stability of
PyMAPDL-Reader. Before a minor release is
created the following will occur:
Create a new branch from the
masterbranch with name
2. Locally run all tests as outlined in the Testing Section and ensure all are passing.
3. Locally test and build the documentation with link checking to make sure no links are outdated. Be sure to run make clean to ensure no results are cached.
cd docs make clean # deletes the sphinx-gallery cache make html -b linkcheck
After building the documentation, open the local build and examine the examples gallery for any obvious issues.
Update the version numbers in
ansys/mapdl/reader/_version.pyand commit it. Push the branch to GitHub and create a new PR for this release that merges it to master. Development to master should be limited at this point while effort is focused on the release.
It is now the responsibility of the PyMAPDL-Reader community and developers to functionally test the new release. It is best to locally install this branch and use it in production. Any bugs identified should have their hotfixes pushed to this release branch.
When the branch is deemed as stable for public release, the PR will be merged to master and the master branch will be tagged with a MAJOR.MINOR.0 release. The release branch will not be deleted. Tag the release with:
git tag <MAJOR.MINOR.0> git push origin --tags
Create a list of all changes for the release. It is often helpful to leverage GitHub’s compare feature to see the differences from the last tag and the master branch. Be sure to acknowledge new contributors by their GitHub username and place mentions where appropriate if a specific contributor is to thank for a new feature.
Place your release notes from step 8 in the description within PyMAPDL-Reader Releases
Patch Release Steps¶
Patch releases are for critical and important bugfixes that can not or should not wait until a minor release. The steps for a patch release
Push the necessary bugfix(es) to the applicable release branch. This will generally be the latest release branch (e.g. release/0.2).
Update __version__.py with the next patch increment (e.g. 0.2.1), commit it, and open a PR that merge with the release branch. This gives the PyMAPDL-Reader developers and community a chance to validate and approve the bugfix release. Any additional hotfixes should be outside of this PR.
When approved, merge with the release branch, but not master as there is no reason to increment the version of the master branch. Then create a tag from the release branch with the applicable version number (see above for the correct steps).
If deemed necessary a release notes page.