| Name | ansys-meshing-prime JSON |
| Version |
0.7.0
JSON |
| download |
| home_page | None |
| Summary | PyPrimeMesh is a Python client to Ansys Prime Server, which delivers core Ansys meshing technology. |
| upload_time | 2025-01-14 14:54:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyPrimeMesh
[](https://docs.pyansys.com/)
[](https://pypi.org/project/ansys-meshing-prime/)
[](https://pypi.org/project/ansys-meshing-prime/)
[](https://github.com/ansys/pyprimemesh/actions/workflows/ci_cd.yml)
[](https://opensource.org/licenses/MIT)
[](https://github.com/psf/black)
[](https://pypi.org/project/ansys-meshing-prime/)
## Overview
PyPrimeMesh is a Python client to Ansys Prime Server, which
delivers core Ansys meshing technology.
## Documentation and issues
Documentation for the latest stable release of PyPrimeMesh is hosted at
[PyPrimeMesh documentation](https://prime.docs.pyansys.com/version/stable/).
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.
You can also [view](https://cheatsheets.docs.pyansys.com/pyprimemesh_cheat_sheet.png) or
[download](https://cheatsheets.docs.pyansys.com/pyprimemesh_cheat_sheet.pdf) the
PyPrimeMesh cheat sheet. This one-page reference provides syntax rules and commands
for using PyPrimeMesh.
On the [PyPrimeMesh Issues](https://github.com/ansys/pyprimemesh/issues) page,
you can create issues to report bugs and request new features. On the
[PyPrimeMesh Discussions](https://github.com/ansys/pyprimemesh/discussions) page or the
[Discussions](https://discuss.ansys.com/) page on the Ansys Developer portal,
you can post questions, share ideas, and get community feedback.
To reach the project support team, email [pyansys.core@ansys.com](mailtto:pyansys.core@ansys.com).
## Installation
The `ansys-meshing-prime` package supports Python 3.10 to Python 3.12 on the Windows and Linux
operating systems.
PyPrimeMesh can be installed with all dependencies directly from PyPi by running
this command:
```bash
pip install ansys-meshing-prime[all]
```
Alternatively, you can clone this repository and install the client using
these commands:
```bash
git clone https://github.com/ansys/pyprimemesh
cd pyprimemesh
pip install -e .[all]
```
The preceding commands install all functionality that is important to development.
To install a basic version of the client, use this command instead:
```bash
pip install -e .
```
## Dependencies
You must have Ansys 2023 R1 or later installed to have access to Ansys Prime Server.
Optionally, CAD readers can be configured.
Ansys Prime Server requires one of the following licenses to run.
The system checks out the first available license from the list in the following order:
1. CFD PrepPost
2. CFD PrepPost Pro
3. Mechanical Enterprise PrepPost
4. Mechanical Enterprise
5. Mechanical Pro
6. Mechanical Premium
7. Ansys LS-DYNA
## Get started
### Launch PyPrimeMesh
To launch PyPrimeMesh, use this code:
```python
import ansys.meshing.prime as prime
with prime.launch_prime() as prime_client:
model = prime_client.model
```
## Run tests
Run tests locally with this command:
```bash
pytest
```
## License and aknowledgments
PyPrimeMesh is licensed under the MIT license.
PyPrimeMesh makes no commercial claim over Ansys whatsoever. This library extends the functionality of
Ansys Prime Server by adding a Python interface without changing the core behavior or license
of the original software. The use of Ansys Prime Server requires a legally licensed copy of Ansys
2023 R1 or later.
Raw data
{
"_id": null,
"home_page": null,
"name": "ansys-meshing-prime",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": "\"ANSYS, Inc.\" <pyansys.core@ansys.com>",
"keywords": null,
"author": null,
"author_email": "\"ANSYS, Inc.\" <pyansys.core@ansys.com>",
"download_url": "https://files.pythonhosted.org/packages/ac/f4/b7ff91c6705f7d23e7459fba983ac5ecc1b7ec696c73e604a641f42d2f16/ansys_meshing_prime-0.7.0.tar.gz",
"platform": null,
"description": "# PyPrimeMesh\n\n[](https://docs.pyansys.com/)\n[](https://pypi.org/project/ansys-meshing-prime/)\n[](https://pypi.org/project/ansys-meshing-prime/)\n[](https://github.com/ansys/pyprimemesh/actions/workflows/ci_cd.yml)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/psf/black)\n[](https://pypi.org/project/ansys-meshing-prime/)\n\n## Overview\n\nPyPrimeMesh is a Python client to Ansys Prime Server, which\ndelivers core Ansys meshing technology.\n\n## Documentation and issues\n\nDocumentation for the latest stable release of PyPrimeMesh is hosted at\n[PyPrimeMesh documentation](https://prime.docs.pyansys.com/version/stable/).\n\nIn the upper right corner of the documentation's title bar, there is an option\nfor switching from viewing the documentation for the latest stable release\nto viewing the documentation for the development version or previously\nreleased versions.\n\nYou can also [view](https://cheatsheets.docs.pyansys.com/pyprimemesh_cheat_sheet.png) or\n[download](https://cheatsheets.docs.pyansys.com/pyprimemesh_cheat_sheet.pdf) the\nPyPrimeMesh cheat sheet. This one-page reference provides syntax rules and commands\nfor using PyPrimeMesh.\n\nOn the [PyPrimeMesh Issues](https://github.com/ansys/pyprimemesh/issues) page,\nyou can create issues to report bugs and request new features. On the\n[PyPrimeMesh Discussions](https://github.com/ansys/pyprimemesh/discussions) page or the\n[Discussions](https://discuss.ansys.com/) page on the Ansys Developer portal,\nyou can post questions, share ideas, and get community feedback. \n\nTo reach the project support team, email [pyansys.core@ansys.com](mailtto:pyansys.core@ansys.com).\n\n## Installation\n\nThe `ansys-meshing-prime` package supports Python 3.10 to Python 3.12 on the Windows and Linux\noperating systems.\n\n\nPyPrimeMesh can be installed with all dependencies directly from PyPi by running\nthis command:\n\n```bash\npip install ansys-meshing-prime[all]\n```\n\nAlternatively, you can clone this repository and install the client using\nthese commands:\n\n```bash\ngit clone https://github.com/ansys/pyprimemesh\ncd pyprimemesh\npip install -e .[all]\n```\n\nThe preceding commands install all functionality that is important to development.\nTo install a basic version of the client, use this command instead:\n\n```bash\npip install -e .\n```\n\n## Dependencies\n\nYou must have Ansys 2023 R1 or later installed to have access to Ansys Prime Server. \nOptionally, CAD readers can be configured.\n\nAnsys Prime Server requires one of the following licenses to run. \nThe system checks out the first available license from the list in the following order:\n\n1. CFD PrepPost\n\n2. CFD PrepPost Pro\n\n3. Mechanical Enterprise PrepPost\n\n4. Mechanical Enterprise\n\n5. Mechanical Pro\n\n6. Mechanical Premium\n\n7. Ansys LS-DYNA\n\n## Get started\n\n### Launch PyPrimeMesh\n\nTo launch PyPrimeMesh, use this code:\n\n```python\nimport ansys.meshing.prime as prime\n\nwith prime.launch_prime() as prime_client:\n model = prime_client.model\n```\n\n## Run tests\n\nRun tests locally with this command:\n```bash\n pytest\n```\n\n## License and aknowledgments\n\nPyPrimeMesh is licensed under the MIT license.\n\nPyPrimeMesh makes no commercial claim over Ansys whatsoever. This library extends the functionality of\nAnsys Prime Server by adding a Python interface without changing the core behavior or license\nof the original software. The use of Ansys Prime Server requires a legally licensed copy of Ansys\n2023 R1 or later.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "PyPrimeMesh is a Python client to Ansys Prime Server, which delivers core Ansys meshing technology.",
"version": "0.7.0",
"project_urls": {
"Discussions": "https://github.com/ansys/pyprimemesh/discussions",
"Documentation": "https://prime.docs.pyansys.com",
"Issues": "https://github.com/ansys/pyprimemesh/issues",
"Releases": "https://github.com/ansys/pyprimemesh/releases",
"Source": "https://github.com/ansys/pyprimemesh"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "061d1f0d861691abddf97b5cceb54ed48004d068cfd9794d211c66efec0e4522",
"md5": "3e525e6108239975fdb09303d9b3ca8c",
"sha256": "8effc1a7624b387bc1a0669f470601fe2072a5ccddb190a103404769c394cee0"
},
"downloads": -1,
"filename": "ansys_meshing_prime-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e525e6108239975fdb09303d9b3ca8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 533206,
"upload_time": "2025-01-14T14:54:33",
"upload_time_iso_8601": "2025-01-14T14:54:33.042970Z",
"url": "https://files.pythonhosted.org/packages/06/1d/1f0d861691abddf97b5cceb54ed48004d068cfd9794d211c66efec0e4522/ansys_meshing_prime-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "acf4b7ff91c6705f7d23e7459fba983ac5ecc1b7ec696c73e604a641f42d2f16",
"md5": "aa994fba88366d7e5dee0d83ce60b988",
"sha256": "0beceb2981e66aad19e5a88142efd97711f04c4f84664cdac0b690bb4d3ac271"
},
"downloads": -1,
"filename": "ansys_meshing_prime-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "aa994fba88366d7e5dee0d83ce60b988",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 384067,
"upload_time": "2025-01-14T14:54:35",
"upload_time_iso_8601": "2025-01-14T14:54:35.972310Z",
"url": "https://files.pythonhosted.org/packages/ac/f4/b7ff91c6705f7d23e7459fba983ac5ecc1b7ec696c73e604a641f42d2f16/ansys_meshing_prime-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 14:54:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansys",
"github_project": "pyprimemesh",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ansys-meshing-prime"
}
