| Name | axisvm JSON |
| Version |
1.2.2
JSON |
| download |
| home_page | None |
| Summary | A Python package for AxisVM. |
| upload_time | 2024-04-04 20:08:22 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.10 |
| license | MIT License Copyright (c) 2021 AxisVM - InterCAD Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
engineering
mechanics
finite element method
axisvm
civil engineering
steel design
concrete design
timber design
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# **PyAxisVM** - The official python package for **AxisVM**
<table>
<tr>
<td>Latest Release</td>
<td>
<a href="https://pypi.org/project/axisvm/"/>
<img src="https://badge.fury.io/py/axisvm.svg"/>
</td>
</tr>
<tr>
<td>License</td>
<td>
<a href="https://opensource.org/licenses/MIT"/>
<img src="https://img.shields.io/badge/License-MIT-yellow.svg"/>
</td>
</tr>
</table>
## Overview
The **PyAxisVM** project offers a high-level interface to **AxisVM**, making its operations available directly from Python. It builds on top of Microsoft's COM technology and supports all the features of the original **AxisVM** COM type library, making you able to
* build, manipulate and analyse **AxisVM** models
* find better solutions with iterative methods
* combine the power of **AxisVM** with third-party Python libraries
* build extension modules
On top of that, **PyAxisVM** enhances the type library with Python's slicing mechanism, context management and more, that enables writing clean, concise, and readable code.
## Installation
This is optional, but we suggest you to create a dedicated virtual enviroment at all times to avoid conflicts with your other projects. Create a folder, open a command shell in that folder and use the following command
```console
>>> python -m venv venv_name
```
Once the enviroment is created, activate it via typing
```console
>>> .\venv_name\Scripts\activate
```
The **AxisVM** python package can be installed (either in a virtual enviroment or globally) from PyPI using `pip` on Python >= 3.7 <= 3.10:
```console
>>> pip install axisvm
```
or chechkout with the following command over HTTPS via <https://github.com/AxisVM/pyaxisvm.git> or by using the GitHub CLI
```console
gh repo clone AxisVM/pyaxisvm
```
and install from source by typing
```console
>>> pip install .
```
If you want to run the tests, you can install the package along with the necessary optional dependencies like this
```console
>>> pip install ".[test]"
```
### Development mode
If you are a developer and want to install the library in development mode, the suggested way is by using this command:
```console
>>> pip install "-e .[test, dev]"
```
If you plan to touch the docs, you can install the requirements for that as well:
```console
>>> pip install "-e .[test, dev, docs]"
```
## **Documentation and Issues**
The ***AxisVM API Reference Guide*** is available in pdf format, you can download it [***here***](https://axisvm.eu/axisvm-downloads/#application).
The documentation of this library is available [***here***](https://axisvm.github.io/pyaxisvm-docs/).
Please feel free to post issues and other questions at **PyAxisVM** Issues. This is the best place to post questions and code related to issues with this project. If you are not familiar with GitHub, you can also reach out to us through the usual channels, but if you are, GitHub is preferred.
## Dependencies
You will need a local licenced copy of **AxisVM** version >= 13r2. To get a copy of **AxisVM**, please visit our [***homepage***](https://axisvm.eu/).
## License
**PyAxisVM** is licensed under the [MIT license](https://opensource.org/license/mit/).
This module, **PyAxisVM** makes no commercial claim over AxisVM whatsoever. This tool extends the functionality of **AxisVM** by adding a Python interface to the **AxisVM** COM service without changing the core behavior or license of the original software. The use of **PyAxisVM** requires a legally licensed local copy of **AxisVM**.
Raw data
{
"_id": null,
"home_page": null,
"name": "axisvm",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": "\"InterCAD Ltd.\" <gbokor@axisvm.eu>",
"keywords": "engineering, mechanics, finite element method, AxisVM, civil engineering, steel design, concrete design, timber design",
"author": null,
"author_email": "\"InterCAD Ltd.\" <gbokor@axisvm.eu>",
"download_url": "https://files.pythonhosted.org/packages/0e/83/fd2c2b2808c937734c25e0a4d23b9ea182dd9979e2dfba6fbb04eab68b29/axisvm-1.2.2.tar.gz",
"platform": null,
"description": "# **PyAxisVM** - The official python package for **AxisVM**\r\n\r\n\r\n\r\n<table>\r\n <tr>\r\n <td>Latest Release</td>\r\n <td>\r\n <a href=\"https://pypi.org/project/axisvm/\"/>\r\n <img src=\"https://badge.fury.io/py/axisvm.svg\"/>\r\n </td>\r\n </tr>\r\n <tr>\r\n <td>License</td>\r\n <td>\r\n <a href=\"https://opensource.org/licenses/MIT\"/>\r\n <img src=\"https://img.shields.io/badge/License-MIT-yellow.svg\"/>\r\n </td>\r\n </tr>\r\n</table>\r\n\r\n## Overview\r\n\r\nThe **PyAxisVM** project offers a high-level interface to **AxisVM**, making its operations available directly from Python. It builds on top of Microsoft's COM technology and supports all the features of the original **AxisVM** COM type library, making you able to\r\n \r\n* build, manipulate and analyse **AxisVM** models\r\n\r\n* find better solutions with iterative methods\r\n\r\n* combine the power of **AxisVM** with third-party Python libraries\r\n\r\n* build extension modules\r\n\r\nOn top of that, **PyAxisVM** enhances the type library with Python's slicing mechanism, context management and more, that enables writing clean, concise, and readable code.\r\n\r\n## Installation\r\n\r\nThis is optional, but we suggest you to create a dedicated virtual enviroment at all times to avoid conflicts with your other projects. Create a folder, open a command shell in that folder and use the following command\r\n\r\n```console\r\n>>> python -m venv venv_name\r\n```\r\n\r\nOnce the enviroment is created, activate it via typing\r\n\r\n```console\r\n>>> .\\venv_name\\Scripts\\activate\r\n```\r\n\r\nThe **AxisVM** python package can be installed (either in a virtual enviroment or globally) from PyPI using `pip` on Python >= 3.7 <= 3.10:\r\n\r\n```console\r\n>>> pip install axisvm\r\n```\r\n\r\nor chechkout with the following command over HTTPS via <https://github.com/AxisVM/pyaxisvm.git> or by using the GitHub CLI\r\n\r\n```console\r\ngh repo clone AxisVM/pyaxisvm\r\n```\r\n\r\nand install from source by typing\r\n\r\n```console\r\n>>> pip install .\r\n```\r\n\r\nIf you want to run the tests, you can install the package along with the necessary optional dependencies like this\r\n\r\n```console\r\n>>> pip install \".[test]\"\r\n```\r\n\r\n### Development mode\r\n\r\nIf you are a developer and want to install the library in development mode, the suggested way is by using this command:\r\n\r\n```console\r\n>>> pip install \"-e .[test, dev]\"\r\n```\r\n\r\nIf you plan to touch the docs, you can install the requirements for that as well:\r\n\r\n```console\r\n>>> pip install \"-e .[test, dev, docs]\"\r\n```\r\n\r\n## **Documentation and Issues**\r\n\r\nThe ***AxisVM API Reference Guide*** is available in pdf format, you can download it [***here***](https://axisvm.eu/axisvm-downloads/#application).\r\n\r\nThe documentation of this library is available [***here***](https://axisvm.github.io/pyaxisvm-docs/).\r\n\r\nPlease feel free to post issues and other questions at **PyAxisVM** Issues. This is the best place to post questions and code related to issues with this project. If you are not familiar with GitHub, you can also reach out to us through the usual channels, but if you are, GitHub is preferred.\r\n\r\n## Dependencies\r\n\r\nYou will need a local licenced copy of **AxisVM** version >= 13r2. To get a copy of **AxisVM**, please visit our [***homepage***](https://axisvm.eu/).\r\n\r\n## License\r\n\r\n**PyAxisVM** is licensed under the [MIT license](https://opensource.org/license/mit/).\r\n\r\nThis module, **PyAxisVM** makes no commercial claim over AxisVM whatsoever. This tool extends the functionality of **AxisVM** by adding a Python interface to the **AxisVM** COM service without changing the core behavior or license of the original software. The use of **PyAxisVM** requires a legally licensed local copy of **AxisVM**.\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 AxisVM - InterCAD Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Python package for AxisVM.",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://github.com/AxisVM/pyaxisvm"
},
"split_keywords": [
"engineering",
" mechanics",
" finite element method",
" axisvm",
" civil engineering",
" steel design",
" concrete design",
" timber design"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "411d1dd1260951452cfb17e74b3e177635c73e36b566249e2f6e9b39617e4cdb",
"md5": "aef34cab1a6a218651f2a48ea01e8130",
"sha256": "78c442d19d08bb132adf6a2cf3d4e4c12d26f6f14175d2b9ee615176d6c5dcc4"
},
"downloads": -1,
"filename": "axisvm-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aef34cab1a6a218651f2a48ea01e8130",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 50651,
"upload_time": "2024-04-04T20:08:13",
"upload_time_iso_8601": "2024-04-04T20:08:13.276656Z",
"url": "https://files.pythonhosted.org/packages/41/1d/1dd1260951452cfb17e74b3e177635c73e36b566249e2f6e9b39617e4cdb/axisvm-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e83fd2c2b2808c937734c25e0a4d23b9ea182dd9979e2dfba6fbb04eab68b29",
"md5": "3e287f4edecc89c65284084454d4a949",
"sha256": "4bbfae5a79479ca66acfaffb36fbfa477cc9f6dbee27a2fd79796767016b2a0f"
},
"downloads": -1,
"filename": "axisvm-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "3e287f4edecc89c65284084454d4a949",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 3264462,
"upload_time": "2024-04-04T20:08:22",
"upload_time_iso_8601": "2024-04-04T20:08:22.707930Z",
"url": "https://files.pythonhosted.org/packages/0e/83/fd2c2b2808c937734c25e0a4d23b9ea182dd9979e2dfba6fbb04eab68b29/axisvm-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 20:08:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AxisVM",
"github_project": "pyaxisvm",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [],
"lcname": "axisvm"
}
