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

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

@@ -0,0 +1,165 @@
+.. _desktop-installation:
+
+Development environment installation
+####################################
+
+Prerequisites
+=============
+
+.. list-table:: Prerequisites
+    :header-rows: 1
+
+    * - Prerequisite
+      - Description
+
+    * - Operating system
+      - Windows 10 or Ubuntu
+
+    * - Python distribution
+      - Python 3.10 with the `SAF CLI installed <https://saf-cli.docs.solutions.ansys.com/version/stable/getting_started.html#install-saf-cli>`_
+
+    * - IDE
+      - `Visual Studio Code <https://code.visualstudio.com/download#>`_
+
+Setup
+=====
+
+#. Navigate to the project root:
+
+   .. code-block:: bash
+
+    cd {{ cookiecutter.__solution_name }}
+
+#. Install dependencies:
+
+   .. code-block:: bash
+
+       saf install
+
+Follow all the instructions for credentials setup. These may require you to run the above command a second time in a new shell.
+
+When executing third-party tools, use the ``saf execute`` command  to ensure they run inside the correct solution environment.
+For a complete list of available SAF CLI commands, see the `SAF CLI Cheat Sheet <https://saf-cli.docs.solutions.ansys.com/version/stable/cheat_sheet.html>`_.
+
+
+Build and access the documentation
+==================================
+
+.. This section enables you to read this file in a friendly format in a browser.
+
+#. Install the documentation dependencies:
+
+   .. code-block:: bash
+
+       saf install -d doc
+
+#. Build the documentation:
+
+   (The following assumes that the current directory is the root of the solution.)
+
+   .. code-block:: bash
+
+       saf execute "sphinx-build doc/source doc/build/html --color -vW -bhtml"
+
+#. Open the documentation in a web browser (Windows Only):
+
+   a. Open a file explorer on the ``{{cookiecutter.__solution_name}}`` root directory and navigate to the ``doc\build\html`` directory.
+   b. Double-click  the ``index.html`` file to open it in the default web browser.
+
+#. Navigate to this page:
+
+   a. Click **Getting Started**.
+   b. Click **Desktop Installation**.
+
+Run the solution
+================
+
+To run the solution, execute the following command anywhere in the project:
+
+.. code-block:: bash
+
+    saf run
+
+The Solution UI starts in a desktop window with a new project.
+
+.. list-table:: Some useful ``saf run`` options
+    :header-rows: 1
+    :stub-columns: 1
+
+    * - Option
+      - Description
+      - Usage
+
+    * - ``debug``
+      - Activate debug mode.
+      - ``saf run --debug``
+
+    * - ``project <project-name>``
+      - Bypass the SAF Portal UI and start a specific project.
+      - ``saf run --project <project-name>``
+
+    * - ``portal``
+      - Start the SAF Portal UI.
+      - ``saf run --portal``
+
+Create a GitHub repository for ``{{ cookiecutter.__solution_display_name }}``
+========================================================================================
+
+If you have not yet created a GitHub repository for ``{{ cookiecutter.__solution_display_name }}`` then you need one
+to enable the code checks to function.
+
+.. note::
+    If you are already working in a clone of the ``{{cookiecutter.__solution_name}}`` source code repository, you can skip this section.
+
+
+Create a GitHub repository called ``{{cookiecutter.__solution_name}}`` within your organization follow this sequence of steps:
+
+#. Open a browser at ``https://github.com/<your-organization>``.
+#. Click the green :guilabel:`New` button to create a new repository.
+#. Enter the repository name as ``{{cookiecutter.__solution_name}}``.
+#. Enter a description.
+#. Do not change any of the other settings (the generated solution contains ``.gitignore``, ``README.md`` and ``LICENSE.rst`` files).
+#. Click the green :guilabel:`Create repository` button.
+#. In the ``{{ cookiecutter.__solution_name }}`` root directory, execute the following sequence of commands to upload the solution source code to the GitHub repository and establish the ``{{ cookiecutter.__solution_name }}`` root directory as a clone of the GitHub repository in GitHub:
+
+   .. code-block::
+
+       git init
+       git add *
+       git commit -m "first commit"i
+       git branch -M main
+       git remote add origin https://github.com/<your-organization>/{{cookiecutter.__solution_name}}.git
+       git push -u origin main
+
+
+Check the code style
+====================
+
+1. Install the tests dependencies:
+
+.. code-block:: bash
+
+    saf install -d style
+
+2. Run the checks:
+
+.. code-block:: bash
+
+    saf execute "tox -e style"
+
+Run unit tests
+==============
+
+1. Install the tests dependencies:
+
+.. code-block:: bash
+
+    saf install -d tests
+
+2. Run the tests:
+
+.. code-block:: bash
+
+    saf execute "pytest"
+
+You should see in on the console output indicating that all the tests in a test suite of several tests passed.

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

@@ -0,0 +1,68 @@
+.. _docker-installation:
+
+Docker installation
+###################
+
+Prerequisites
+=============
+
+.. list-table:: Prerequisites
+    :stub-columns: 1
+    :header-rows: 1
+
+    * - Prerequisite
+      - Description
+
+    * - Operating system
+      - Windows 10 or Ubuntu
+
+    * - IDE
+      - `Visual Studio Code <https://code.visualstudio.com/download#>`_
+
+    * - Virtualization
+      - `Docker <https://www.docker.com/>`_
+
+
+Set up and start {{ cookiecutter.__solution_display_name }} server
+===========================================================================
+
+#. Navigate to the project root:
+
+   .. code-block:: bash
+
+     cd {{ cookiecutter.__solution_name }}
+
+#. Start the services:
+
+   .. code-block:: bash
+
+     docker compose -f deployments/standalone/compose.yaml up --build
+
+   .. important::
+    Wait for all services to start.
+
+#. Open a web page and reach the GLOW API Swagger UI: ``http://localhost:8000/docs``
+
+#. Create a project using the ``Create Project`` post request.
+
+#. Copy the project name from the response.
+
+   It should be in the following syntax: ``projects/<project-id>``.
+
+4. Open a web page and reach the Solution UI: ``http://localhost:8001/projects/<project-id>``.
+
+Now you can walk through the solution workflow.
+
+
+Stop {{ cookiecutter.__solution_display_name }} server
+====================================================================
+
+To shut down the application:
+
+#. in the terminal where you executed the previous Docker command, press :kbd:`CTRL+C` .
+
+#. Shut down the Docker containers:
+
+   .. code-block:: bash
+
+     docker compose -f deployments/standalone/compose.yaml down

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

@@ -0,0 +1,51 @@
+.. image:: /_static/images/repository-banner.png
+   :align: center
+   :width: 100%
+   :alt: Ansys Solutions A
+
+####################################################################################################
+Ansys Solutions {{ cookiecutter.__solution_display_name }} |version|
+####################################################################################################
+
+.. grid:: 2
+   :gutter: 3
+
+   .. grid-item-card:: Getting started with desktop development
+      :link-type: doc
+      :link: getting_started/desktop_installation
+
+      Instructions for installing and using the {{ cookiecutter.__solution_display_name }} development environment.
+
+   .. grid-item-card:: Getting started with Docker deployment
+      :link-type: doc
+      :link: getting_started/docker_installation
+
+      Instructions for using the {{ cookiecutter.__solution_display_name }} Docker deployment.
+
+   .. grid-item-card:: User guide
+      :link-type: doc
+      :link: user_guide/index
+
+      Instructions for using the solution.
+
+   .. grid-item-card:: Examples
+      :link-type: doc
+      :link: examples
+
+      Examples of how to use the solution.
+
+   .. grid-item-card:: Release notes
+      :link-type: doc
+      :link: changelog
+
+      Information about the latest release.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 3
+
+   getting_started/desktop_installation
+   getting_started/docker_installation
+   user_guide/index
+   examples
+   changelog

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

@@ -0,0 +1,6 @@
+.. _user-guide:
+
+User guide
+##########
+
+The guide provides instructions for using the solution.

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/doc/styles/config/vocabularies/ANSYS/accept.txt

@@ -0,0 +1,5 @@
+ANSYS
+Ansys
+ansys
+SME
+walkthrough

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/examples/README.md

@@ -0,0 +1 @@
+# Examples