Skip to content

Commit

Permalink
DOCS: Update readme
Browse files Browse the repository at this point in the history
Minor changes to README.md
Added a note about the sematic PR convention.
  • Loading branch information
Devin-Crawford committed May 21, 2024
1 parent fa00714 commit 6b22da5
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,14 @@
PyAEDT is a Python library that interacts directly with the API for
Ansys Electronics Desktop (AEDT) to make scripting simpler. The architecture
for PyAEDT can be reused for all AEDT 3D products (HFSS, Icepak, Maxwell 3D,
and Q3D Extractor), 2D tools, and Ansys Mechanical. PyAEDT also provides
and Q3D Extractor), 2D tools, and Ansys Mechanical inside AEDT. PyAEDT also provides
support for circuit tools like Nexxim and system simulation tools like
Twin Builder. Finally, PyAEDT provides scripting capabilities in Ansys layout
tools like HFSS 3D Layout and EDB. The PyAEDT class and method structures
tools like HFSS 3D Layout. The Ansys Electronics Database
([EDB](https://edb.docs.pyansys.com/version/stable/)) is included
with PyAEDT as a dependency and is recommended for any automated manipulation and
setup of layout data for PCBs, electronic packages and integrated circuits.
The PyAEDT class and method structures
simplify operation while reusing information as much as possible across
the API.

Expand Down Expand Up @@ -130,6 +134,28 @@ To reach the project support team, email [[email protected]](mailto:pyansys
To run PyAEDT, you must have a local licenced copy of AEDT.
PyAEDT supports AEDT versions 2022 R1 or newer.

## Contributing

See the [PyAnsys develoeprs guide](https://dev.docs.pyansys.com) for detailed information about contributing to the PyAnsys project.

Note that PyAEDT uses sematic naming for pull requests (PR). This convention greatly simplifies
the review process by providing meaningful information in the PR title. The
following prefixes should be used for pull requests:

- "BUILD"
- "CHORE"
- "CI"
- "DOCS"
- "FEAT"
- "FIX"
- "PERF"
- "REFACTOR"
- "REVERT"
- "STYLE"
- "TEST"



## Student version

PyAEDT supports AEDT Student versions 2022 R1 and later. For more information, see the
Expand Down

0 comments on commit 6b22da5

Please sign in to comment.