ci: add workflows

.github/labeler.yml

@@ -0,0 +1,71 @@
+# This file is required by the the action 'https://github.com/actions/labeler'
+# and used in the '.github/workflows/ci_cd_pr.yml' workflow
+
+# -- Labels based on PR title ------------------------------------------------
+'fix':
+  - head-branch: ['fix']
+
+'enhancement':
+  - head-branch: ['feat']
+
+# -- Documentation labels ----------------------------------------------------
+'docs':
+  - all:
+      - changed-files:
+          - any-glob-to-any-file: ['doc/source/**/*.rst']
+          - all-globs-to-all-files: ['!doc/source/examples.rst', '!doc/source/api/**/*.rst', '!doc/styles/**', '!doc/.vale.ini']
+
+'docs:api':
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: ['doc/source/api/**/*.rst']
+
+'docs:examples':
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: ['examples/**/*.py', 'doc/source/examples.rst']
+
+## -- Other labels ------------------------------------------------------------
+'style:code':
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: ['.pre-commit-config.yaml', 'doc/.vale.ini']
+
+'docker':
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: ['docker/**']
+
+'ci':
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: ['.github/workflows/**']
+
+'tests':
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: ['tests/**']
+
+# HACK: the following labels are declared with the only purpose of avoiding the
+# GitHub labeler bot to remove those. This is a known issue reported in the
+# official action/labeler repo https://github.com/actions/labeler/issues/763
+
+'ci:skip':
+  - all:
+      - changed-files:
+          - all-globs-to-all-files: ['THIS-NEVER-MATCHES-A-FILE']
+
+'docs:skip':
+  - all:
+      - changed-files:
+          - all-globs-to-all-files: ['THIS-NEVER-MATCHES-A-FILE']
+
+'tests:skip':
+  - all:
+      - changed-files:
+          - all-globs-to-all-files: ['THIS-NEVER-MATCHES-A-FILE']
+
+'blocked':
+  - all:
+      - changed-files:
+          - all-globs-to-all-files: ['THIS-NEVER-MATCHES-A-FILE']

.github/labels.yml

@@ -0,0 +1,116 @@
+# The labels declared in this file are the ones available
+# https://github.com/ansys-internal/pylumerical/labels
+
+# -- Defects, glitches, and vulnerabilities labels ---------------------------
+
+- name: 'bug'
+  description: Defects or glitches reported by users or developers
+  color: d42a34
+
+- name: 'fix'
+  description:  Pull requests related to resolving problems or errors
+  color: d42a34
+
+- name: 'vulnerability'
+  description:  Pull requests related to resolving problems or errors
+  color: d42a34
+
+# -- Style labels ------------------------------------------------------------
+
+- name: 'style'
+  description: Improvements related to general project style
+  color: dcbeff
+
+- name: 'style:code'
+  description: Improvements related to code style
+  color: dcbeff
+
+- name: 'style:docs'
+  description: Improvements related to doc style
+  color: dcbeff
+
+- name: 'style:branch-name'
+  description: Verifies branch name is compliant with PyAnsys guidelines
+  color: dcbeff
+
+- name: 'style:skip'
+  description: Skip style runs in CI/CD
+  color: dcbeff
+
+# -- Tests labels ------------------------------------------------------------
+
+- name: 'tests'
+  description: Related with improvements of the test suite
+  color: ffd8b1
+
+- name: 'tests:skip'
+  description: Skip tests runs in CI/CD
+  color: ffd8b1
+
+# -- Documentation labels ----------------------------------------------------
+
+- name: 'docs'
+  description: Issues related to documentation
+  color: 0677ba
+
+- name: 'docs:api'
+  description: Related to API documentation
+  color: 0677ba
+
+- name: 'docs:examples'
+  description: Related to documentation examples
+  color: 0677ba
+
+- name: 'docs:skip'
+  description: Skip documentation runs in CI/CD
+  color: 0677ba
+
+# -- Dependencies labels -----------------------------------------------------
+
+- name: 'dependencies'
+  description: Related with project dependencies
+  color: fabed4
+
+- name: 'dependencies:pyproject'
+  description: Related with project file dependencies
+  color: fabed4
+
+- name: 'dependencies:ci'
+  description: Related with pipelines dependencies
+  color: fabed4
+
+# -- CI/CD labels ------------------------------------------------------------
+
+- name: 'ci'
+  description: Pipelines maintenance related
+  color: a9a9a9
+
+- name: 'ci:skip'
+  description: Skip CI/CD runs
+  color: a9a9a9
+
+# -- Other labels ------------------------------------------------------------
+
+- name: 'release'
+  description: Anything related to an incoming release
+  color: ffffff
+
+- name: 'good first issue'
+  description: Issues suitable for newcomers or those with less experience
+  color: 62ca50
+
+- name: 'enhancement'
+  description: General improvements to existing features
+  color: ffd827
+
+- name: 'maintenance'
+  description: Generic maintenance related
+  color: f78c37
+
+- name: 'docker'
+  description: Docker maintenance related
+  color: 000075
+
+- name: 'blocked'
+  description: Cannot be completed until other tasks are resolved
+  color: 000000

.github/workflows/ci_cd_pr.yml

@@ -0,0 +1,160 @@
+name: pull-request
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, edited, labeled, closed]
+
+env:
+  MAIN_PYTHON_VERSION: '3.13'
+  LIBRARY_NAME: 'ansys-lumerical-core'
+  DOCKER_IMAGE_LUMERICAL_UNIFIED: 'ghcr.io/ansys-internal/lumerical-unified:latest'
+  DOCKER_CONTAINER_LUMERICAL_UNIFIED_NAME: 'lumerical-unified'
+  PIP_EXTRA_INDEX_URL: 'https://${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/'
+
+permissions:
+  contents: read
+  pull-requests: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  labeler:
+    name: "Labels"
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+
+     - name: "Checkout project"
+       uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+       with:
+        persist-credentials: false
+
+     - name: "Sync labels"
+       uses: micnncim/action-label-syncer@3abd5ab72fda571e69fffd97bd4e0033dd5f495c # v1.3.0
+       env:
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+     - name: "Label pull-request"
+       # HACK: skip if contributor does not have write permissions (forks)
+       if: github.event.pull_request.head.repo.full_name == github.repository
+       uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
+       with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+  changelog-fragment:
+    name: "Create changelog fragment"
+    needs: labeler
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: ansys/actions/doc-changelog@v10
+      with:
+        token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+        use-conventional-commits: true
+        use-default-towncrier-config: true
+        bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+        bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+
+  code-style:
+    name: "Code style"
+    runs-on: ubuntu-latest
+    needs: changelog-fragment
+    steps:
+      - name: "Run code style checks"
+        uses: ansys/actions/code-style@v10
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          use-python-cache: false
+
+  doc-style:
+    name: "Doc style"
+    runs-on: ubuntu-latest
+    needs: changelog-fragment
+    steps:
+      - uses: ansys/actions/doc-style@v10
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  doc-build:
+    name: "Doc build"
+    runs-on: ubuntu-latest
+    needs: doc-style
+    steps:
+      - uses: ansys/actions/doc-build@v10
+        with:
+          skip-install: true
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          use-python-cache: false
+          needs-quarto: true
+
+  wheelhouse:
+    name: "Wheelhouse / ${{ matrix.os }} / ${{ matrix.python }}"
+    runs-on: ${{ matrix.os }}
+    needs: code-style
+    permissions:
+      id-token: write
+      contents: write
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['ubuntu-latest', 'windows-latest']
+        python: ['3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: ansys/actions/build-wheelhouse@v10
+        with:
+          library-name: ${{ env.LIBRARY_NAME }}
+          operating-system: ${{ matrix.os }}
+          python-version: ${{ matrix.python }}
+
+  tests:
+    name: "Test Python 3.13 with Lumerical Unified Linux Container"
+    runs-on: ubuntu-latest
+    needs: wheelhouse
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+
+      - name: "Checkout PyLumerical"
+        uses: actions/checkout@v4
+
+      - name: "Login to GitHub container registry"
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+
+      - name: "Pull Lumerical Unified Container"
+        run: |
+          docker pull ${{ env.DOCKER_IMAGE_LUMERICAL_UNIFIED }}
+
+      - name: "Run Lumerical Unified Container"
+        run: |
+          docker run \
+            --detach -it \
+            --network="host" \
+            --name ${{ env.DOCKER_CONTAINER_LUMERICAL_UNIFIED_NAME }} \
+             --env ANSYSLMD_LICENSE_FILE=1055@${{ secrets.LICENSE_SERVER }} \
+             --volume ${PWD}:/home/ansys/pylumerical \
+             ${{ env.DOCKER_IMAGE_LUMERICAL_UNIFIED }}
+
+      - name: "Install project"
+        run: |
+            docker exec \
+              --workdir /home/ansys/pylumerical \
+              ${{ env.DOCKER_CONTAINER_LUMERICAL_UNIFIED_NAME }} /bin/bash --login -c \
+              "python -m pip install -e .[tests] && pytest tests"
+
+      - name: "Stop lumerical services"
+        if: always()
+        run: |
+          docker stop ${{ env.DOCKER_CONTAINER_LUMERICAL_UNIFIED_NAME }}
+          docker logs ${{ env.DOCKER_CONTAINER_LUMERICAL_UNIFIED_NAME }}
+          docker rm ${{ env.DOCKER_CONTAINER_LUMERICAL_UNIFIED_NAME }}

doc/.vale.ini

@@ -34,4 +34,4 @@ Google.WordList = NO
 
 # Ignore specific tokens for class references and such
 
-TokenIgnores = (:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>)|(\|[A-Za-z0-9_]+\|)
+TokenIgnores = (:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>)|(\|[A-Za-z0-9_]+\|)

doc/Makefile

@@ -27,6 +27,6 @@ clean:
 
 # Customized pdf for svg format images
 pdf:
-	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" -j auto --color --keep-going $(O)
 	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
 	(test -f $(BUILDDIR)/latex/*.pdf && echo pdf exists) || exit 1

doc/source/api/interface_class.rst

@@ -5,6 +5,7 @@ Instances of these objects each represent an interactive session with a Lumerica
 
 .. autosummary::
     :toctree: _autosummary
+    :recursive:
 
     ansys.lumerical.core.FDTD
     ansys.lumerical.core.MODE

doc/source/changelog/5.maintenance.md

@@ -0,0 +1 @@
+Add workflows

doc/source/changelog/template

@@ -0,0 +1,22 @@
+{% if sections[""] %}
+
+.. tab-set::
+
+{%+ for category, val in definitions.items() if category in sections[""] %}
+
+  .. tab-item:: {{ definitions[category]['name'] }}
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+{% for text, values in sections[""][category].items() %}
+        * - {{ text }}
+          - {{ values|join(', ') }}
+
+{% endfor %}
+{% endfor %}
+
+{% else %}
+No significant changes.
+{% endif %}