Skip to content

Commit b54a6ee

Browse files
docs: Capitalize project name in documentation (#39)
Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
1 parent 96a15fa commit b54a6ee

8 files changed

Lines changed: 36 additions & 35 deletions

File tree

‎AUTHORS‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# This is the list of Visor's significant contributors.
1+
# This is the list of VISOR's significant contributors.
22
#
33
# This file does not necessarily list everyone who has contributed code.
44
#

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
Overall guidance on contributing to a PyAnsys library appears in the
44
[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
55
are thoroughly familiar with this guide before attempting to contribute to
6-
Visor.
6+
VISOR.
77

8-
The following contribution information is specific to Visor.
8+
The following contribution information is specific to VISOR.
99

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

1414
[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html

‎README.rst‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
Visor
2+
VISOR
33
=====
44

55
|pyansys|
@@ -16,15 +16,15 @@ Demo
1616
----
1717

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

2121

2222
Overview
2323
--------
2424

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

27-
You can use Visor to integrate with the following tools:
27+
You can use VISOR to integrate with the following tools:
2828

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

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

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

4343

4444
Installation
4545
------------
4646

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

5151

5252
Quick start
5353
-----------
5454

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

5959

6060
Development
6161
-----------
6262

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

6666

6767
Usage
6868
-----
6969

70-
You can use Visor through the following entry points. Links are to the relevant information in he
71-
Visor documentation.
70+
You can use VISOR through the following entry points. Links are to the relevant information in he
71+
VISOR documentation.
7272

7373
* **Standalone Python**
7474

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

81-
* **Visor HTTP service**
81+
* **VISOR HTTP service**
8282

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

9191
* **Dash frontend app**
9292

93-
* Connect to a Visor instance from a Dash app with the Visor Dash component in
93+
* Connect to a VISOR instance from a Dash app with the VISOR Dash component in
9494
``ansys.visor.dash.dash_visor_viewer``.
95-
* See `Visor Dash component <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/launching_visor/visor_dash_component.html>`_
95+
* See `VISOR Dash component <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/launching_visor/visor_dash_component.html>`_
9696
for details.
9797

98-
For advanced usage and configuration options, see the following Visor documentation:
98+
For advanced usage and configuration options, see the following VISOR documentation:
9999

100100
`User guide <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/user_guide/index.html>`_ and
101101
`Examples <https://supreme-fiesta-v6v17mm.pages.github.io/version/dev/examples/index.html>`_ in the
102-
Visor sections.
102+
VISOR sections.

‎deploy/docker/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Running Visor in a Docker Container
1+
# Running VISOR in a Docker Container
22

3-
The Visor project contains Docker configurations for both development and release environments.
3+
The VISOR project contains Docker configurations for both development and release environments.
44

55
For each environment, there is a Dockerfile and docker-compose.yml to enable containerizing the FastAPI service,
66
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
6060
which simplifies the process by managing the configuration and dependencies in a
6161
single file.
6262

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

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Capitalize project name in documentation

‎pyproject.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ build-system-version = "1.7.0"
1010
[tool.poetry]
1111
name = "ansys-visor-viewer"
1212
version = "1.0.0_beta"
13-
description = "\"Visor 3D visualization web component framework\""
14-
authors = ["Visor Team <visor@ansys.com>"]
13+
description = "\"VISOR 3D visualization web component framework\""
14+
authors = ["VISOR Team <visor@ansys.com>"]
1515
readme = "README.rst"
1616
license = "Ansys License"
1717
repository = "https://github.com/ansys/visor"

‎tools/awc_icon_generator/AWC-FONTS-ICONS-README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ In order to make use of AWC fonts and icons without installing the entire AWC Re
99
- The default AWC UI font (Source Sans 3) and its corresponding CSS font-family stack
1010
- AWC icon SVGs
1111

12-
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.
12+
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.
1313

14-
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.
14+
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.
1515

1616
## Default AWC UI Font
1717

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

7979
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.
8080

81-
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.
81+
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.
8282

8383
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.

‎tools/awc_icon_generator/awc-icon-generator.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ <h1>AWC Icon Library Generator</h1>
6565
This page loops through a list of AWC icon SVG file names, downloads each icon's SVG,<br/>
6666
and dynamically builds a JavaScript object with methods that return each icon as an HTMLElement object.<br/><br/>
6767
For information on using this JavaScript generator, either see the readme at<br/><br/>
68-
<b>[Visor Project Root]\src\ansys\visor\visor-client\utils\tools\AWC-FONTS-ICONS-README.md</b><br/><br/>
68+
<b>[VISOR Project Root]\src\ansys\visor\visor-client\utils\tools\AWC-FONTS-ICONS-README.md</b><br/><br/>
6969
or see the GitHub discussion <a href="https://github.com/ansys-internal/theia/issues/231">here</a>.
7070
</div>
7171
<div style="margin-top:20px;">

0 commit comments

Comments
 (0)