|badge_1| |badge_2|
.. |badge_1| image:: https://github.com/Kitware/trame/actions/workflows/test_and_release.yml/badge.svg :target: https://github.com/Kitware/trame/actions/workflows/test_and_release.yml :alt: Test and Release
.. |badge_2| image:: https://img.shields.io/pypi/dm/trame :alt: Download stats
trame - a web framework that weaves together open source components into customized visual analytics easily.
trame is French for
.. image:: https://raw.githubusercontent.com/Kitware/trame/master/docs/vitepress/assets/images/examples/mstar.jpg :alt: Welcome to trame and 3D visualization
With trame, create stunning, interactive web applications compactly and intuitively.
|image_1| |image_2| |image_3|
.. |image_1| image:: https://raw.githubusercontent.com/Kitware/trame/master/docs/vitepress/assets/images/examples/CarotidFlow.jpg :width: 30% .. |image_2| image:: https://raw.githubusercontent.com/Kitware/trame/master/docs/vitepress/assets/images/examples/UberPickupsNYC.jpg :width: 30% .. |image_3| image:: https://raw.githubusercontent.com/Kitware/trame/master/docs/vitepress/assets/images/examples/FiniteElementAnalysis.jpg :width: 30%
With best-in-class VTK and ParaView platforms at its core, trame provides complete control of 3D visualizations and data movements. Developers benefit from a write-once environment while trame simply exposes both local and remote rendering through a single method.
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.
By relying simply on Python, trame focuses on one's data and associated analysis and visualizations while hiding the complications of web app development.
The resulting trame applications can act as local desktop applications or remote cloud applications both accessed through a browser.
trame can be installed with pip <https://pypi.org/project/trame/>_:
.. code-block:: bash
pip install --upgrade trame
The 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.
The API Reference <https://trame.readthedocs.io/en/latest/index.html>_ documentation provides API-level documentation.
trame is made available under the Apache License, Version 2.0. For more details, see LICENSE <https://github.com/Kitware/trame/blob/master/LICENSE>_
Trame <https://kitware.github.io/trame/>_ | Discussions <https://github.com/Kitware/trame/discussions>_ | Issues <https://github.com/Kitware/trame/issues>_ | RoadMap <https://github.com/Kitware/trame/projects/1>_ | Contact Us <https://www.kitware.com/contact-us/>_
.. image:: https://zenodo.org/badge/410108340.svg :target: https://zenodo.org/badge/latestdoi/410108340
Share your experience with a testimonial <https://github.com/Kitware/trame/issues/18>_ or with a brand approval <https://github.com/Kitware/trame/issues/19>_.
When 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.
The list below captures what may need to add depending on your usage:
Life cycle events are directly managed on the application controller
and are prefixed with on_*.
on_server_ready : All protocols initialized and available for client to connect
on_client_connected : Connection established to server
on_client_exited : Linked to browser "beforeunload" event
on_server_exited : Trame is exiting its event loop
on_server_reload : If callback registered it is used for reloading server side modules
The shared state allow us to synchronize the server with the client.
Rather than creating another mechanism to handle similar needs throughout
the application we purposely reuse that state internally. To prevent any conflict with any user we are prefixing our internal
variable with trame__*. In general those state values should not be use
or changed by the user except for the one listed below:
Read/Write:
Read-only:
:key="tts" to force some component
rebuild.FAQs
Trame, a framework to build applications in plain Python
We found that trame demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.