Adding to external python and contributing#
Ansys Motor-CAD is a dedicated design and analysis tool for electric motors. It enables rapid and accurate multiphysics design and analysis of electric machines across the full-operating spectrum.
PyMotorCAD uses a Python JSON-RPC (remote procedure call) interface for Motor-CAD to launch or connect with a Motor-CAD instance, either locally or from a remote machine via HTTP. With PyMotorCAD, you can programmatically create, interact with, and control a Motor-CAD model, with or without using the Motor-CAD GUI.
Documentation and issues#
Documentation for the latest stable release of PyMotorCAD is hosted at PyMotorCAD documentation.
In the upper right corner of the documentation’s title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.
On the PyMotorCAD Issues page, you can create issues to report bugs and request new features. On the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
To reach the project support team, email email@example.com.
PyMotorCAD has two installation modes: user and developer.
Install in user mode#
Before installing PyMotorCAD in user mode, run this command to ensure that you have the latest version of pip:
python -m pip install -U pip
Then, run this command to install PyMotorCAD:
python -m pip install ansys-motorcad-core
Install in developer mode#
Installing PyMotorCAD in developer mode allows you to modify the source and enhance it.
Note: Before contributing to this project, ensure that you are familiar with all guidelines in the PyAnsys Developer’s Guide.
To install in developer mode, complete these steps:
pymotorcadrepository with this command:
git clone https://github.com/ansys/pymotorcad
Create a fresh-clean Python environment and then activate it with these commands:
# Create a virtual environment python -m venv .venv # Activate it in a POSIX system source .venv/bin/activate # Activate it in Windows CMD environment .venv\Scripts\activate.bat # Activate it in Windows Powershell .venv\Scripts\Activate.ps1
Ensure that you have the latest required build system and documentation, testing, and CI tools with this command:
python -m pip install -U pip tox
Install the project in editable mode with this command:
python -m pip install --editable ansys-motorcad-core
Verify your development installation with this command:
This project takes advantage of tox. This tool allows you to automate common development tasks (similar to Makefile), but it is oriented towards Python development.
While Makefile has rules,
tox has environments. In fact,
its own virtual environment to guarantee the project’s integrity by isolating
anything being tested.
Here are commands for running various checks in the
tox -e style: Checks for coding style quality.
tox -e py: Checks for unit tests.
tox -e py-coverage: Checks for unit testing and code coverage.
tox -e doc: Checks for the documentation-building process.
If required, you can call style commands, such as black, isort, and flake8, or unit testing commands, such as`pytest`_, from the command line. However, using these commands does not guarantee that your project is being tested in an isolated environment, which is why tools like tox exist.
The style checks take advantage of pre-commit. Developers are not forced but encouraged to install this tool by running this command:
python -m pip install pre-commit && pre-commit install
To build documentation, you can run the usual rules provided in the Sphinx Makefile with a command like this:
make -C doc/ html && your_browser_name doc/html/index.html
However, the recommended way of checking documentation integrity is to use
tox command like this:
tox -e doc && your_browser_name .tox/doc_out/index.html
If you would like to create either source or wheel files, run the following commands to install the building requirements and execute the build module:
python -m pip install -U pip python -m build python -m twine check dist/*
License and acknowledgements#
PyMotorCAD is licensed under the MIT license. For more information, see the LICENSE file.
PyMotorCAD makes no commercial claim over Ansys whatsoever. This library extends the capability of Ansys Motor-CAD by adding a Python interface to Motor-CAD without changing the core behaviour or license of the original software. Using PyMotorCAD for interactive control of Motor-CAD requires a legally licensed copy of Motor-CAD.
For more information on Motor-CAD, see the Ansys Motor-CAD page on the Ansys website.