| Name | vfo JSON |
| Version |
0.0.18
JSON |
| download |
| home_page | https://github.com/u-anurag/vfo |
| Summary | A package for visualization of OpenSees models. |
| upload_time | 2024-08-08 23:19:18 |
| maintainer | None |
| docs_url | None |
| author | anurag upadhyay |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
***
# vfo (Visualization For OpenSees)
***
***
[](https://pypi.org/project/vfo/)
[](https://pepy.tech/project/vfo)
[](https://pepy.tech/project/vfo)
[](https://pepy.tech/project/vfo)
***
vfo (Visualization for OpenSees) is a Python package to make your life better by helping you visualize your OpenSees models, Python or Tcl. It utilizes Matplotlib 3.0 library to plot 2D and 3D models in a dedicated interactive window. You can use click-and-hold to change the view angle and zoom the plot. The model image can be saved with the desired orientation directly from the interactive plot window. If you did not install matplotlib using Anaconda, you will have to install PyQt or PySide to enable an interactive window (Matplotlib Dependencies).
#### Animation: To save the animation movie as .mp4 file, FFmpeg codecs are required.
When using Spyder IDE and Jupyter notebook, the default setting is to produce a static, inline plot that is not interactive. To change that, write the command %matplotlib qt in the Ipython console and then execute the model plotting commands. This will produce an interactive plot in a dedicated window.
The following elements are supported:
- 2D and 3D Beam-Column Elements
- 2D and 3D Quad Elements
- 2D and 3D Tri Elements
- 8 Node Brick Elements
- Tetrahedron Elements
****
Install this package with,
```bash
pip install vfo
```
Upgrade the package with,
```bash
python -m pip install --upgrade vfo
```
To use this package, import the commands from *vfo*. For example,
```bash
import vfo.vfo as vfo
```
Now, use all the *vfo* visualization commands. For example,
```bash
vfo.plot_model()
```
# USER MANUAL
Documentation for *vfo* can be found here: ([vfo-docs](https://vfo.readthedocs.io/en/latest/index.html)).
Raw data
{
"_id": null,
"home_page": "https://github.com/u-anurag/vfo",
"name": "vfo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "anurag upadhyay",
"author_email": "iitg.anurag@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b0/c2/84f640c87a006b8735e251b07b18e281c644de029c608a3f1d389d36458b/vfo-0.0.18.tar.gz",
"platform": null,
"description": "***\r\n# vfo (Visualization For OpenSees)\r\n***\r\n \r\n\r\n \r\n \r\n***\r\n[](https://pypi.org/project/vfo/)\r\n[](https://pepy.tech/project/vfo)\r\n[](https://pepy.tech/project/vfo)\r\n[](https://pepy.tech/project/vfo)\r\n***\r\n\r\nvfo (Visualization for OpenSees) is a Python package to make your life better by helping you visualize your OpenSees models, Python or Tcl. It utilizes Matplotlib 3.0 library to plot 2D and 3D models in a dedicated interactive window. You can use click-and-hold to change the view angle and zoom the plot. The model image can be saved with the desired orientation directly from the interactive plot window. If you did not install matplotlib using Anaconda, you will have to install PyQt or PySide to enable an interactive window (Matplotlib Dependencies).\r\n\r\n#### Animation: To save the animation movie as .mp4 file, FFmpeg codecs are required.\r\n\r\nWhen using Spyder IDE and Jupyter notebook, the default setting is to produce a static, inline plot that is not interactive. To change that, write the command %matplotlib qt in the Ipython console and then execute the model plotting commands. This will produce an interactive plot in a dedicated window.\r\n\r\nThe following elements are supported:\r\n\r\n- 2D and 3D Beam-Column Elements \r\n- 2D and 3D Quad Elements \r\n- 2D and 3D Tri Elements \r\n- 8 Node Brick Elements \r\n- Tetrahedron Elements\r\n\r\n\r\n\r\n****\r\n\r\nInstall this package with,\r\n```bash\r\npip install vfo\r\n```\r\n\r\nUpgrade the package with,\r\n```bash\r\npython -m pip install --upgrade vfo\r\n```\r\n\r\nTo use this package, import the commands from *vfo*. For example,\r\n\r\n```bash\r\nimport vfo.vfo as vfo\r\n```\r\n\r\nNow, use all the *vfo* visualization commands. For example,\r\n\r\n```bash\r\nvfo.plot_model()\r\n```\r\n\r\n# USER MANUAL\r\nDocumentation for *vfo* can be found here: ([vfo-docs](https://vfo.readthedocs.io/en/latest/index.html)). \r\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for visualization of OpenSees models.",
"version": "0.0.18",
"project_urls": {
"Homepage": "https://github.com/u-anurag/vfo"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3003554b5fa8a707bce89348df9bc090a9a663e7ddc00110f20fbb73784ef1a3",
"md5": "12c35f6590d2d16011632dc7da43d298",
"sha256": "086e95e4d86dd678a5e6034a97082ac4cfb55e163e47c30acf8a0734d1f0e3f8"
},
"downloads": -1,
"filename": "vfo-0.0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "12c35f6590d2d16011632dc7da43d298",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 43978,
"upload_time": "2024-08-08T23:19:17",
"upload_time_iso_8601": "2024-08-08T23:19:17.080480Z",
"url": "https://files.pythonhosted.org/packages/30/03/554b5fa8a707bce89348df9bc090a9a663e7ddc00110f20fbb73784ef1a3/vfo-0.0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0c284f640c87a006b8735e251b07b18e281c644de029c608a3f1d389d36458b",
"md5": "1755d8c8a0d96af6ee8c9419b92f8afa",
"sha256": "d90e387e5c0e91de455c8352d1b3cda7abcf363f8bae12294a155424e7692cc0"
},
"downloads": -1,
"filename": "vfo-0.0.18.tar.gz",
"has_sig": false,
"md5_digest": "1755d8c8a0d96af6ee8c9419b92f8afa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 29129,
"upload_time": "2024-08-08T23:19:18",
"upload_time_iso_8601": "2024-08-08T23:19:18.839582Z",
"url": "https://files.pythonhosted.org/packages/b0/c2/84f640c87a006b8735e251b07b18e281c644de029c608a3f1d389d36458b/vfo-0.0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-08 23:19:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "u-anurag",
"github_project": "vfo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vfo"
}
