From e75ecd11a60869c525ea5c65634e603ec020a342 Mon Sep 17 00:00:00 2001 From: Laura Kasian Date: Tue, 25 Aug 2026 10:45:39 -0700 Subject: [PATCH 1/4] clean up changelog files from internal repo as irrelevant --- doc/changelog.d/1192.test.md | 1 - doc/changelog.d/1195.documentation.md | 1 - doc/changelog.d/1196.maintenance.md | 1 - doc/changelog.d/1199.test.md | 1 - doc/changelog.d/1200.miscellaneous.md | 1 - doc/changelog.d/1204.miscellaneous.md | 1 - doc/changelog.d/1216.maintenance.md | 1 - doc/changelog.d/1217.miscellaneous.md | 1 - doc/changelog.d/1218.added.md | 1 - doc/changelog.d/1234.added.md | 1 - doc/changelog.d/1236.maintenance.md | 1 - doc/changelog.d/1237.maintenance.md | 1 - doc/changelog.d/1238.documentation.md | 1 - doc/changelog.d/1239.maintenance.md | 1 - doc/changelog.d/1240.maintenance.md | 1 - doc/changelog.d/1243.documentation.md | 1 - doc/changelog.d/1244.added.md | 1 - doc/changelog.d/1245.test.md | 1 - doc/changelog.d/1249.added.md | 1 - doc/changelog.d/1253.added.md | 1 - doc/changelog.d/1254.documentation.md | 1 - doc/changelog.d/1256.maintenance.md | 1 - doc/changelog.d/1259.maintenance.md | 1 - doc/changelog.d/1268.maintenance.md | 1 - doc/changelog.d/1275.maintenance.md | 1 - doc/changelog.d/1285.fixed.md | 1 - doc/changelog.d/1286.maintenance.md | 1 - doc/changelog.d/1287.maintenance.md | 1 - doc/changelog.d/1290.fixed.md | 1 - doc/changelog.d/1291.maintenance.md | 1 - doc/changelog.d/1293.maintenance.md | 1 - doc/changelog.d/1296.miscellaneous.md | 1 - doc/changelog.d/1297.documentation.md | 1 - doc/changelog.d/1298.miscellaneous.md | 1 - doc/changelog.d/1299.miscellaneous.md | 1 - doc/changelog.d/1300.miscellaneous.md | 1 - doc/changelog.d/1304.fixed.md | 1 - 37 files changed, 37 deletions(-) delete mode 100644 doc/changelog.d/1192.test.md delete mode 100644 doc/changelog.d/1195.documentation.md delete mode 100644 doc/changelog.d/1196.maintenance.md delete mode 100644 doc/changelog.d/1199.test.md delete mode 100644 doc/changelog.d/1200.miscellaneous.md delete mode 100644 doc/changelog.d/1204.miscellaneous.md delete mode 100644 doc/changelog.d/1216.maintenance.md delete mode 100644 doc/changelog.d/1217.miscellaneous.md delete mode 100644 doc/changelog.d/1218.added.md delete mode 100644 doc/changelog.d/1234.added.md delete mode 100644 doc/changelog.d/1236.maintenance.md delete mode 100644 doc/changelog.d/1237.maintenance.md delete mode 100644 doc/changelog.d/1238.documentation.md delete mode 100644 doc/changelog.d/1239.maintenance.md delete mode 100644 doc/changelog.d/1240.maintenance.md delete mode 100644 doc/changelog.d/1243.documentation.md delete mode 100644 doc/changelog.d/1244.added.md delete mode 100644 doc/changelog.d/1245.test.md delete mode 100644 doc/changelog.d/1249.added.md delete mode 100644 doc/changelog.d/1253.added.md delete mode 100644 doc/changelog.d/1254.documentation.md delete mode 100644 doc/changelog.d/1256.maintenance.md delete mode 100644 doc/changelog.d/1259.maintenance.md delete mode 100644 doc/changelog.d/1268.maintenance.md delete mode 100644 doc/changelog.d/1275.maintenance.md delete mode 100644 doc/changelog.d/1285.fixed.md delete mode 100644 doc/changelog.d/1286.maintenance.md delete mode 100644 doc/changelog.d/1287.maintenance.md delete mode 100644 doc/changelog.d/1290.fixed.md delete mode 100644 doc/changelog.d/1291.maintenance.md delete mode 100644 doc/changelog.d/1293.maintenance.md delete mode 100644 doc/changelog.d/1296.miscellaneous.md delete mode 100644 doc/changelog.d/1297.documentation.md delete mode 100644 doc/changelog.d/1298.miscellaneous.md delete mode 100644 doc/changelog.d/1299.miscellaneous.md delete mode 100644 doc/changelog.d/1300.miscellaneous.md delete mode 100644 doc/changelog.d/1304.fixed.md diff --git a/doc/changelog.d/1192.test.md b/doc/changelog.d/1192.test.md deleted file mode 100644 index 9a84562a..00000000 --- a/doc/changelog.d/1192.test.md +++ /dev/null @@ -1 +0,0 @@ -Test/sfernand/save_load_state diff --git a/doc/changelog.d/1195.documentation.md b/doc/changelog.d/1195.documentation.md deleted file mode 100644 index 1556f5b0..00000000 --- a/doc/changelog.d/1195.documentation.md +++ /dev/null @@ -1 +0,0 @@ -Remote rendering ADR diff --git a/doc/changelog.d/1196.maintenance.md b/doc/changelog.d/1196.maintenance.md deleted file mode 100644 index 6fa5ad7a..00000000 --- a/doc/changelog.d/1196.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Changelog creation diff --git a/doc/changelog.d/1199.test.md b/doc/changelog.d/1199.test.md deleted file mode 100644 index cb9e3608..00000000 --- a/doc/changelog.d/1199.test.md +++ /dev/null @@ -1 +0,0 @@ -Test/sfernand/add jest to cicd diff --git a/doc/changelog.d/1200.miscellaneous.md b/doc/changelog.d/1200.miscellaneous.md deleted file mode 100644 index 35f3d041..00000000 --- a/doc/changelog.d/1200.miscellaneous.md +++ /dev/null @@ -1 +0,0 @@ -Remote rendering 1.1 - split scene from pipeline diff --git a/doc/changelog.d/1204.miscellaneous.md b/doc/changelog.d/1204.miscellaneous.md deleted file mode 100644 index f9e37dc2..00000000 --- a/doc/changelog.d/1204.miscellaneous.md +++ /dev/null @@ -1 +0,0 @@ -Remote rendering 1.2 - add iRenderer and LocalRenderer to backend diff --git a/doc/changelog.d/1216.maintenance.md b/doc/changelog.d/1216.maintenance.md deleted file mode 100644 index eca85aa4..00000000 --- a/doc/changelog.d/1216.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Update changelog version diff --git a/doc/changelog.d/1217.miscellaneous.md b/doc/changelog.d/1217.miscellaneous.md deleted file mode 100644 index bbcbe62e..00000000 --- a/doc/changelog.d/1217.miscellaneous.md +++ /dev/null @@ -1 +0,0 @@ -Remote rendering 1.2b - make TheiaSceneBase abstract and create TheiaLocalScene subclass diff --git a/doc/changelog.d/1218.added.md b/doc/changelog.d/1218.added.md deleted file mode 100644 index 687be596..00000000 --- a/doc/changelog.d/1218.added.md +++ /dev/null @@ -1 +0,0 @@ -Add ability to scan for free port in initialize/ diff --git a/doc/changelog.d/1234.added.md b/doc/changelog.d/1234.added.md deleted file mode 100644 index dfa14af0..00000000 --- a/doc/changelog.d/1234.added.md +++ /dev/null @@ -1 +0,0 @@ -Remote rendering 1.3 - add RenderingMode enum to dispatch LOCAL (VTK.wasm) mode diff --git a/doc/changelog.d/1236.maintenance.md b/doc/changelog.d/1236.maintenance.md deleted file mode 100644 index 01f226c9..00000000 --- a/doc/changelog.d/1236.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Ruff N-rule compliance first pass: Python naming to snake_case diff --git a/doc/changelog.d/1237.maintenance.md b/doc/changelog.d/1237.maintenance.md deleted file mode 100644 index ed2eb1c0..00000000 --- a/doc/changelog.d/1237.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Ruff N-rule compliance second pass: Test fixes diff --git a/doc/changelog.d/1238.documentation.md b/doc/changelog.d/1238.documentation.md deleted file mode 100644 index 429d07c3..00000000 --- a/doc/changelog.d/1238.documentation.md +++ /dev/null @@ -1 +0,0 @@ -Overall review for public release diff --git a/doc/changelog.d/1239.maintenance.md b/doc/changelog.d/1239.maintenance.md deleted file mode 100644 index 90604a7c..00000000 --- a/doc/changelog.d/1239.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Enable Ruff N-rule and final pass for python style compliance diff --git a/doc/changelog.d/1240.maintenance.md b/doc/changelog.d/1240.maintenance.md deleted file mode 100644 index 4fe6c2d0..00000000 --- a/doc/changelog.d/1240.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Bump fast-uri to 3.1.5 per CVE-2026-18446 diff --git a/doc/changelog.d/1243.documentation.md b/doc/changelog.d/1243.documentation.md deleted file mode 100644 index 13de99a1..00000000 --- a/doc/changelog.d/1243.documentation.md +++ /dev/null @@ -1 +0,0 @@ -Overall documentation review followup items diff --git a/doc/changelog.d/1244.added.md b/doc/changelog.d/1244.added.md deleted file mode 100644 index 3eaed761..00000000 --- a/doc/changelog.d/1244.added.md +++ /dev/null @@ -1 +0,0 @@ -Separate bind host from public host diff --git a/doc/changelog.d/1245.test.md b/doc/changelog.d/1245.test.md deleted file mode 100644 index e84bdc88..00000000 --- a/doc/changelog.d/1245.test.md +++ /dev/null @@ -1 +0,0 @@ -Test/sfernand/saf theia smoke diff --git a/doc/changelog.d/1249.added.md b/doc/changelog.d/1249.added.md deleted file mode 100644 index 5666a75a..00000000 --- a/doc/changelog.d/1249.added.md +++ /dev/null @@ -1 +0,0 @@ -Remote rendering 2.1 - add frontend irenderer diff --git a/doc/changelog.d/1253.added.md b/doc/changelog.d/1253.added.md deleted file mode 100644 index 77058628..00000000 --- a/doc/changelog.d/1253.added.md +++ /dev/null @@ -1 +0,0 @@ -Remote rendering 2.2 - Use irenderer in scene graph diff --git a/doc/changelog.d/1254.documentation.md b/doc/changelog.d/1254.documentation.md deleted file mode 100644 index 5742f3b9..00000000 --- a/doc/changelog.d/1254.documentation.md +++ /dev/null @@ -1 +0,0 @@ -Fix two issues with contributing.md diff --git a/doc/changelog.d/1256.maintenance.md b/doc/changelog.d/1256.maintenance.md deleted file mode 100644 index b3436137..00000000 --- a/doc/changelog.d/1256.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Remove arrayIndex and enable selection by spectrumName diff --git a/doc/changelog.d/1259.maintenance.md b/doc/changelog.d/1259.maintenance.md deleted file mode 100644 index 2be766d0..00000000 --- a/doc/changelog.d/1259.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Rename 'theia' to 'theia' in backend diff --git a/doc/changelog.d/1268.maintenance.md b/doc/changelog.d/1268.maintenance.md deleted file mode 100644 index f6043aa9..00000000 --- a/doc/changelog.d/1268.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Fix dash snapshot diff --git a/doc/changelog.d/1275.maintenance.md b/doc/changelog.d/1275.maintenance.md deleted file mode 100644 index 9cbb6e1e..00000000 --- a/doc/changelog.d/1275.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Address Pydantic and FastAPI deprecation warnings diff --git a/doc/changelog.d/1285.fixed.md b/doc/changelog.d/1285.fixed.md deleted file mode 100644 index c93290b3..00000000 --- a/doc/changelog.d/1285.fixed.md +++ /dev/null @@ -1 +0,0 @@ -Cell data selection method diff --git a/doc/changelog.d/1286.maintenance.md b/doc/changelog.d/1286.maintenance.md deleted file mode 100644 index 4f4dae51..00000000 --- a/doc/changelog.d/1286.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Rename 'theia' to 'theia' in frontend diff --git a/doc/changelog.d/1287.maintenance.md b/doc/changelog.d/1287.maintenance.md deleted file mode 100644 index 537dae6b..00000000 --- a/doc/changelog.d/1287.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Standardize POINT/CELL field association across client and server diff --git a/doc/changelog.d/1290.fixed.md b/doc/changelog.d/1290.fixed.md deleted file mode 100644 index 8aeaf5b4..00000000 --- a/doc/changelog.d/1290.fixed.md +++ /dev/null @@ -1 +0,0 @@ -Docker nightly diff --git a/doc/changelog.d/1291.maintenance.md b/doc/changelog.d/1291.maintenance.md deleted file mode 100644 index eac28c4a..00000000 --- a/doc/changelog.d/1291.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Rename 'theia' to 'visor' in documentation diff --git a/doc/changelog.d/1293.maintenance.md b/doc/changelog.d/1293.maintenance.md deleted file mode 100644 index 91342592..00000000 --- a/doc/changelog.d/1293.maintenance.md +++ /dev/null @@ -1 +0,0 @@ -Bump package version to 1.0.5_beta diff --git a/doc/changelog.d/1296.miscellaneous.md b/doc/changelog.d/1296.miscellaneous.md deleted file mode 100644 index 54581b8f..00000000 --- a/doc/changelog.d/1296.miscellaneous.md +++ /dev/null @@ -1 +0,0 @@ -[Remote rendering 3.0a] introduce the renderer annotation and build scene details from it diff --git a/doc/changelog.d/1297.documentation.md b/doc/changelog.d/1297.documentation.md deleted file mode 100644 index ba98c801..00000000 --- a/doc/changelog.d/1297.documentation.md +++ /dev/null @@ -1 +0,0 @@ -Minor edits and fixed broken images (fixed PR) diff --git a/doc/changelog.d/1298.miscellaneous.md b/doc/changelog.d/1298.miscellaneous.md deleted file mode 100644 index 4a40da37..00000000 --- a/doc/changelog.d/1298.miscellaneous.md +++ /dev/null @@ -1 +0,0 @@ -[Remote rendering 3.0b] bind client to the new renderer annotation diff --git a/doc/changelog.d/1299.miscellaneous.md b/doc/changelog.d/1299.miscellaneous.md deleted file mode 100644 index 69ac2de0..00000000 --- a/doc/changelog.d/1299.miscellaneous.md +++ /dev/null @@ -1 +0,0 @@ -[Remote rendering 3.0c] remove legacy scene details fields and bump schema version to 2 diff --git a/doc/changelog.d/1300.miscellaneous.md b/doc/changelog.d/1300.miscellaneous.md deleted file mode 100644 index 4e82635e..00000000 --- a/doc/changelog.d/1300.miscellaneous.md +++ /dev/null @@ -1 +0,0 @@ -[Remote rendering 3.0d] type the variable field association diff --git a/doc/changelog.d/1304.fixed.md b/doc/changelog.d/1304.fixed.md deleted file mode 100644 index 9b9dda76..00000000 --- a/doc/changelog.d/1304.fixed.md +++ /dev/null @@ -1 +0,0 @@ -Add pointerEvents: none to invisible wrapper div From 161cb785568a2bf0b1019fb99a849c9b42f8ddee Mon Sep 17 00:00:00 2001 From: Laura Kasian Date: Tue, 25 Aug 2026 11:02:09 -0700 Subject: [PATCH 2/4] update links to reflect new repository and documentation url --- README.rst | 14 +++++++------- .../adrs/02-visor-technology-components.md | 2 +- doc/developer_docs/adrs/14-save-load-state.md | 5 +++-- .../adrs/15-ansys-product-support.md | 3 ++- .../adrs/16-visor-saf-integration.md | 4 ++-- doc/source/getting_started/configure_visor.rst | 2 +- doc/source/index.rst | 2 +- doc/source/user_guide/launching_visor/metadata.rst | 2 +- tests/e2e/regressions/test_update_variables.py | 2 +- 9 files changed, 19 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index 7fa6ac28..71d5628b 100644 --- a/README.rst +++ b/README.rst @@ -73,9 +73,9 @@ Visor documentation. * **Standalone Python** * Launch a desktop Visor app with the Python package ``ansys.visor.viewer`` to visualize files. - * See `Visor Python API `_ + * See `Visor Python API `_ for API usage examples. - * See `API reference `_ + * See `API reference `_ for details about the Python API. * **Visor HTTP service** @@ -83,20 +83,20 @@ Visor documentation. * Manage multiple Visor instances through the Visor HTTP API. * Integrate with `PIM (Product Instance Management) `_ to manage Visor instances in SAF apps. - * See `Visor HTTP service `_ + * See `Visor HTTP service `_ for usage examples. - * See `HTTP API reference `_ + * See `HTTP API reference `_ for API details. * **Dash frontend app** * Connect to a Visor instance from a Dash app with the Visor Dash component in ``ansys.visor.dash.dash_visor_viewer``. - * See `Visor Dash component `_ + * See `Visor Dash component `_ for details. For advanced usage and configuration options, see the following Visor documentation: -`User guide `_ and -`Examples `_ in the +`User guide `_ and +`Examples `_ in the Visor sections. diff --git a/doc/developer_docs/adrs/02-visor-technology-components.md b/doc/developer_docs/adrs/02-visor-technology-components.md index d82c0f2d..76ffd55f 100644 --- a/doc/developer_docs/adrs/02-visor-technology-components.md +++ b/doc/developer_docs/adrs/02-visor-technology-components.md @@ -145,7 +145,7 @@ and better architecture in terms of streaming APIs and services for on-prem and ### Consequences -These [tenets](https://github.com/ansys-internal/theia/blob/tenets/adrs/01-theia-tenets.md) allow the project to change direction without transferring effort to the groups integrated with VISOR or at least with minimal effort. This means that the option decided now it doesn't have to be the only option going forward but it is going to necessitate engineering effort to add more targets or transition the project to a new visualization SDK or platform. The view of the project is to be itself a platform for visualization components for the Solutions Group and handle the engineering complexity of those components and integrating them in VISOR rather than pushing it to the Solutions Applications. This is also a matter of choosing vendor or making it possible to have different initial, running cost and maintenance cost for the different approaches as the deployment targets and the cost evaluation differs. +These [tenets](https://github.com/ansys/visor/blob/main/doc/developer_docs/adrs/01-visor-tenets.md) allow the project to change direction without transferring effort to the groups integrated with VISOR or at least with minimal effort. This means that the option decided now it doesn't have to be the only option going forward but it is going to necessitate engineering effort to add more targets or transition the project to a new visualization SDK or platform. The view of the project is to be itself a platform for visualization components for the Solutions Group and handle the engineering complexity of those components and integrating them in VISOR rather than pushing it to the Solutions Applications. This is also a matter of choosing vendor or making it possible to have different initial, running cost and maintenance cost for the different approaches as the deployment targets and the cost evaluation differs. The current target is to release in Q4 2024 a VISOR MVP version. The consequences per option are outlined in the following table: diff --git a/doc/developer_docs/adrs/14-save-load-state.md b/doc/developer_docs/adrs/14-save-load-state.md index baaa872d..08a6a748 100644 --- a/doc/developer_docs/adrs/14-save-load-state.md +++ b/doc/developer_docs/adrs/14-save-load-state.md @@ -224,7 +224,8 @@ diverge as requirements evolve. Note that as this will also require schema changes to the runtime data transfer object (DTO) that is sent from the backend to the frontend to initialize or update the viewer state. There is a -[separate ADR](https://github.com/ansys-internal/theia/blob/doc/adr-scene-description-1/developer_docs/adrs/13-scene-details.md) to align on this schema. (This ADR will be updated to reflect the final results of that discussion +[separate ADR](https://github.com/ansys/visor/blob/main/doc/developer_docs/adrs/13-scene-details.md) to align on this +schema. (This ADR will be updated to reflect the final results of that discussion once it is finalized.) ![VISOR State Model Diagram](../images/visor-state-model.png) @@ -266,7 +267,7 @@ At the time the save/load state feature was started, the state representation fo to the per-part dataset state (opacity only). For the runtime state at the client/server boundary, we maintain the schema definition in a -[separate ADR](https://github.com/ansys-internal/theia/blob/doc/adr-scene-description-1/developer_docs/adrs/13-scene-details.md). +[separate ADR](https://github.com/ansys/visor/blob/main/doc/developer_docs/adrs/13-scene-details.md). This schema is intended to evolve as we expand the state representation to include all components required to capture the viewer state for the save/load feature. diff --git a/doc/developer_docs/adrs/15-ansys-product-support.md b/doc/developer_docs/adrs/15-ansys-product-support.md index f8aa204b..f2f017c8 100644 --- a/doc/developer_docs/adrs/15-ansys-product-support.md +++ b/doc/developer_docs/adrs/15-ansys-product-support.md @@ -8,7 +8,8 @@ Team and Stakeholder Αpproved VISOR depends on legacy Ansys flagships to provide VTK format support and on PyAnsys APIs to enable those flagships to be used within Solutions Applications. These workflows improve maintainability and adoption by leveraging PyAnsys, which offers a specialized 3D viewer for examples and lowers the effort required for community users to access needed functionality. Each flagship product is responsible for converting its internal data to the common format. That format is aligned with SimAI requirements and maintained by the flagship teams, ensuring it stays optimized and in sync with the 3D viewer as products evolve. ## Context -Our requirements for legacy Ansys product support were based on the requirements for legacy Ansys products namely, Discovery, SpaceClaim, Fluent, Mechanical, AEDT suite and EnSight. Our prioritized requirements are for Fluent, GeometryService, but all legacy Ansys flagship products are included in the VISOR roadmap as well as Electronics Simulation Products. VISOR is a component which will be available within the Solution Architecture Framework and it is in VISOR's scope to be able to visualize the models and the data produced in those products. It is out of scope for VISOR to be doing transformations of the Ansys product formats to its internal representation. VISOR is using a scene graph described in the [08-scene-graph ADR](https://github.com/ansys-internal/theia/blob/c5ec3e366c8dbe385b5de520ddff10da7eaf6f78/docs/adrs/07-scene-graph.md). This scene description graph supports VTK format. +Our requirements for legacy Ansys product support were based on the requirements for legacy Ansys products namely, Discovery, SpaceClaim, Fluent, Mechanical, AEDT suite and EnSight. Our prioritized requirements are for Fluent, GeometryService, but all legacy Ansys flagship products are included in the VISOR roadmap as well as Electronics Simulation Products. VISOR is a component which will be available within the Solution Architecture Framework and it is in VISOR's scope to be able to visualize the models and the data produced in those products. It is out of scope for VISOR to be doing transformations of the Ansys product formats to its internal representation. VISOR is using a scene graph described in the +[08-scene-graph ADR](https://github.com/ansys/visor/blob/3fdbf4413c63d1c7c2b2ef62792a638f8d6f2b85/doc/developer_docs/adrs/07-scene-graph.md). This scene description graph supports VTK format. VISOR supports VTK-based formats (including VTKHDF), which is the requirement for supporting 3D data along with the mixed OpenUSD and VTK formats from the [architecture board decision #29](https://github.com/ansys-internal/architecture-decision-records/blob/main/content/docs/adrs/0029-visualization-formats.md). Based on that decision, all legacy Ansys products need to support the mixed OpenUSD and VTK format, and for VTK they should be providing VTKHDF. This decision is based on achieving a common visualization format which covers the current needs and the upcoming view regarding OpenUSD format. Considerations for the legacy Ansys common data model may impact some of the decisions here but those discussions will need to make sure to include the requirements and constraints of the VISOR 3D viewer. diff --git a/doc/developer_docs/adrs/16-visor-saf-integration.md b/doc/developer_docs/adrs/16-visor-saf-integration.md index e51a9f3b..2d42e501 100644 --- a/doc/developer_docs/adrs/16-visor-saf-integration.md +++ b/doc/developer_docs/adrs/16-visor-saf-integration.md @@ -5,7 +5,7 @@ Team approved ## Context -VISOR is aiming to be the Solutions' Applications 3D viewer and as such the primary platform that VISOR is going to be used is through Solutions Applications Framework (SAF). The tenets of the VISOR project can be found [here](https://github.com/ansys-internal/theia/blob/054999e0152720954dde2ef2596fc46b8a44133c/docs/adrs/01-theia-tenets.md). Solutions Applications are required to be able to target desktop, on-premise deployment and cloud deployment through integration with SAF, REP and CISL/Cloud Burst platforms. VISOR as a Solutions Applications viewer is scoped to be aiming to the requirements of the Solutions Applications and ACE stakeholders rather than being a standalone application and as such it needs to comply with the requirements the Solutions Applications group, the Architecture Hub and the ACE stakeholders are providing. VISOR is not responsible for Authentication or Authorization of users, or directly deployments or running a service but its responsible for making sure that all the requirements set will be able to be implemented in VISOR through its architecture. +VISOR is aiming to be the Solutions' Applications 3D viewer and as such the primary platform that VISOR is going to be used is through Solutions Applications Framework (SAF). The tenets of the VISOR project can be found [here](https://github.com/ansys/visor/blob/3fdbf4413c63d1c7c2b2ef62792a638f8d6f2b85/doc/developer_docs/adrs/01-visor-tenets.md). Solutions Applications are required to be able to target desktop, on-premise deployment and cloud deployment through integration with SAF, REP and CISL/Cloud Burst platforms. VISOR as a Solutions Applications viewer is scoped to be aiming to the requirements of the Solutions Applications and ACE stakeholders rather than being a standalone application and as such it needs to comply with the requirements the Solutions Applications group, the Architecture Hub and the ACE stakeholders are providing. VISOR is not responsible for Authentication or Authorization of users, or directly deployments or running a service but its responsible for making sure that all the requirements set will be able to be implemented in VISOR through its architecture. VISOR is targeting desktop, on-prem and cloud deployments. In terms of MVP, VISOR is targeting desktop deployment and it will iteratively target on-prem and cloud deployments as a component of the Solutions Applications Framework and not as a standalone service. @@ -41,7 +41,7 @@ VISOR is going to be using HPS for orchestrating on-premise and cloud deployment In order for VISOR to support multiple users or sessions it needs to be containerized and deployed through the HPS which will be creating new instances to scale VISOR based on the users or sessions which are necessary for smoothly running the on-premise deployment. #### VISOR client-side rendering -Based on the current technology components of VISOR described [here](https://github.com/ansys-internal/theia/blob/054999e0152720954dde2ef2596fc46b8a44133c/docs/adrs/02-theia-technology-components.md) it is using Trame VTK.WASM which is a client based rendering technology on the browser using VTK, Web assembly and OpenGL2.x and when its available WebGPU. This means that performance of VISOR is going to be impacted by network connectivity even though there is a websocket connecting directly to the client, it will still have the relative impact as there are models and data transferred to to the client. +Based on the current technology components of VISOR described [here](https://github.com/ansys/visor/blob/3fdbf4413c63d1c7c2b2ef62792a638f8d6f2b85/doc/developer_docs/adrs/02-visor-technology-components.md) it is using Trame VTK.WASM which is a client based rendering technology on the browser using VTK, Web assembly and OpenGL2.x and when its available WebGPU. This means that performance of VISOR is going to be impacted by network connectivity even though there is a websocket connecting directly to the client, it will still have the relative impact as there are models and data transferred to to the client. *Additional requirements:* * Kubernetes-based containerized version of VISOR diff --git a/doc/source/getting_started/configure_visor.rst b/doc/source/getting_started/configure_visor.rst index 71aadc3f..924b180d 100644 --- a/doc/source/getting_started/configure_visor.rst +++ b/doc/source/getting_started/configure_visor.rst @@ -45,7 +45,7 @@ Settings defaults ================= You can use a ``.visor`` file to override the following default values from the -`Settings class `_: +`Settings class `_: .. code-block:: yaml diff --git a/doc/source/index.rst b/doc/source/index.rst index fca7433d..75f8e59c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -36,7 +36,7 @@ You can use VISOR to integrate with the following tools: You run VISOR with VTK (Visual Toolkit) rendering through Trame for client-server architecture and Python integration workflows. You target VTK WASM with WebGL support. -View a `demo `_ to see VISOR in action. +View a `demo `_ to see VISOR in action. .. grid:: 2 :gutter: 4 diff --git a/doc/source/user_guide/launching_visor/metadata.rst b/doc/source/user_guide/launching_visor/metadata.rst index 143db494..c07b30df 100644 --- a/doc/source/user_guide/launching_visor/metadata.rst +++ b/doc/source/user_guide/launching_visor/metadata.rst @@ -149,7 +149,7 @@ Only the initial opacity is supported as a per-part property. Reference ~~~~~~~~~ -Reference: ``Metadata`` class (`source code `_). +Reference: ``Metadata`` class (`source code `_). .. literalinclude:: ../../../../src/ansys/visor/viewer/core/metadata.py :pyobject: Metadata diff --git a/tests/e2e/regressions/test_update_variables.py b/tests/e2e/regressions/test_update_variables.py index fc19b1da..cc1e34c2 100644 --- a/tests/e2e/regressions/test_update_variables.py +++ b/tests/e2e/regressions/test_update_variables.py @@ -43,7 +43,7 @@ def test_update_variables(visor_server, request): updates the variable values to constant values, and verifies the update took place. Test replicates example in documentation: - https://vigilant-lamp-162kw9z.pages.github.io/version/stable/examples/03-updating-theia-scene + https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/examples/03-updating-visor-scene """ visor = visor_server From 0552da389fefc1c516063e2c401a048362cdf515 Mon Sep 17 00:00:00 2001 From: Laura Kasian Date: Tue, 25 Aug 2026 11:04:38 -0700 Subject: [PATCH 3/4] fix visor github link --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6eba046f..2269b442 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,3 @@ -This project uses [towncrier](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in . +This project uses [towncrier](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in . \ No newline at end of file From ee36f0a552508608830a9d0c6f20fe57f1fc4f52 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Tue, 25 Aug 2026 18:13:28 +0000 Subject: [PATCH 4/4] chore: adding changelog file 9.maintenance.md [dependabot-skip] --- doc/changelog.d/9.maintenance.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/9.maintenance.md diff --git a/doc/changelog.d/9.maintenance.md b/doc/changelog.d/9.maintenance.md new file mode 100644 index 00000000..5770c6ae --- /dev/null +++ b/doc/changelog.d/9.maintenance.md @@ -0,0 +1 @@ +Clean up stale references to internal repo