Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AUTHORS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This is the list of Visor's significant contributors.
# This is the list of VISOR's significant contributors.
#
# This file does not necessarily list everyone who has contributed code.
#
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
Overall guidance on contributing to a PyAnsys library appears in the
[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
are thoroughly familiar with this guide before attempting to contribute to
Visor.
VISOR.

The following contribution information is specific to Visor.
The following contribution information is specific to VISOR.

Additional information can be found in the
[Visor Contributing](https://vigilant-lamp-162kw9z.pages.github.io/version/dev/contributing/index.html)
[VISOR Contributing](https://vigilant-lamp-162kw9z.pages.github.io/version/dev/contributing/index.html)
documentation.

[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
Expand Down
44 changes: 22 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

Visor
VISOR
=====

|pyansys|
Expand All @@ -16,15 +16,15 @@ Demo
----

You can view a `demo <https://visor.dev.ansysapis.com/index.html>`_ of
Visor to see it in action.
VISOR to see it in action.


Overview
--------

Visor is a Python-based 3D visualization web component.
VISOR is a Python-based 3D visualization web component.

You can use Visor to integrate with the following tools:
You can use VISOR to integrate with the following tools:

* `SAF (Solution Application Framework) <https://upgraded-carnival-wn6lkym.pages.github.io>`_
to provide 3D visualization capabilities.
Expand All @@ -33,70 +33,70 @@ You can use Visor to integrate with the following tools:
* `PyAnsys Visualization Interface Tool <https://visualization-interface.tools.docs.pyansys.com/>`_
to connect PyAnsys libraries to different plotting backends.

You can use Visor for 3D visualization on desktop and on premises. Visor customizes existing
You can use VISOR for 3D visualization on desktop and on premises. VISOR customizes existing
rendering frameworks to meet functional and nonfunctional requirements, including integrability,
scalability, performance, and usability for solution apps.

You run Visor with VTK (Visual Toolkit) rendering and Trame to support a client-server architecture and Python integration
You run VISOR with VTK (Visual Toolkit) rendering and Trame to support a client-server architecture and Python integration
workflows. You target VTK WASM with WebGL because WebGPU support is not yet available.


Installation
------------

To set up prerequisites and install Visor, see
To set up prerequisites and install VISOR, see
`Getting started <https://vigilant-lamp-162kw9z.pages.github.io/version/dev/getting_started/index.html>`_
in the Visor documentation.
in the VISOR documentation.


Quick start
-----------

For a basic usage example, see
`Quick start <https://vigilant-lamp-162kw9z.pages.github.io/version/dev/getting_started/quick_start.html>`_
in the Visor documentation.
in the VISOR documentation.


Development
-----------

To set up your development environment, see the `Contributing.md <Contributing.md>`_ file in the
Visor repository.
VISOR repository.


Usage
-----

You can use Visor through the following entry points. Links are to the relevant information in he
Visor documentation.
You can use VISOR through the following entry points. Links are to the relevant information in he
VISOR documentation.

* **Standalone Python**

* Launch a desktop Visor app with the Python package ``ansys.visor.viewer`` to visualize files.
* See `Visor Python API <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/launching_visor/visor_python_api.html>`_
* Launch a desktop VISOR app with the Python package ``ansys.visor.viewer`` to visualize files.
* See `VISOR Python API <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/launching_visor/visor_python_api.html>`_
for API usage examples.
* See `API reference <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/python_api_reference.html>`_
for details about the Python API.

* **Visor HTTP service**
* **VISOR HTTP service**

* Manage multiple Visor instances through the Visor HTTP API.
* Manage multiple VISOR instances through the VISOR HTTP API.
* Integrate with `PIM (Product Instance Management) <https://github.com/ansys/ansys-api-platform-instancemanagement>`_
to manage Visor instances in SAF apps.
* See `Visor HTTP service <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/launching_visor/visor_service.html>`_
to manage VISOR instances in SAF apps.
* See `VISOR HTTP service <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/launching_visor/visor_service.html>`_
for usage examples.
* See `HTTP API reference <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/http_api_reference/index.html>`_
for API details.

* **Dash frontend app**

* Connect to a Visor instance from a Dash app with the Visor Dash component in
* 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 <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/launching_visor/visor_dash_component.html>`_
* See `VISOR Dash component <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/launching_visor/visor_dash_component.html>`_
for details.

For advanced usage and configuration options, see the following Visor documentation:
For advanced usage and configuration options, see the following VISOR documentation:

`User guide <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/index.html>`_ and
`Examples <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/examples/index.html>`_ in the
Visor sections.
VISOR sections.
6 changes: 3 additions & 3 deletions deploy/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Running Visor in a Docker Container
# Running VISOR in a Docker Container

The Visor project contains Docker configurations for both development and release environments.
The VISOR project contains Docker configurations for both development and release environments.

For each environment, there is a Dockerfile and docker-compose.yml to enable containerizing the FastAPI service,
including its frontend and backend. The Docker configurations are located in the `deploy/docker/dev` directory for development
Expand Down Expand Up @@ -60,7 +60,7 @@ Docker compose uses the `docker-compose.yml` file to build and run the container
which simplifies the process by managing the configuration and dependencies in a
single file.

The docker-compose.yml file is located in the root of the Visor project directory.
The docker-compose.yml file is located in the root of the VISOR project directory.

#### i. Build the image and run the container

Expand Down
1 change: 1 addition & 0 deletions doc/changelog.d/39.documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Capitalize project name in documentation
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ build-system-version = "1.7.0"
[tool.poetry]
name = "ansys-visor-viewer"
version = "1.0.0_beta"
description = "\"Visor 3D visualization web component framework\""
authors = ["Visor Team <visor@ansys.com>"]
description = "\"VISOR 3D visualization web component framework\""
authors = ["VISOR Team <visor@ansys.com>"]
readme = "README.rst"
license = "Ansys License"
repository = "https://github.com/ansys/visor"
Expand Down
6 changes: 3 additions & 3 deletions tools/awc_icon_generator/AWC-FONTS-ICONS-README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ In order to make use of AWC fonts and icons without installing the entire AWC Re
- The default AWC UI font (Source Sans 3) and its corresponding CSS font-family stack
- AWC icon SVGs

Lastly, due to the large number of AWC icon SVG files, there was a need for automating the creation of a JavaScript AWC icon library based on a given list of icon names. This automation resulted in the `awc-icon-generator.html` file found in the Visor repository.
Lastly, due to the large number of AWC icon SVG files, there was a need for automating the creation of a JavaScript AWC icon library based on a given list of icon names. This automation resulted in the `awc-icon-generator.html` file found in the VISOR repository.

The following sections elaborate on obtaining the AWC font and its font stack, as well as the design behind the `awc-icon-generator.html` file found in the Visor repository.
The following sections elaborate on obtaining the AWC font and its font stack, as well as the design behind the `awc-icon-generator.html` file found in the VISOR repository.

## Default AWC UI Font

Expand Down Expand Up @@ -78,6 +78,6 @@ Traditionally, when websites used icon packs, the website would deploy a single

Since we wanted to use these AWC icons without installing the AWC package, we needed to download all the SVGs and serve them locally. This way, if the icon URLs became obsolete, it would not affect our application.

Visor inserts AWC icons into React components (or anywhere in JavaScript for that matter) by making use of a dynamically-created `AwcIcons.js` file. This JavaScript library is created by the `awc-icon-generator.html` page, which can actually be run independent of Visor.
VISOR inserts AWC icons into React components (or anywhere in JavaScript for that matter) by making use of a dynamically-created `AwcIcons.js` file. This JavaScript library is created by the `awc-icon-generator.html` page, which can actually be run independent of VISOR.

The `awc-icon-generator.html` page generates JavaScript inside a &lt;textarea&gt; input, that can be copy-pasted into the `AwcIcons.js` file any time AWC updates its icon collection.
2 changes: 1 addition & 1 deletion tools/awc_icon_generator/awc-icon-generator.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h1>AWC Icon Library Generator</h1>
This page loops through a list of AWC icon SVG file names, downloads each icon's SVG,<br/>
and dynamically builds a JavaScript object with methods that return each icon as an HTMLElement object.<br/><br/>
For information on using this JavaScript generator, either see the readme at<br/><br/>
<b>[Visor Project Root]\src\ansys\visor\visor-client\utils\tools\AWC-FONTS-ICONS-README.md</b><br/><br/>
<b>[VISOR Project Root]\src\ansys\visor\visor-client\utils\tools\AWC-FONTS-ICONS-README.md</b><br/><br/>
or see the GitHub discussion <a href="https://github.com/ansys-internal/theia/issues/231">here</a>.
</div>
<div style="margin-top:20px;">
Expand Down
Loading