diff --git a/AUTHORS b/AUTHORS index 2a3b3356..970d86fa 100644 --- a/AUTHORS +++ b/AUTHORS @@ -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. # diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5aab4f5d..b2732105 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.rst b/README.rst index 71d5628b..465149dc 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -Visor +VISOR ===== |pyansys| @@ -16,15 +16,15 @@ Demo ---- You can view a `demo `_ 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) `_ to provide 3D visualization capabilities. @@ -33,20 +33,20 @@ You can use Visor to integrate with the following tools: * `PyAnsys Visualization Interface Tool `_ 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 `_ -in the Visor documentation. +in the VISOR documentation. Quick start @@ -54,49 +54,49 @@ Quick start For a basic usage example, see `Quick start `_ -in the Visor documentation. +in the VISOR documentation. Development ----------- To set up your development environment, see the `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 `_ + * Launch a desktop VISOR app with the Python package ``ansys.visor.viewer`` to visualize files. + * See `VISOR Python API `_ for API usage examples. * See `API reference `_ 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) `_ - to manage Visor instances in SAF apps. - * See `Visor HTTP service `_ + to manage VISOR instances in SAF apps. + * See `VISOR HTTP service `_ for usage examples. * 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 + * 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: +For advanced usage and configuration options, see the following VISOR documentation: `User guide `_ and `Examples `_ in the -Visor sections. +VISOR sections. diff --git a/deploy/docker/README.md b/deploy/docker/README.md index 41753445..1786957c 100644 --- a/deploy/docker/README.md +++ b/deploy/docker/README.md @@ -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 @@ -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 diff --git a/doc/changelog.d/39.documentation.md b/doc/changelog.d/39.documentation.md new file mode 100644 index 00000000..bfb5569f --- /dev/null +++ b/doc/changelog.d/39.documentation.md @@ -0,0 +1 @@ +Capitalize project name in documentation diff --git a/pyproject.toml b/pyproject.toml index 2c9cc03c..a25aac64 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 "] +description = "\"VISOR 3D visualization web component framework\"" +authors = ["VISOR Team "] readme = "README.rst" license = "Ansys License" repository = "https://github.com/ansys/visor" diff --git a/tools/awc_icon_generator/AWC-FONTS-ICONS-README.md b/tools/awc_icon_generator/AWC-FONTS-ICONS-README.md index daeabba6..69420972 100644 --- a/tools/awc_icon_generator/AWC-FONTS-ICONS-README.md +++ b/tools/awc_icon_generator/AWC-FONTS-ICONS-README.md @@ -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 @@ -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 <textarea> input, that can be copy-pasted into the `AwcIcons.js` file any time AWC updates its icon collection. \ No newline at end of file diff --git a/tools/awc_icon_generator/awc-icon-generator.html b/tools/awc_icon_generator/awc-icon-generator.html index 1746a3ce..d6228bd9 100644 --- a/tools/awc_icon_generator/awc-icon-generator.html +++ b/tools/awc_icon_generator/awc-icon-generator.html @@ -65,7 +65,7 @@

AWC Icon Library Generator

This page loops through a list of AWC icon SVG file names, downloads each icon's SVG,
and dynamically builds a JavaScript object with methods that return each icon as an HTMLElement object.

For information on using this JavaScript generator, either see the readme at

- [Visor Project Root]\src\ansys\visor\visor-client\utils\tools\AWC-FONTS-ICONS-README.md

+ [VISOR Project Root]\src\ansys\visor\visor-client\utils\tools\AWC-FONTS-ICONS-README.md

or see the GitHub discussion here.