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 CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This project uses [towncrier](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in <https://github.com/ansys/visor/tree/main/doc/changelog.d/>.
This project uses [towncrier](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in <https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/tree/main/doc/changelog.d/>.

<!-- towncrier release notes start -->
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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://visor.docs.pyansys.com/version/dev/contributing/index.html)
documentation.

[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
Expand Down
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Visual Interactive Simulation Object Renderer (VISOR)
:target: https://pypi.org/project/ansys-visor-viewer
:alt: PyPI

.. |GH-CI| image:: https://github.com/ansys/visor/actions/workflows/build_and_release.yml/badge.svg?branch=main
:target: https://github.com/ansys/visor/actions/workflows/build_and_release.yml
.. |GH-CI| image:: https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/actions/workflows/build_and_release.yml/badge.svg?branch=main
:target: https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/actions/workflows/build_and_release.yml
:alt: GH-CI

.. |codecov| image:: https://codecov.io/gh/ansys/visor/branch/main/graph/badge.svg
Expand Down Expand Up @@ -73,15 +73,15 @@ Installation
------------

To set up prerequisites and install VISOR, see
`Getting started <https://vigilant-lamp-162kw9z.pages.github.io/version/dev/getting_started/index.html>`_
`Getting started <https://visor.docs.pyansys.com/version/dev/getting_started/index.html>`_
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>`_
`Quick start <https://visor.docs.pyansys.com/version/dev/getting_started/quick_start.html>`_
in the VISOR documentation.


Expand All @@ -101,30 +101,30 @@ 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>`_
* See `VISOR Python API <https://visor.docs.pyansys.com/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>`_
* See `API reference <https://visor.docs.pyansys.com/version/dev/python_api_reference.html>`_
for details about the Python API.

* **VISOR HTTP service**

* 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>`_
* See `VISOR HTTP service <https://visor.docs.pyansys.com/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>`_
* See `HTTP API reference <https://visor.docs.pyansys.com/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
``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://visor.docs.pyansys.com/version/dev/user_guide/launching_visor/visor_dash_component.html>`_
for details.

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
`User guide <https://visor.docs.pyansys.com/version/dev/user_guide/index.html>`_ and
`Examples <https://visor.docs.pyansys.com/version/dev/examples/index.html>`_ in the
VISOR sections.
1 change: 1 addition & 0 deletions doc/changelog.d/99.fixed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Moving to poetry 2 build
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"json_url": "_static/versions.json",
"version_match": switcher_version,
},
"github_url": "https://github.com/ansys/visor/",
"github_url": "https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/",
"show_prev_next": False,
"show_breadcrumbs": True,
"collapse_navigation": True,
Expand Down Expand Up @@ -252,5 +252,5 @@ def setup(app):
# available until the release is published.
if switcher_version != "dev":
linkcheck_ignore.append(
f"https://github.com/ansys/visor/releases/tag/v{__version__}"
f"https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/releases/tag/v{__version__}"
)
2 changes: 1 addition & 1 deletion doc/source/getting_started/configure_visor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Settings defaults
=================

You can use a ``.visor`` file to override the following default values from the
`Settings class <https://github.com/ansys/visor/blob/main/src/ansys/visor/viewer/config.py>`_:
`Settings class <https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/blob/main/src/ansys/visor/viewer/config.py>`_:

.. code-block:: yaml

Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Developer installation

.. code:: console

git clone https://github.com/ansys/visor.git
git clone https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/.git
cd visor

#. Create a virtual environment:
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/launching_visor/metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Only the initial opacity is supported as a per-part property.
Reference
~~~~~~~~~

Reference: ``Metadata`` class (`source code <https://github.com/ansys/visor/blob/main/src/ansys/visor/viewer/core/metadata.py>`_).
Reference: ``Metadata`` class (`source code <https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/blob/main/src/ansys/visor/viewer/core/metadata.py>`_).

.. literalinclude:: ../../../../src/ansys/visor/viewer/core/metadata.py
:pyobject: Metadata
Expand Down
4 changes: 2 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

43 changes: 24 additions & 19 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
[build-system]
requires = ["poetry-core>=1.0.0,<1.3.0", "setuptools>=65.0"]
requires = ["poetry-core>=2.0.0,<3.0.0", "setuptools>=65.0"]
build-backend = "poetry.core.masonry.api"

# The following lines were added to enforce the poetry version needed for the project.
# It will be read by the setup_environment.py script to install this version.
[build-system-requirements]
build-system-version = "1.7.0"

[tool.poetry]
[project]
name = "ansys-visor-viewer"
version = "1.0.dev0"
description = "\"VISOR 3D visualization web component framework\""
authors = ["VISOR Team <visor@synopsys.com>"]
description = "VISOR 3D visualization web component framework"
requires-python = ">=3.11,<4.0"
dynamic = ["dependencies"]
authors = [
{ name = "VISOR Team", email = "visor@synopsys.com" },
]
readme = "README.rst"
license = "Apache-2.0"
repository = "https://github.com/ansys/visor"
classifiers = [
"Development Status :: 3 - Alpha",
"Operating System :: OS Independent",
Expand All @@ -28,6 +31,20 @@ classifiers = [
"Topic :: Multimedia :: Graphics :: 3D Rendering",
"Topic :: Multimedia :: Graphics :: Viewers",
]

[project.scripts]
visor-setup = "ansys.visor.viewer.utils.autosetup:main"
visor-cli = "ansys.visor.viewer.cli.visor_cli:main"

[project.urls]
Bugs = "https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/issues"
Documentation = "https://visor.docs.pyansys.com/"
Source = "https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/"
Discussions = "https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/discussions"
Releases = "https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/releases"
Changelog = "https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/blob/main/CHANGELOG.md"

[tool.poetry]
packages = [
{ include = "ansys/visor/viewer", from = "src" },
{ include = "visordash", from = "src/ansys/visor/dash" },
Expand All @@ -42,18 +59,6 @@ include = [
{ path = "LICENSE", format = ["sdist", "wheel"] },
]

[tool.poetry.scripts]
visor-setup = "ansys.visor.viewer.utils.autosetup:main"
visor-cli = "ansys.visor.viewer.cli.visor_cli:main"

[tool.poetry.urls]
Bugs = "https://github.com/ansys/visor/issues"
Documentation = "https://github.com/pages/auth?nonce=d0e90489-388e-415e-a0ca-0dc8d2f3c1e3&page_id=60759470&path=L3ZlcnNpb24vZGV2L2luZGV4Lmh0bWw"
Source = "https://github.com/ansys/visor"
Discussions = "https://github.com/ansys/visor/discussions"
Releases = "https://github.com/ansys/visor/releases"
Changelog = "https://github.com/ansys/visor/blob/main/CHANGELOG.md"

[tool.poetry.dependencies]
python = "^3.11"
trame = "3.12.0"
Expand Down Expand Up @@ -126,8 +131,8 @@ directory = "doc/changelog.d"
filename = "doc/source/changelog.rst"
start_string = ".. towncrier release notes start\n"
template = "doc/changelog.d/changelog_template.jinja"
title_format = "`{version} <https://github.com/ansys/visor/releases/tag/v{version}>`_ - {project_date}"
issue_format = "`#{issue} <https://github.com/ansys/visor/pull/{issue}>`_"
title_format = "`{version} <https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/releases/tag/v{version}>`_ - {project_date}"
issue_format = "`#{issue} <https://github.com/ansys/Visual-Interactive-Simulation-Object-Renderer/pull/{issue}>`_"

[[tool.towncrier.type]]
directory = "breaking"
Expand Down
2 changes: 1 addition & 1 deletion tests/e2e/regressions/test_update_variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -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://supreme-fiesta-v6v17mm.pages.github.io/version/dev/examples/03-updating-visor-scene
https://visor.docs.pyansys.com/version/dev/examples/03-updating-visor-scene
"""

visor = visor_server
Expand Down
Loading