Migrate to yaml input + pyvista instead of vtk

This commit provides the migration from the old
.dat input files requiring complex dedicated reading and writing
routines to the new yaml input format. Moreover we switch from vtk to
pyvista visualization. Specifically, the following work was performed:
- New reading and writing routines were implemented which make use of
fourcipp's FourCInput class. Thus, they also validate the input files
before visualization and before exporting them. We now only support the
in/out formats: .yaml, .yml. What was also added: read-in and write (export) error messages
(in the GUI and in the terminal), in case that either the file validation or the lnmmeshio
conversion to vtu fails.
- Replaced the vtk visualization of the input file with pyvista which provides
more comfortable handling of geometry data. Also, it provides a nice utilities bar
containing tools such as the coordinate system, the edge visibility, certain views ...
The plot was also significantly enhanced optically (more color-blind friendly colors, legend, design conditions now also visualized using spheres
allowing for reasonable scaling based on the current problem size,...).
- A new TrameApp class named FourCWebserver was implemented which improves the organization
of all server- and client-relevant data. It holds server-only variables, and state variables
shared between server and client (as well as controller methods and change events).
Similarly to the previous approach, there are specific sections, such as e.g. Materials, Design Conditions,
Result Description,... which are handled in a section-specific
manner as opposed to the more general settings sections, such as e.g. STRUCTURE DYNAMIC. The server-only
section variables basically hold the fourc yaml content in the same data structures as the input file, while
the state variables organize the date in a more client-friendly manner. For each of
the section types we have an initialization routine (for both server-only and state variables), and a
sync-back routine converting the current state to the server-only variables used subsequently for the export.
The data organization within each section is now also significantly improved in comparison with the previous main, by saving state
variables in nested dicts which are more easily accessible than the large multi-dimensional arrays used previously.
- Improvement of the GUI: rework of the specific section panels Materials, Design Conditions, Result Description and Functions to
more closely match the current yaml content structure and require less processing to obtain dedicated state variables. An important point
is that input files with all types of functions can now be entered into the Webviewer (as opposed to previously) - although the plot visualization
of specific function types remains to be done (only SYMBOLIC_FUNCTION_OF_SPACE_TIME currently supported).

Author: dragos-ana

pyproject.toml

@@ -7,7 +7,7 @@ name = "fourc_webviewer"
 version = "2.0"
 description = "4C webviewer"
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.12"
 dynamic = ["dependencies"]
 
 [project.scripts]

requirements.in

@@ -1,10 +1,13 @@
-lnmmeshio
 trame
 trame-vuetify
 trame-vtk
 trame-components
 trame-plotly
 plotly
 pandas
+pyvista
 vtk
-numpy
+numpy
+# include fourcipp from github
+git+https://github.com/4C-multiphysics/fourcipp.git
+lnmmeshio>=5.6.2

requirements.txt

@@ -1,111 +1,171 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    pip-compile
+#    pip-compile --all-extras --output-file=requirements.txt requirements.in
 #
-aiohttp==3.9.3
-    # via wslink
-aiosignal==1.3.1
-    # via aiohttp
-async-timeout==4.0.3
+aiohappyeyeballs==2.6.1
     # via aiohttp
-attrs==23.2.0
+aiohttp==3.11.18
+    # via wslink
+aiosignal==1.3.2
     # via aiohttp
-contourpy==1.2.0
+attrs==25.3.0
+    # via
+    #   aiohttp
+    #   fourcipp
+    #   jsonschema
+    #   referencing
+contourpy==1.3.2
     # via matplotlib
 cycler==0.12.1
     # via matplotlib
-fonttools==4.50.0
+deprecation==2.1.0
+    # via
+    #   fourcipp
+    #   rapidyaml
+fonttools==4.57.0
     # via matplotlib
-frozenlist==1.4.1
+fourcipp @ git+https://github.com/4C-multiphysics/fourcipp.git
+    # via -r requirements.in
+frozenlist==1.6.0
     # via
     #   aiohttp
     #   aiosignal
-idna==3.6
+idna==3.10
     # via yarl
-kiwisolver==1.4.5
+jsonschema==4.23.0
+    # via fourcipp
+jsonschema-rs==0.29.1
+    # via fourcipp
+jsonschema-specifications==2024.10.1
+    # via
+    #   fourcipp
+    #   jsonschema
+kiwisolver==1.4.8
     # via matplotlib
-lnmmeshio==5.3.0
+lnmmeshio==5.4.0
     # via -r requirements.in
+loguru==0.7.3
+    # via fourcipp
 markdown-it-py==3.0.0
     # via rich
-matplotlib==3.8.3
+matplotlib==3.10.1
     # via vtk
 mdurl==0.1.2
     # via markdown-it-py
 meshio==5.3.5
     # via lnmmeshio
-more-itertools==10.2.0
+more-itertools==10.7.0
     # via trame-server
-multidict==6.0.5
+msgpack==1.1.0
+    # via wslink
+multidict==6.4.3
     # via
     #   aiohttp
     #   yarl
-numpy==1.26.4
+narwhals==1.38.0
+    # via plotly
+numpy==2.2.4
     # via
     #   -r requirements.in
     #   contourpy
+    #   fourcipp
     #   lnmmeshio
     #   matplotlib
     #   meshio
     #   pandas
-packaging==24.0
+packaging==24.2
     # via
+    #   deprecation
+    #   fourcipp
     #   matplotlib
     #   plotly
-pandas==2.2.1
+pandas==2.2.3
     # via -r requirements.in
-pillow==10.2.0
+pillow==11.2.1
     # via matplotlib
-plotly==5.20.0
-    # via -r requirements.in
+plotly==6.0.1
+    # via
+    #   -r requirements.in
+    #   trame-plotly
 progress==1.6
     # via lnmmeshio
-pygments==2.17.2
+propcache==0.3.1
+    # via
+    #   aiohttp
+    #   yarl
+pygments==2.19.1
     # via rich
-pyparsing==3.1.2
+pyparsing==3.2.3
     # via matplotlib
 python-dateutil==2.9.0.post0
     # via
     #   matplotlib
     #   pandas
-python-utils==3.8.2
+python-utils==3.9.1
     # via lnmmeshio
-pytz==2024.1
+pytz==2025.2
     # via pandas
-rich==13.7.1
+pyyaml==6.0.2
+    # via trame
+rapidyaml==0.8.0
+    # via fourcipp
+referencing==0.36.2
+    # via
+    #   fourcipp
+    #   jsonschema
+    #   jsonschema-specifications
+rich==14.0.0
     # via meshio
-six==1.16.0
+rpds-py==0.23.1
+    # via
+    #   fourcipp
+    #   jsonschema
+    #   referencing
+ruamel-yaml==0.18.10
+    # via fourcipp
+ruamel-yaml-clib==0.2.12
+    # via
+    #   fourcipp
+    #   ruamel-yaml
+six==1.17.0
     # via python-dateutil
-tenacity==8.2.3
-    # via plotly
-trame==3.5.4
+trame==3.9.0
     # via -r requirements.in
-trame-client==2.16.5
+trame-client==3.8.2
     # via
     #   trame
     #   trame-components
     #   trame-plotly
     #   trame-vtk
     #   trame-vuetify
-trame-components==2.2.1
+trame-common==0.2.0
+    # via
+    #   trame
+    #   trame-client
+trame-components==2.4.2
     # via -r requirements.in
-trame-plotly==3.0.2
+trame-plotly==3.1.0
     # via -r requirements.in
-trame-server==2.17.2
+trame-server==3.4.0
     # via trame
-trame-vtk==2.8.5
+trame-vtk==2.8.15
     # via -r requirements.in
-trame-vuetify==2.4.3
+trame-vuetify==3.0.1
     # via -r requirements.in
-typing-extensions==4.10.0
-    # via python-utils
-tzdata==2024.1
+typing-extensions==4.12.2
+    # via
+    #   fourcipp
+    #   python-utils
+    #   referencing
+tzdata==2025.2
     # via pandas
-vtk==9.3.0
+vtk==9.4.2
     # via -r requirements.in
-wslink==1.12.4
-    # via trame-server
-yarl==1.9.4
+wslink==2.3.3
+    # via
+    #   trame
+    #   trame-server
+yarl==1.20.0
     # via aiohttp

src/fourc_webviewer/cli_utils.py

@@ -18,7 +18,9 @@ def get_arguments():
         dict: Arguments dictionary
     """
     parser = argparse.ArgumentParser(description="4C Webviewer")
-    parser.add_argument("--dat_file", type=str, help="input file path to visualize")
+    parser.add_argument(
+        "--fourc_yaml_file", type=str, help="input file path to visualize"
+    )
 
     args = parser.parse_args()