# `sees`
<!--
<img align="left" src="https://raw.githubusercontent.com/BRACE2/OpenSeesRT/master/docs/figures/banner.png" width="150px" alt="OpenSees">
-->
<img align="left" src="https://github.com/claudioperez/opensees/blob/master/docs/figures/hockling.png?raw=true" width="350px" alt="SEES Logo">
<!--
https://github.com/claudioperez/sees/blob/master/docs/figures/hockling.png?raw=true
-->
**A modern OpenSees renderer**
<br>
<!--
--------------------------------------------------------------------
-->
<div style="align:center">
[](https://pypi.python.org/pypi/sees)
[](https://pypi.org/project/sees)
<!--
[](https://anaconda.org/conda-forge/sees)
[](https://anaconda.org/sees/sees)
-->
</div>
<!--
--------------------------------------------------------------------
-->
`sees` is a finite element rendering library that leverages modern
web technologies to produce sharable, efficient, and beautiful renderings.
<!-- Badge links -->
[pypi-d-image]: https://img.shields.io/pypi/dm/sees.svg
[license-badge]: https://img.shields.io/pypi/l/sees.svg
[pypi-d-link]: https://pypi.org/project/sees
[pypi-v-image]: https://img.shields.io/pypi/v/sees.svg
[pypi-v-link]: https://pypi.org/project/sees
--------------------------------------------------------------------
<br>
Documentation is currently under development.
## Features
- Extruded deformed shape
- Detailed section rendering
- A wide selection of rendering backends and output file types, including
optimized 3D web formats like `.glb`.
- Correctly render models that treat both `y` or `z` as the
vertical coordinate.
--------------------------------------------------------------------
## Command Line Interface
To create a rendering, execute the following command from the anaconda prompt (after activating the appropriate environment):
```shell
python -m sees model.json -o model.html
```
where `model.json` is a JSON file generate from executing the following OpenSees command:
```tcl
print -JSON model.json
```
If you omit the `-o <file.html>` portion, it will plot immediately in a new
window. You can also use a `.png` extension to save a static image file, as
opposed to the interactive html.
> **Note** Printing depends on the JSON output of a model. Several materials and
> elements in the OpenSeesPy and upstream OpenSees implementations do not
> correctly print to JSON. For the most reliable results, use the
> [`opensees`](https://pypi.org/project/opensees) package.
By default, the rendering treats the $y$ coordinate as vertical.
In order to manually control this behavior, just pass the option
`--vert 3` to render model $z$ vertically, or `--vert 2` to render model $y$ vertically.
If the [`opensees`](https://pypi.org/project/opensees) package is installed,
you can directly render a Tcl script without first printing to JSON,
by just passing a Tcl script instead of the JSON file:
```shell
python -m sees model.tcl -o model.html
```
To plot an elevation (`elev`) plan (`plan`) or section (`sect`) view, run:
```shell
python -m sees model.json --view elev
```
and add `-o <file.extension>` as appropriate.
To see the help page run
```shell
python -m sees --help
```
<br>
See also
- [`opensees`](https://pypi.org/project/opensees)
- [`osmg`](https://pypi.org/project/osmg)
- [`mdof`](https://pypi.org/project/mdof)
- [`sdof`](https://pypi.org/project/sdof)
## Support
<table align="center">
<tr>
<td>
<a href="https://peer.berkeley.edu">
<img src="https://raw.githubusercontent.com/claudioperez/sdof/master/docs/assets/peer-black-300.png"
alt="PEER Logo" width="200"/>
</a>
</td>
<td>
<a href="https://dot.ca.gov/">
<img src="https://raw.githubusercontent.com/claudioperez/sdof/master/docs/assets/Caltrans.svg.png"
alt="Caltrans Logo" width="200"/>
</a>
</td>
<td>
<a href="https://peer.berkeley.edu">
<img src="https://raw.githubusercontent.com/claudioperez/sdof/master/docs/assets/brace2_logo-new3_ungrouped.svg"
alt="BRACE2 Logo" width="200"/>
</a>
</td>
</tr>
</table>
Raw data
{
"_id": null,
"home_page": "",
"name": "sees",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "seismic,post-processing,finite-element-analysis,earthquake-engineering",
"author": "",
"author_email": "\"Claudio M. Perez\" <50180406+claudioperez@users.noreply.github.com>, Chrystal Chern <52893467+chrystalchern@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/fb/c6/e153f4a507e83dd326e8e919705061abfcd80cefc3c029ec5f513165f6d1/sees-0.0.8.tar.gz",
"platform": null,
"description": "# `sees`\n\n<!--\n<img align=\"left\" src=\"https://raw.githubusercontent.com/BRACE2/OpenSeesRT/master/docs/figures/banner.png\" width=\"150px\" alt=\"OpenSees\">\n-->\n\n<img align=\"left\" src=\"https://github.com/claudioperez/opensees/blob/master/docs/figures/hockling.png?raw=true\" width=\"350px\" alt=\"SEES Logo\">\n\n<!--\nhttps://github.com/claudioperez/sees/blob/master/docs/figures/hockling.png?raw=true\n-->\n\n**A modern OpenSees renderer**\n\n<br>\n\n<!-- \n-------------------------------------------------------------------- \n-->\n\n<div style=\"align:center\">\n\n[](https://pypi.python.org/pypi/sees)\n[](https://pypi.org/project/sees)\n\n<!--\n[](https://anaconda.org/conda-forge/sees)\n[](https://anaconda.org/sees/sees)\n-->\n\n</div>\n\n<!-- \n-------------------------------------------------------------------- \n-->\n\n`sees` is a finite element rendering library that leverages modern \nweb technologies to produce sharable, efficient, and beautiful renderings.\n\n\n<!-- Badge links -->\n\n[pypi-d-image]: https://img.shields.io/pypi/dm/sees.svg\n[license-badge]: https://img.shields.io/pypi/l/sees.svg\n[pypi-d-link]: https://pypi.org/project/sees\n[pypi-v-image]: https://img.shields.io/pypi/v/sees.svg\n[pypi-v-link]: https://pypi.org/project/sees\n\n\n-------------------------------------------------------------------- \n\n<br>\n\nDocumentation is currently under development.\n\n## Features\n\n- Extruded deformed shape\n\n- Detailed section rendering\n\n- A wide selection of rendering backends and output file types, including \n optimized 3D web formats like `.glb`.\n\n- Correctly render models that treat both `y` or `z` as the\n vertical coordinate.\n\n-------------------------------------------------------------------- \n\n## Command Line Interface\n\nTo create a rendering, execute the following command from the anaconda prompt (after activating the appropriate environment):\n\n```shell\npython -m sees model.json -o model.html\n```\n\nwhere `model.json` is a JSON file generate from executing the following OpenSees command:\n\n```tcl\nprint -JSON model.json\n```\n\nIf you omit the `-o <file.html>` portion, it will plot immediately in a new\nwindow. You can also use a `.png` extension to save a static image file, as\nopposed to the interactive html.\n\n> **Note** Printing depends on the JSON output of a model. Several materials and\n> elements in the OpenSeesPy and upstream OpenSees implementations do not\n> correctly print to JSON. For the most reliable results, use the\n> [`opensees`](https://pypi.org/project/opensees) package.\n\nBy default, the rendering treats the $y$ coordinate as vertical.\nIn order to manually control this behavior, just pass the option \n`--vert 3` to render model $z$ vertically, or `--vert 2` to render model $y$ vertically.\n\nIf the [`opensees`](https://pypi.org/project/opensees) package is installed,\nyou can directly render a Tcl script without first printing to JSON, \nby just passing a Tcl script instead of the JSON file:\n\n```shell\npython -m sees model.tcl -o model.html\n```\n\nTo plot an elevation (`elev`) plan (`plan`) or section (`sect`) view, run:\n\n```shell\npython -m sees model.json --view elev\n```\n\nand add `-o <file.extension>` as appropriate.\n\nTo see the help page run\n\n```shell\npython -m sees --help\n```\n\n\n\n<br>\n\nSee also\n\n- [`opensees`](https://pypi.org/project/opensees)\n- [`osmg`](https://pypi.org/project/osmg)\n- [`mdof`](https://pypi.org/project/mdof)\n- [`sdof`](https://pypi.org/project/sdof)\n\n## Support\n\n<table align=\"center\">\n<tr>\n\n <td>\n <a href=\"https://peer.berkeley.edu\">\n <img src=\"https://raw.githubusercontent.com/claudioperez/sdof/master/docs/assets/peer-black-300.png\"\n alt=\"PEER Logo\" width=\"200\"/>\n </a>\n </td>\n\n <td>\n <a href=\"https://dot.ca.gov/\">\n <img src=\"https://raw.githubusercontent.com/claudioperez/sdof/master/docs/assets/Caltrans.svg.png\"\n alt=\"Caltrans Logo\" width=\"200\"/>\n </a>\n </td>\n\n <td>\n <a href=\"https://peer.berkeley.edu\">\n <img src=\"https://raw.githubusercontent.com/claudioperez/sdof/master/docs/assets/brace2_logo-new3_ungrouped.svg\"\n alt=\"BRACE2 Logo\" width=\"200\"/>\n </a>\n </td>\n \n </tr>\n</table>\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A modern OpenSees renderer",
"version": "0.0.8",
"project_urls": {
"repository": "http://github.com/BRACE2/sees"
},
"split_keywords": [
"seismic",
"post-processing",
"finite-element-analysis",
"earthquake-engineering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c0c536531f3f6d92a3f9500eb375579b99d3f98db354f5ca0870a1ec390fb326",
"md5": "161af26d056352e62304f758e4d519bd",
"sha256": "573b15e0935490f271b5bd66f8fe993811fb295a6a75b280a20c3603cba9bfef"
},
"downloads": -1,
"filename": "sees-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "161af26d056352e62304f758e4d519bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 40324,
"upload_time": "2024-01-29T10:50:05",
"upload_time_iso_8601": "2024-01-29T10:50:05.715410Z",
"url": "https://files.pythonhosted.org/packages/c0/c5/36531f3f6d92a3f9500eb375579b99d3f98db354f5ca0870a1ec390fb326/sees-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fbc6e153f4a507e83dd326e8e919705061abfcd80cefc3c029ec5f513165f6d1",
"md5": "946caaab29ce0fd01ae7cdd8b39cc279",
"sha256": "a9518fb8c97d9b3e3b18a55f2736b2de3c9013901c78d95e697786a9a0249000"
},
"downloads": -1,
"filename": "sees-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "946caaab29ce0fd01ae7cdd8b39cc279",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35761,
"upload_time": "2024-01-29T10:50:07",
"upload_time_iso_8601": "2024-01-29T10:50:07.244837Z",
"url": "https://files.pythonhosted.org/packages/fb/c6/e153f4a507e83dd326e8e919705061abfcd80cefc3c029ec5f513165f6d1/sees-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 10:50:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BRACE2",
"github_project": "sees",
"github_not_found": true,
"lcname": "sees"
}
JSON
