{"id":20399887,"url":"https://github.com/kitware/trame","last_synced_at":"2025-05-14T09:09:05.714Z","repository":{"id":37621815,"uuid":"410108340","full_name":"Kitware/trame","owner":"Kitware","description":"Trame lets you weave various components and technologies into a Web Application solely written in Python.","archived":false,"fork":false,"pushed_at":"2025-04-10T03:54:49.000Z","size":106738,"stargazers_count":513,"open_issues_count":14,"forks_count":65,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-10T04:03:57.995Z","etag":null,"topics":["3d","data-visualization","paraview","plotting","python3","trame","trame-maintenance-program","vtk","web-ui"],"latest_commit_sha":null,"homepage":"https://kitware.github.io/trame/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kitware.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.rst","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":"https://www.kitware.com/trame/"}},"created_at":"2021-09-24T21:38:47.000Z","updated_at":"2025-04-10T03:54:52.000Z","dependencies_parsed_at":"2022-07-20T13:48:10.100Z","dependency_job_id":"993a4824-f2d1-4931-914c-cee21b680832","html_url":"https://github.com/Kitware/trame","commit_stats":{"total_commits":419,"total_committers":22,"mean_commits":"19.045454545454547","dds":0.2720763723150358,"last_synced_commit":"aa457e596972592290b791e852a6b3957ee8a59e"},"previous_names":[],"tags_count":155,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Ftrame","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Ftrame/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Ftrame/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Ftrame/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kitware","download_url":"https://codeload.github.com/Kitware/trame/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248624838,"owners_count":21135508,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","data-visualization","paraview","plotting","python3","trame","trame-maintenance-program","vtk","web-ui"],"created_at":"2024-11-15T04:34:51.186Z","updated_at":"2025-04-12T19:40:43.822Z","avatar_url":"https://github.com/Kitware.png","language":"Python","readme":"# trame: simple, powerful, innovative\n\n\nTrame is an easy-to-use, Python-based framework that let you create desktop like application which shows up in your web browser. \nYou can create buttons, dialogs, 3D scenes with VTK/ParaView, charts, maps and much more.\n\nIt is great for any micro apps, dashboards, or even replacing a PyQt app into a web app. \nYou can also use it in development, for example when tweaking/configuring 3D rendering, machine learning and more.\n\nAt the end your app can be used locally, remotely, in the cloud, in Jupyter or on HPC. \n\nTrame is available as a PyPI package, on conda-forge and we provide docker images for cloud deployment.\n\nIf you need help don't hesitate [to reach out](https://www.kitware.com/trame/)\n\n![Test and Release](https://github.com/Kitware/trame/actions/workflows/test_and_release.yml/badge.svg)\n![PyPI](https://img.shields.io/pypi/v/trame?label=pypi%20package)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/trame)\n![Conda - Downloads](https://pyviz.org/_static/cache/trame_conda_downloads_badge.svg)\n![GitHub stars](https://img.shields.io/github/stars/kitware/trame)\n[![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20Trame%20Guru-006BFF)](https://gurubase.io/g/trame)\n\n**trame** - a web framework that weaves together open source components into customized visual analytics easily.\n\n**trame** is French for\n\n* the core that ties things together\n* a guide providing the essence of a task\n\n![Welcome to trame and 3D visualization](https://raw.githubusercontent.com/Kitware/trame/master/docs/vitepress/assets/images/examples/mstar.jpg)\n\nWith **trame**, create stunning, interactive web applications compactly and intuitively.\n\n\n\u003cdiv\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/Kitware/trame/master/docs/vitepress/assets/images/examples/CarotidFlow.jpg\" style=\"width: 30%\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/Kitware/trame/master/docs/vitepress/assets/images/examples/UberPickupsNYC.jpg\" style=\"width: 30%\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/Kitware/trame/master/docs/vitepress/assets/images/examples/FiniteElementAnalysis.jpg\" style=\"width: 30%\"\u003e\n\u003c/div\u003e\n\n\n## 3D Visualization\n\nWith best-in-class VTK and ParaView platforms at its core, **trame** provides complete control of 3D visualizations and data movements.\nDevelopers benefit from a write-once environment while **trame** simply exposes both local and remote rendering through a single method.\n\n## Rich Features\n\n**trame** leverages existing libraries and tools such as Vuetify, Altair, Vega, deck.gl, VTK, ParaView, and more, to create vivid content for visual analytics applications.\n\n## Problem Focused\n\nBy relying simply on Python, **trame** focuses on one's data and associated analysis and visualizations while hiding the complications of web app development.\n\n## Desktop to cloud\n\nThe resulting **trame** applications can act as local desktop applications or remote cloud applications both accessed through a browser.\n\n\n## Installing\n\ntrame can be installed with [pip](https://pypi.org/project/trame/):\n\n```bash\npip install --upgrade trame\n```\n\n\n## Usage\n\nThe [Trame Tutorial](https://kitware.github.io/trame/guide/tutorial/) is the place to go to learn how to use the library and start building your own application.\n\nThe [API Reference](https://trame.readthedocs.io/en/latest/index.html) documentation provides API-level documentation.\n\n\n## License\n\ntrame is made available under the Apache License, Version 2.0. For more details, see [LICENSE](https://github.com/Kitware/trame/blob/master/LICENSE)\n\n\n## Community\n\n[Trame](https://kitware.github.io/trame/) | [Discussions](https://github.com/Kitware/trame/discussions) | [Issues](https://github.com/Kitware/trame/issues) | [Contact Us](https://www.kitware.com/contact-us/)\n\n__Citing options__\n\n[![DOI](https://zenodo.org/badge/410108340.svg)](https://zenodo.org/badge/latestdoi/410108340)\n\n```bibtex\n@article{Trame,\n    author = {Jourdain, S. and O'Leary, P. and Schroeder, W.},\n    title = {Trame: Platform Ubiquitous, Scalable Integration Framework for Visual Analytics},\n    journal = {IEEE Computer Graphics and Applications},\n    month = {March},\n    year = {2025},\n    doi = {10.1109/MCG.2025.3540264},\n}\n```\n\n## Enjoying trame?\n\nShare your experience [with a testimonial](https://github.com/Kitware/trame/issues/18) or [with a brand approval](https://github.com/Kitware/trame/issues/19).\n\n\n## Optional dependencies\n\nWhen installing trame using pip (`pip install trame`) you will get the core infrastructure for any trame application to work but more advanced usage may require additional dependencies.\nThe list below captures what may need to add depending on your usage:\n\n* **pywebview**  : Needed for desktop usage (--app)\n* **jupyterlab** : Needed to run inside jupyter-lab\n* **notebook**   : Needed to run inside jupyter-notebook\n* **requests**   : Needed when using remote assets such as GDrive files\n\n\n## Environments variables\n\n* **TRAME_LOG_NETWORK**     : Path to log file for capturing network exchange. (default: None)\n* **TRAME_WS_MAX_MSG_SIZE** : Maximum size in bytes of any ws message. (default: 10MB)\n* **TRAME_WS_HEART_BEAT**   : Time in second before assuming the server is non-responsive. (default: 30s)\n\n\n## Life cycle callbacks\n\nLife cycle events are directly managed on the application controller\nand are prefixed with `on_*`.\n\n* **on_server_ready**     : All protocols initialized and available for client to connect\n* **on_client_connected** : Connection established to server\n* **on_client_exited**    : Linked to browser \"beforeunload\" event\n* **on_server_exited**    : Trame is exiting its event loop\n\n* **on_server_reload**    : If callback registered it is used for reloading server side modules\n\n\n## Reserved state entries\n\nThe shared state allow us to synchronize the server with the client.\nRather than creating another mechanism to handle similar needs throughout\nthe application we purposely reuse that state internally. To prevent any conflict with any user we are prefixing our internal\nvariable with `trame__*`. In general those state values should not be use\nor changed by the user except for the one listed below:\n\nRead/Write:\n  - **trame__favicon**: Update it to replace the displayed favicon in your\n    browser. The content needs to be an image encoded url.\n  - **trame__title**: Update it to replace your page title\n    (tab name / window name).\n\nRead-only:\n  - **trame__busy**: Provide information if we have pending requests waiting\n    for the server to respond.\n  - **tts**: Template Time Stamp to regenerate sub elements when a template\n    gets updated. Usually used as `:key=\"tts\"` to force some component\n    rebuild.\n\n## Professional Support\n\n\u003csection class=\"kw-block-wrapper kwBlock   px-pt-64 px-pb-64\"\u003e\n        \u003cdiv class=\"background\"\u003e\u003c/div\u003e\n        \u003cdiv class=\"kw-block-wrapper__internal\"\u003e\n           \u003csection class=\"kw-block-advanced-columns kwBlock\"\u003e\n        \u003cdiv class=\"layout\"\u003e\n            \u003cdiv class=\"flex flex-basis-column3 flex-justify-space-between flex-column-gap-64 card-icon-text-wrapper\"\u003e\n                \u003cdiv class=\"flexcolumn\"\u003e\u003cdiv class=\"card-icon-text\"\u003e\u003cdiv class=\"card-icon-text__icon bg-primary-500\"\u003e\u003cdiv class=\"background\"\u003e\u003c/div\u003e\u003cspan class=\"icon icon-tutorials \"\u003e\u003c/span\u003e\u003c/div\u003e\u003cdiv class=\"txt text-align-center\"\u003e\u003ch3 class=\"txt__subtitle font-size-26 font-weight-700\"\u003eTraining\u003c/h3\u003e\u003cdiv class=\"txt__content\"\u003e\u003cp\u003eLearn how to confidently use trame from the expert developers at Kitware.\u003c/p\u003e\n\u003c/div\u003e \u003cdiv class=\"txt__links\"\u003e\u003ca href=\"https://www.kitware.com/courses/trame/\" class=\"btn btn-primary \"\u003eGet Started\u003c/a\u003e\u003c/div\u003e\u003c/div\u003e\u003c/div\u003e\u003c/div\u003e\u003cdiv class=\"flexcolumn\"\u003e\u003cdiv class=\"card-icon-text\"\u003e\u003cdiv class=\"card-icon-text__icon bg-secondary-500\"\u003e\u003cdiv class=\"background\"\u003e\u003c/div\u003e\u003cspan class=\"icon icon-community-support \"\u003e\u003c/span\u003e\u003c/div\u003e\u003cdiv class=\"txt text-align-center\"\u003e\u003ch3 class=\"txt__subtitle font-size-26 font-weight-700\"\u003eSupport\u003c/h3\u003e\u003cdiv class=\"txt__content\"\u003e\u003cp\u003eOur experts can assist your team as you build your web application and establish in-house expertise.\u003c/p\u003e\n\u003c/div\u003e \u003cdiv class=\"txt__links\"\u003e\u003ca href=\"https://www.kitware.com/trame/support/\" class=\"btn btn-secondary \"\u003eGet Support\u003c/a\u003e\u003c/div\u003e\u003c/div\u003e\u003c/div\u003e\u003c/div\u003e\u003cdiv class=\"flexcolumn\"\u003e\u003cdiv class=\"card-icon-text\"\u003e\u003cdiv class=\"card-icon-text__icon bg-gray-500\"\u003e\u003cdiv class=\"background\"\u003e\u003c/div\u003e\u003cspan class=\"icon icon-scripting \"\u003e\u003c/span\u003e\u003c/div\u003e\u003cdiv class=\"txt text-align-center\"\u003e\u003ch3 class=\"txt__subtitle font-size-26 font-weight-700\"\u003eCustom Development\u003c/h3\u003e\u003cdiv class=\"txt__content\"\u003e\u003cp\u003eLeverage Kitware’s 25+ years of experience to quickly build your web application.\u003c/p\u003e\n\u003c/div\u003e \u003cdiv class=\"txt__links\"\u003e\u003ca href=\"https://www.kitware.com/trame/support/\" class=\"btn btn-gray \"\u003eRequest a Quote\u003c/a\u003e\u003c/div\u003e\u003c/div\u003e\u003c/div\u003e\u003c/div\u003e\n            \u003c/div\u003e\n        \u003c/div\u003e\n   \u003c/section\u003e        \n        \u003c/div\u003e\n\u003c/section\u003e\n","funding_links":["https://www.kitware.com/trame/"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Ftrame","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitware%2Ftrame","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Ftrame/lists"}