Pythonic interface to Ansys Motor-CAD.
Project description
This Python package provides the core Python RPC-JSON interface for Motor-CAD.
Install the package
PyMotorCAD has two installation modes: user and developer.
Install in user mode
Before installing PyMotorCAD in user mode, run this command to esure 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.
To install in developer mode, complete these steps:
Clone the pymotorcad repository with this command:
git clone https://github.com/ansys/pymotorcad
Create a fresh-clean Python environment and 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:
tox
Testing
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, tox creates its own virtual environment to guarantee the project’s integrity by isolating anything being tested.
tox commands
Here are commands for running various checks in the tox environment:
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.
Raw testing
If required, you can call style commands, including black, isort, and flake8 or unit testing commands like`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.
Style checks
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
Documentation
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 this tox command:
tox -e doc && your_browser_name .tox/doc_out/index.html
For more information, see the Documentation page in the PyMotorCAD documentation.
Distribution
If you would like to create either source or wheel files, run the following code to install the building requirements and execute the build module:
python -m pip install -U pip
python -m build
python -m twine check dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ansys_motorcad_core-0.2.0.tar.gz
.
File metadata
- Download URL: ansys_motorcad_core-0.2.0.tar.gz
- Upload date:
- Size: 31.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad350aeeddc41600b3b137455e376ef74495c6bc876b6266d65fd21236906716 |
|
MD5 | 3ef64206f41146b135901032026a91d7 |
|
BLAKE2b-256 | 2265ea2b6ebdb10919681a7d75a9058642fc9f2b4b114d30a86e8cd153e9a774 |
File details
Details for the file ansys_motorcad_core-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: ansys_motorcad_core-0.2.0-py3-none-any.whl
- Upload date:
- Size: 36.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f3f99ec2733776ce64cac5a15e5a342e0bcfee2b171d71bf6b2e72766dc5ec8 |
|
MD5 | 6e6ce7f08a5e830dcf04bdbfc316e7b9 |
|
BLAKE2b-256 | 5cc396e840ee5c5e4f01c9591156ddd1c8425018ab920bd34519caee05673575 |