CHANGELOG.md

CHANGELOG

v2.5.1 (2023-07-19)

Ci

• ci: add cuda based docker image (b69e7cb)

Documentation

• docs(discussion): Add example 291 (07688e9)

• docs(nginx): Update deploy-nginx.md (89bcfab)

• docs(nginx): Add config info (43c1193)

• docs(discussion): Add sample code (5c2a424)

• docs(readme): add markdown for indexing (dbbeab5)

• docs(readme): add markdown for indexing (6b9ebce)

• docs: Update README.rst (23f4497)

• docs(website): fix license reference

This commit fixes a regression introduced in 5f55d6a57 (docs(website): update content to match new api ) updating the text describing the license to mention "Apache License Version 2.0" instead of "BSD-3".

The text now described the license effectively associated with the trame v2 project originally introduced in 0e44015c8 (trame a framework to write ubiquitous applications in Python).

For reference, trame v1 license (originally introduced in e8fe5944b (chore: Getting started)) was BSD-3. (979aa84)

Fix

• fix(v2): Last trame v2 release (6c66b44)

v2.5.0 (2023-05-19)

Documentation

• docs(GroupChips): Add example (be98f8f)

• docs(getter): Add example with nested update (cb67736)

• docs(example): Add <trame-getter> example (6a2b20c)

• docs(website): Update mstar tooltip (49c3c93)

• docs(website): Update applications anchor (6379042)

• docs(website): add mstar image in the app section (77a290c)

• docs(website): Add roadmap and v2-3 mention (10ad9a3)

• docs(website): Add roadmap and v2-3 mention (97f6476)

• docs(website): Add more help (97bf7ff)

Feature

• feat(dependencies): Version update for all vue2 widgets (ddddb65)

v2.4.2 (2023-05-11)

Fix

• fix(demo): Rename cone to demo and add jupyter helper (429c10b)

v2.4.1 (2023-05-11)

Fix

• fix: add cone application for validation (bf84770)

v2.4.0 (2023-04-25)

Documentation

• docs(api): list external widgets (a333db1)

• docs(docker): fix docker remote rendering example (ab55187)

• docs(osmesa): update requirements.txt for remote rendering (7b0fcbd)

• docs(docker): VTK remote rendering (e11ff23)

• docs(examples): Add docker remote rendering example (7a847a0)

• docs(vue3): New template handling syntax (fbaffe3)

• docs(vtk): Update example with latest trame-vtk (f306d2d)

• docs(vue23): Clarify some aspect (a5e2a5a)

• docs(website): Update to add doc on vue2/3 (d70f097)

Feature

• feat(py-client): enable cross trame-server communication (afab046)

v2.3.2 (2023-02-14)

Fix

• fix(www): Allow www tool to support either vue2 or vue3

fix #204 (363dd53)

v2.3.1 (2023-02-10)

Documentation

• docs(table): handle dynamic table (be314bf)

Fix

• fix(testing): Add testing helpers (493803d)

v2.3.0 (2023-02-08)

Documentation

• docs(website): Update value proposition (e96749c)

• docs(utils.tree): Add API doc (2818473)

• docs(hot_reload): deprecate @reloading example (96b4eb5)

• docs(hot_reload): make content center (e6aec3f)

Feature

• feat(client_type): Preparation for 3.x release (b88a994)

v2.2.6 (2023-01-20)

Chore

• chore: Update issue template (08a1f57)

Documentation

• docs(hot_reload): Add example (f0f3cc8)

• docs(issues): Add issue code base (f177d4e)

• docs(reloading): Allow dynamic method reloading (06be552)

• docs(Example): Add cursor example (78e31cc)

• docs(DynamicLocalRemoteRendering): Fix example to flush geometry (d0a1deb)

• docs(HPC): update hpc doc

Corrected InfiniteTactics name and edited the description (208b711)

• docs(website): Update some website guides (7f58c1a)

• docs(docker): Update readme (ade4c25)

Fix

• fix(hot_reload): remove old code (7fc2948)

v2.2.5 (2022-12-17)

Documentation

• docs(docker): Update readme (33e050d)

• docs(docker): Update docker to use build script (c3b7bd1)

Fix

• fix(docker): separate out build and run steps

This also updates the README with new relevant instructions.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (7393f1d)

Unknown

• doc(docker): add some documentation for the docker images

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (fbbb8bf)

v2.2.4 (2022-12-12)

Fix

• fix(docker): move apps.json creation into launcher section

The /deploy/setup directory won't necessarily exist at runtime, because it is optional if /deploy/server exists.

Thus, we should only create the apps.json file if we are performing one of the other build steps (all of which require the /deploy/server directory). It makes most sense to put this in the launcher section, since the launcher uses this.

However, we must create the apps.json file before activating the venv, because we have pyyaml in the root env, but not necessarily in the venv. Also, the launcher creation script only uses built-in libraries, so it can be moved before the venv as well.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (eeb4a88)

v2.2.3 (2022-12-11)

Documentation

• docs(selection): Update pv selection with clear and click (0d06739)

• docs(Style): Add global css style example (00fa606)

• docs(Selection): Add paraview remote rendering selection example (f9f6f7b)

• docs(readme): handle typos

Minor edits (12879f2)

• docs(examples): reformat using black (6fdc5a5)

• docs(markdown): Provide encoding at read time (2760bc2)

Fix

• fix(docker): add build.sh script for easier builds

Any arguments that you provide it get put into TRAME_BUILD, so you can add arguments like no_www or venv.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (26effc0)

• fix(docker): add ability to replace USE_HOST

If a TRAME_USE_HOST environment variable is defined, then this will replace USE_HOST in the final copy of the launcher json file.

If TRAME_USE_HOST contains ://, then this will replace ws://USE_HOST instead.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (3cd4dc3)

• fix(docker): add additional build options

This allows the user to separate out building the venv, launcher, and www.

The default behavior is that all will build if they do not exist. If they do exist, then they will not be built.

However, the user can now select some options via a TRAME_BUILD environment variable. If this string contains (single or any combination of) "venv", "launcher", or "www", then those respective parts will be re-built, even if they already exist.

Additionally, a "no_www" can be specified in the TRAME_BUILD environment variable, which indicates to skip the www generation, even if it does not exist.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (8ad6f44)

v2.2.2 (2022-12-02)

Documentation

• docs(examples): Fix typo in vtkClass arg (4822ad3)

• docs(video): Add video on landing page (76926cf)

• docs(video): Add video on landing page (168a3c9)

• docs(menu): Update doc menu (89ee007)

• docs(readme): remove the --pre in pip install command (dc01c70)

• docs(deploy): Add a deployment section (2b5e122)

• docs(caprover): add info for caprover deploy (ea6fec4)

• docs(docker): Add single file example (18fa307)

• docs(website): correct tutorial code examples (eb4a628)

• docs(fileUpload): add validation example (9c81ea9)

• docs(example): switch view validation (662c5cb)

Fix

• fix(docker): add wheel to pip docker image

Pip is now deprecating installation via the older install method that does not use wheel. This deprecation message is now displaying, and it appears that in a version of pip soon, we may start seeing errors.

Add wheel to the trame docker image to keep the installation process simple for users (so that they will not be required to install wheel themselves or create a pyproject.toml file).

See: pypa/pip#8559

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (6f34a4e)

Unknown

• Merge pull request #140 from willdunklin/tutorial-html-fix

docs(website): Correct tutorial code examples (f220edd)

v2.2.1 (2022-10-21)

Documentation

• docs(example): add stats to pv/wavelet example (c257a54)

• docs(example): collaboration state async/busy update (792dd28)

• docs(course): expanded and polished description of course (cc4e0ac)

• docs(wavelet): add sc demo comparison (f9d5e36)

• docs(wavelet): add sc demo comparison (def850b)

• docs(course): update links of documents (73bb2e7)

• docs(course): Add links to the course (4f79912)

• docs(vtk): Rename trame.widgets.vtk to not confuse with vtk import

fix #127 (b480332)

• docs(FiniteElementAnalysis): fix file chunk handling (7790cd1)

• docs(SurfacePicking): add jupyter helper function (76e6c8b)

• docs(download): Add binary download example (af70938)

• docs(examples): Multi-server example (78008d9)

• docs(paraview): Add info for using conda (5e1160d)

• docs(tutorial): fix typo in example (77b3a1b)

Fix

• fix(rca): add trame-rca in default dependencies (7fa2253)

Unknown

• Merge pull request #132 from wschroed/CourseTweaks

docs(course): expanded and polished description of course (a6659c9)

• Merge pull request #125 from DavidBerger98/multi-server-example

docs(examples): Multi-server example (7c0d21b)

• Merge pull request #118 from cjh1/typo

Fix syntax error (12ea4fb)

v2.2.0 (2022-08-29)

Documentation

• docs(website): Fix spacing (7073f5a)

Feature

• feat(ClientFile): Add helper to handle multi-part upload file (d00907f)

v2.1.2 (2022-08-24)

Chore

• chore(ignore): remove test directory (3967b9c)

• chore(semantic-release): bump version to latest

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (3718950)

Documentation

• docs(examples): add validation examples (8a7e1ca)

• docs(api): Update client side API (738565f)

• docs(reverse-stop): test client to ask server to stop (1877a46)

• docs(relay): Add reverse connection and relay scenario (7cbfbf4)

• docs(example): add validation for download with promise (51ad010)

• docs(examples): ensure file browser appears in front

This is particularly an issue on Windows. Add the line that is necessary to place the dialog in front.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (ef1a869)

• docs(examples): add tkinter file browser example

This adds an example that uses tkinter for the selection of a directory.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (190b37d)

• docs(coverage): remove codecov PR comment

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (49065a0)

• docs(website): Improve language and grammar (6959dc8)

• docs(coverage): add .coveragerc

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (41c4d62)

• docs(ci): add coverage and codecov upload

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (e6f3181)

• docs(readme): add CI badge

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (c07b0d2)

• docs(readme): fix invalid path for pict (97b4a3c)

Fix

• fix(simput): add simput as default dependency (b6ca24c)

Unknown

• Merge pull request #81 from wschroed/Doc-updates

Documentation updates (44d44fc)

v2.1.1 (2022-06-15)

Documentation

• docs(example): Fix SimpleCone/RemoteRendering (498fd78)

• docs(contributing): add CONTRIBUTING.rst

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (9e51275)

Fix

• fix(mimetypes): ensure javascript files get the correct mimetype

On Windows, the mimetypes are obtained from the registry. However, the mimetype for javascript files is broken. Add some code to ensure that javascript files are identified correctly.

This also adds some infrastructure for adding extra mimetypes that persist even if mimetypes.init() is called.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (40a9618)

Unknown

• Merge pull request #78 from Kitware/javascript-mimetypes

Ensure javascript files get the correct mimetype (62b9e90)

v2.1.0 (2022-06-04)

Chore

• chore(pre-commit): fix format issue (0224fb5)

Ci

• ci(docker): make app key optional with cmd (9d73f24)

• ci(docker): make apps.yaml/name/app optional (45b8cc5)

• ci(docker): fix launcher generator script (51fe646)

• ci(docker): fix www generator for app.html name (6c99fc6)

• ci(docker): Add custom www module + app.html (95d1ef9)

Documentation

• docs(welcome): Update note (cee6461)

• docs(intro): Remove --pre from pip install command (f748dd6)

Feature

• feat(ui): Add virtual node ui manager with server (6956009)

Style

• style(black): fix indentation (a4977db)

v2.0.1 (2022-05-31)

Chore

• chore(commitlint): only run commitlint on PR

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (5ed2b65)

• chore(commitlint): fix commitlint in CI

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (c35973c)

• chore(fix): fix codespell issues

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (1696a9a)

• chore(flake8): fix flake8 issues

Jupyter also had an issue with the all statement that was fixed.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (a66127c)

• chore(black): run black on source code

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (ea45740)

• chore(tools): List possible tools to be added (95a8356)

• chore(tools): List possible tools to be added (6309364)

• chore(docker): Update scripts to use v2 www tools (361c976)

Ci

• ci(actions): removed semantic-release (f176c4c)

• ci(actions): Bring back some basic actions (fe6d329)

Documentation

• docs(content): Fix doc wording

It seemed like "change" was referenced too many times in the same sentence. (490196e)

• docs(example): Fix RemoteSelection for trame v2 (4c2ba6d)

• docs(api): Add missing information (32a9a4a)

• docs(api): Adding more api doc (0c9948d)

• docs(api): Adding more api doc (a78df91)

• docs(rtd): Update wwww (13258ad)

• docs(migration): Add widgets.html info (4e57496)

• docs(example): add link to v1-v2 delta (b28723d)

• docs(example): add missing v2 migration (7b3cda7)

• docs(website): update landing page (faba163)

• docs(examples): Add ref to v1 + delta (c9bc9dc)

• docs(website): update content to match new api (5f55d6a)

• docs(examples): update and cleanup examples for v2 (e8ad216)

Fix

• fix(CI): add initial CI with semantic-release

This adds initial CI for trame 2.0, which includes a pre-commit (that currently uses black, codespell, and flake8), some simple tests, and automatically releasing a new version with semantic release (including a push to PyPI).

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (a881ffb)

• fix(tools.app): Add tool to create html app (d8c11e6)

• fix(jupyter): Proper server.start() call (e67625e)

• fix(tools/www): Make it server independent (1d7ad31)

Unknown

• Merge pull request #73 from psavery/initial-ci

Add Trame 2.0 initial CI with semantic-release (906a37c)

• Merge pull request #72 from Purg/patch-1

Adjust doc wording (8fe7cc9)

• Add ControllerFunction docs

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (60440ab)

• Fix properties on same line by adding css file

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (24cf510)

• Add core classes to side bar

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (0cb9305)

• Do not expose Server in trame.app

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (7887c96)

• Show AbstractElement base class, not HtmlElement

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (0527f0f)

• Add mpld3 as a mock import

This will just avoid printing the warning that it was not imported.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (0e18350)

• Exclude the env/utils.py file

This also provides an example for how to exclude files

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (37f2783)

• Show inheritance of classes in docs

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (e56adbd)

• Allow sphinx to import trame.env.paraview

This adds an environment variable that allows the module to fail importing silently. This environment variable is set when running sphinx.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (83b74e6)

• Add first pass at new API docs for V2

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (66f547b)

• Add all to a few files

This indicates what should be exposed by them.

This will be used by the docs in particular.

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (a00264c)

• Add env directory from trame v1

Signed-off-by: Patrick Avery <patrick.avery@kitware.com> (89d4149)

• trame a framework to write ubiquitous applications in Python

Version 2.0 is a rewrite of trame 1.x. It keeps the idea behind trame while normalizing its API and enabling a wider extensability. This new version open another set of doors while renforcing the strength of the trame core.

BREAKING CHANGE: The API between v1 and v2 are not compatible but the migration should remain straight forward

Co-authored-by: Patrick Avery <patrick.avery@kitware.com> (0e44015)