ansys-saf-cli 4.1.dev0__py3-none-any.whl

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/deployments/standalone-with-minerva/compose.yaml

@@ -0,0 +1,122 @@
+name: {{ cookiecutter.__docker_name }}
+
+networks:
+  {{ cookiecutter.__docker_name }}-internal:
+    internal: true
+  {{ cookiecutter.__docker_name }}-external:
+    driver: bridge
+
+services:
+  {{ cookiecutter.__docker_name }}-postgresql:
+    image: postgres:16.0
+    networks:
+      - {{ cookiecutter.__docker_name }}-internal
+    environment:
+      - POSTGRES_USER=glow
+      - POSTGRES_PASSWORD=glow
+    healthcheck:
+      test: [ "CMD", "pg_isready", "-U", "glow" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - {{ cookiecutter.__docker_name }}-database:/var/lib/postgresql/data
+
+  {{ cookiecutter.__docker_name }}-api:
+    image: {{ cookiecutter.__docker_name }}-api
+    build:
+      context: ../../
+      dockerfile: deployments/Dockerfile
+      target: solution_api
+    depends_on:
+      {{ cookiecutter.__docker_name }}-postgresql:
+        condition: service_healthy
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+      - {{ cookiecutter.__docker_name }}-internal
+    env_file:
+      - .env
+    init: true # to ensure reaping of killed child processes left by long-running transactions
+    environment:
+      - GLOW_API_HOST=0.0.0.0
+      - GLOW_API_PORT=50000
+      - GLOW_DATABASE_TYPE=postgresql
+      - GLOW_DATABASE_LOCATION=postgresql://glow:glow@{{ cookiecutter.__docker_name }}-postgresql:5432
+      - GLOW_PROJECT_FILES_DIRECTORY=/projects
+      - GLOW_METHOD_EXECUTION_DIRECTORY=/transactions
+      - GLOW_EXTERNAL_API_URL=http://127.0.0.1:${GLOW_API_CONTAINER_PORT}
+      - OTEL_EXPORTER_OTLP_ENDPOINT=${OTEL_EXPORTER_OTLP_ENDPOINT}
+      - GLOW_DATA_REPOSITORY_TYPE=Minerva
+      - ANS_MINERVA_CLI=/usr/local/share/minerva/cli/AnsysMinerva_CLI
+    ports:
+      - ${GLOW_API_CONTAINER_PORT}:50000
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:50000/health" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - ${GLOW_PROJECTS_DIR_SOLUTION}:/projects
+      - ${GLOW_TRANSACTIONS_DIR_SOLUTION}:/transactions
+    develop:
+      watch:
+        - action: sync+restart
+          path: /src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/solution
+          target: /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/solution
+
+{% if cookiecutter.__ui_framework != "none" %}
+
+  {{ cookiecutter.__docker_name }}-ui:
+    image: {{ cookiecutter.__docker_name }}-ui
+    build:
+      context: ../../
+      dockerfile: deployments/Dockerfile
+      target: solution_ui
+    depends_on:
+      {{ cookiecutter.__docker_name }}-api:
+        condition: service_healthy
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+    env_file:
+      - .env
+    environment:
+      - GLOW_DEPLOYMENT=DockerCompose
+      - GLOW_UI_HOST=0.0.0.0
+      - GLOW_UI_PORT=50001
+      - GLOW_API_URL=http://{{ cookiecutter.__docker_name }}-api:50000
+      - GLOW_UI_PROJECT_FILES_DIRECTORY=/projects
+      - GLOW_WS_EVENTS_ADDR=127.0.0.1:${GLOW_API_CONTAINER_PORT}
+      - GLOW_EXTERNAL_API_URL=http://127.0.0.1:${GLOW_API_CONTAINER_PORT}
+      - GLOW_DATA_REPOSITORY_TYPE=Minerva
+      - ANS_MINERVA_CLI=/usr/local/share/minerva/cli/AnsysMinerva_CLI
+    ports:
+      - ${GLOW_UI_CONTAINER_PORT}:50001
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:50001/health" ]
+      interval: 5s
+      retries: 20
+    volumes:
+      - ${GLOW_PROJECTS_DIR_SOLUTION}:/projects
+    develop:
+      watch:
+        - action: sync+restart
+          path: /src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ui
+          target: /app/src/{{ cookiecutter.__solution_namespace_path }}/{{ cookiecutter.__solution_module_name }}/ui
+
+{% endif %}
+
+  otel-dashboard:
+    image: mcr.microsoft.com/dotnet/aspire-dashboard:9.1.0
+    ports:
+      - 18888:18888 # UI
+      - 18889:18889 # OTLP gRPC
+      - 18890:18890 # OTLP HTTP
+    environment:
+      - DASHBOARD__OTLP__AUTHMODE=ApiKey
+      # !!! Important !!! For production, replace the following env var with secure values
+      # as described here: https://aspire.dev/dashboard/security-considerations/
+      - DASHBOARD__FRONTEND__AUTHMODE=Unsecured
+      - DASHBOARD__OTLP__PRIMARYAPIKEY=YOU_MUST_GENERATE_A_RANDOM_STRING_AND_REPLACE_THIS
+    networks:
+      - {{ cookiecutter.__docker_name }}-external
+
+volumes:
+  {{ cookiecutter.__docker_name }}-database:

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/.vale.ini

@@ -0,0 +1,28 @@
+# Core settings
+# =============
+
+# Location of our `styles`
+StylesPath = "styles"
+
+# The options are `suggestion`, `warning`, or `error` (defaults to “warning”).
+MinAlertLevel = error
+
+# By default, `code` and `tt` are ignored.
+IgnoredScopes = code, tt
+
+# By default, `script`, `style`, `pre`, and `figure` are ignored.
+SkippedScopes = script, style, pre, figure
+
+# WordTemplate specifies what Vale will consider to be an individual word.
+WordTemplate = \b(?:%s)\b
+
+# List of Packages to be used for our guidelines
+Packages = Google
+
+# Define the Ansys vocabulary
+Vocab = ANSYS
+
+# Apply styles to documentation files
+[*.{md,rst}]
+BasedOnStyles = Vale, Google
+Vale.Terms = NO

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/Makefile

@@ -0,0 +1,30 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -j auto -W --color --keep-going
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+# Customized clean due to examples gallery
+clean:
+	rm -rf $(BUILDDIR)/*
+	rm -rf $(SOURCEDIR)/examples
+	find . -type d -name "_autosummary" -exec rm -rf {} +
+
+# Customized pdf for svg format images
+pdf:
+	@echo "PDF generation is not implemented"

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/changelog.d/changelog_template.jinja

@@ -0,0 +1,17 @@
+{{ '{% if sections[""] %}' }}
+{{ '{% for category, val in definitions.items() if category in sections[""] %}' }}
+
+{{ "{{ definitions[category]['name'] }}" }}
+{{ "{% set underline = '^' * definitions[category]['name']|length %}" }}
+{{ '{{ underline }}' }}
+
+{{ '{% for text, values in sections[""][category].items() %}' }}
+- {{ '{{ text }}' }} {{ "{{ values|join(', ') }}" }}
+{{ '{% endfor %}' }}
+
+{{ '{% endfor %}' }}
+{{ '{% else %}' }}
+No significant changes.
+
+
+{{ '{% endif %}' }}

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/make.bat

@@ -0,0 +1,46 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+if "%1" == "clean" goto clean
+if "%1" == "pdf" goto pdf
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:pdf
+echo PDF generation is not implemented yet.
+goto end
+
+:clean
+rmdir /s /q %BUILDDIR% > /NUL 2>&1
+for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/source/_static/css/custom.css

@@ -0,0 +1,8 @@
+/*©2025, ANSYS Inc. Unauthorized use, distribution or duplication is prohibited.*/
+body {
+    text-align: justify;
+}
+
+h1, h2, h3, h4, h5, h6, pre, code {
+    text-align: left;  /* Keep headings and code blocks left-aligned */
+}

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/source/_templates/README.md

@@ -0,0 +1 @@
+## Contains templates for the documentation build

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/source/changelog.rst

@@ -0,0 +1,12 @@
+.. _ref_release_notes:
+
+Release notes
+#############
+
+This document contains the release notes for the project.
+
+.. vale off
+
+.. towncrier release notes start
+
+.. vale on

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/source/conf.py

@@ -0,0 +1,253 @@
+# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates.
+
+"""Sphinx documentation configuration file."""
+
+
+from datetime import datetime
+import os
+from pathlib import Path
+
+from ansys_sphinx_theme import ansys_favicon, get_version_match
+from sphinx.builders.latex import LaTeXBuilder
+import toml
+
+BRANCH = "main"
+ORGANIZATION_NAME = "ansys"
+DOC_PATH = "doc/source"
+
+# ---------- // Project Information // --------------------------------------------------------------------------------
+
+LaTeXBuilder.supported_image_types = ["image/png", "image/pdf", "image/svg+xml"]
+configuration_file = Path(__file__).parent.parent.parent.absolute() / "pyproject.toml"
+if configuration_file.exists():
+    configuration = toml.load(configuration_file)
+else:
+    raise FileNotFoundError("No configuration file at project's root.")
+
+project_name = project = configuration.get("tool", {}).get("poetry", {}).get("name", None)
+package_version = configuration.get("tool", {}).get("poetry", {}).get("version", None)
+cname = os.getenv("DOCUMENTATION_CNAME")
+repository_name = os.getenv("REPOSITORY_NAME")
+
+copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
+author = "ANSYS Inc."
+switcher_version = get_version_match(package_version)
+
+
+# ---------- // General configuration // ------------------------------------------------------------------------------
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "numpydoc",
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
+    "sphinx_code_tabs",
+    "sphinx.ext.todo",
+    "sphinxcontrib.autodoc_pydantic",
+    "sphinx_design",
+]
+
+# Intersphinx mapping
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/dev", None),
+}
+
+# pydantic configuration
+autodoc_pydantic_model_show_json = False
+autodoc_pydantic_model_show_config = False
+autodoc_pydantic_settings_show_json = False
+autodoc_pydantic_model_show_validator_members = False
+autodoc_pydantic_model_show_validator_summary = False
+
+suppress_warnings = ["label.*"]
+
+# numpydoc configuration
+numpydoc_use_plots = True
+numpydoc_show_class_members = False
+numpydoc_xref_param_type = True
+numpydoc_validate = True
+numpydoc_validation_checks = {
+    "GL06",  # Found unknown section
+    "GL07",  # Sections are in the wrong order.
+    "GL08",  # The object does not have a docstring
+    "GL09",  # Deprecation warning should precede extended summary
+    "GL10",  # reST directives {directives} must be followed by two colons
+    "SS01",  # No summary found
+    "SS02",  # Summary does not start with a capital letter
+    # "SS03", # Summary does not end with a period
+    "SS04",  # Summary contains heading whitespaces
+    # "SS05", # Summary must start with infinitive verb, not third person
+    "RT02",  # The first line of the Returns section should contain only the
+    # type, unless multiple values are being returned"
+}
+
+# Favicon
+html_favicon = ansys_favicon
+
+# notfound.extension
+notfound_template = "404.rst"
+notfound_urls_prefix = "/../"
+
+# static path
+html_static_path = ["_static"]
+
+html_css_files = ["css/custom.css"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "links.rst",
+    "substitutions.rst",
+]
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+autodoc_mock_imports = ["ansys.platform", "opentelemetry"]
+numfig = True
+numfig_secnum_depth = 1
+numfig_format = {
+    "figure": "Figure %s ",
+    "table": "Table %s ",
+    "code-block": "Code sample %s ",
+}
+
+# ---------- // Copy button customization // --------------------------------------------------------------------------
+
+# exclude traditional Python prompts from the copied code
+copybutton_prompt_text = r">>> ?|\.\.\. "
+copybutton_prompt_is_regexp = True
+
+
+# ---------- // Sphinx Gallery Options // -----------------------------------------------------------------------------
+
+
+# ---------- // Options for HTML output // ----------------------------------------------------------------------------
+
+html_short_title = html_title = "Ansys Solutions A"
+html_theme = "ansys_sphinx_theme"
+html_theme_options = {
+    "logo": "ansys",
+    "show_prev_next": False,
+    "show_breadcrumbs": True,
+    "collapse_navigation": True,
+    "use_edit_page_button": False,
+    "additional_breadcrumbs": [
+        ("Ansys", "https://github.com/ansys"),
+    ],
+    "check_switcher": False,
+}
+
+rst_epilog = f"""
+.. |version| replace:: v{package_version}
+"""
+
+if cname and switcher_version:
+    html_theme_options["switcher"] = (
+        {
+            "json_url": f"https://{cname}/versions.json",
+            "version_match": switcher_version,
+        },
+    )
+
+if str(os.getenv("DISABLE_GITHUB_URL_LINK")).lower() != "true" and repository_name:
+    html_theme_options["github_url"] = f"https://github.com/{repository_name}"
+
+html_context = {
+    "display_github": False,  # Integrate GitHub
+    "github_user": ORGANIZATION_NAME,
+    "github_repo": repository_name,
+    "github_version": BRANCH,
+    "doc_path": DOC_PATH,
+    "default_mode": "dark",
+}
+html_show_sourcelink = False
+html_compact_lists = False
+
+
+# ---------- // Options for HTMLHelp output // ------------------------------------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "ansys-solutions-a-documentation"
+
+
+# ---------- // Options for LaTeX output // ---------------------------------------------------------------------------
+
+latex_elements = {}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        f"Ansys-Solutions-a-Documentation-{package_version}.tex",
+        "Ansys Solutions A Documentation",
+        author,
+        "manual",
+    ),
+]
+
+
+# ---------- // [Options for manual page output // --------------------------------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        master_doc,
+        "Ansys Solutions A",
+        "Ansys Solutions A Documentation",
+        [author],
+        1,
+    )
+]
+
+
+# ---------- // Options for Texinfo output // -------------------------------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "Ansys Solutions A",
+        "Ansys Solutions A Documentation",
+        author,
+        "Ansys Solutions A",
+        "Engineering Software",
+    ),
+]
+
+# Keep these while the repository is private
+linkcheck_ignore = [
+    "/*",
+    "https://pypi.org/project/ansys-solutions-a",
+]
+
+# If we are on a release, we have to ignore the "release" URLs, since it is not
+# available until the release is published.
+if switcher_version != "dev":
+    linkcheck_ignore.append(f"https://github.com/ansys/ansys.solutions.a/releases/tag/v{package_version}")

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/source/examples.rst

@@ -0,0 +1,8 @@
+.. _examples:
+
+Examples
+########
+
+These examples demonstrate the behavior and usage of the solution.
+
+.. Provide links to the files in doc/source/examples below: