Merge pull request #743 from mathLab/dev

Dev Updates

Author: dario-coscia

.github/workflows/create-tag.yml

@@ -0,0 +1,44 @@
+name: Create Git Tag
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: "Tag name (eg. v1.3.0)"
+        required: true
+        type: string
+
+permissions:
+  contents: write
+
+jobs:
+  create_tag:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Configure git with PAT
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git remote set-url origin "https://x-access-token:${{ secrets.PAT_PINA_PUSH }}@github.com/${{ github.repository }}.git"
+
+      - name: Check if the tag is already existing
+        run: |
+          TAG="${{ inputs.tag_name }}"
+          git fetch --tags
+          if git rev-parse -q --verify "refs/tags/$TAG" >/dev/null; then
+            echo "❌ Tag $TAG already exists"
+            exit 1
+          fi
+
+      - name: Create and push the tag
+        run: |
+          TAG="${{ inputs.tag_name }}"
+          git tag "$TAG"
+          git push origin "$TAG"

docs/source/_rst/_code.rst

@@ -215,6 +215,7 @@ Problems Zoo
 .. toctree::
     :titlesonly:
 
+    AcousticWaveProblem <problem/zoo/acoustic_wave.rst>
     AdvectionProblem <problem/zoo/advection.rst>
     AllenCahnProblem <problem/zoo/allen_cahn.rst>
     DiffusionReactionProblem <problem/zoo/diffusion_reaction.rst>
@@ -230,10 +231,11 @@ Geometrical Domains
 .. toctree::
     :titlesonly:
 
-    Domain <domain/domain.rst>
-    CartesianDomain <domain/cartesian.rst>
-    EllipsoidDomain <domain/ellipsoid.rst>
-    SimplexDomain <domain/simplex.rst>
+    DomainInterface <domain/domain_interface.rst>
+    BaseDomain <domain/base_domain.rst>
+    CartesianDomain <domain/cartesian_domain.rst>
+    EllipsoidDomain <domain/ellipsoid_domain.rst>
+    SimplexDomain <domain/simplex_domain.rst>
 
 Domain Operations
 ------------------
@@ -242,22 +244,25 @@ Domain Operations
     :titlesonly:
 
     OperationInterface <domain/operation_interface.rst>
-    Union <domain/union_domain.rst>
-    Intersection <domain/intersection_domain.rst>
-    Difference <domain/difference_domain.rst>
-    Exclusion <domain/exclusion_domain.rst>
+    BaseOperation <domain/base_operation.rst>
+    Union <domain/union.rst>
+    Intersection <domain/intersection.rst>
+    Difference <domain/difference.rst>
+    Exclusion <domain/exclusion.rst>
 
 Callbacks
 -----------
 
 .. toctree::
     :titlesonly:
 
-    Processing callback <callback/processing_callback.rst>
-    Optimizer callback <callback/optimizer_callback.rst>
-    R3 Refinment callback <callback/refinement/r3_refinement.rst>
-    Refinment Interface callback <callback/refinement/refinement_interface.rst>
-    Normalizer callback <callback/normalizer_data_callback.rst>
+    Switch Optimizer <callback/optim/switch_optimizer.rst>
+    Switch Scheduler <callback/optim/switch_scheduler.rst>
+    Normalizer Data <callback/processing/normalizer_data_callback.rst>
+    PINA Progress Bar <callback/processing/pina_progress_bar.rst>
+    Metric Tracker <callback/processing/metric_tracker.rst>
+    Refinement Interface <callback/refinement/refinement_interface.rst>
+    R3 Refinement <callback/refinement/r3_refinement.rst>
 
 Losses and Weightings
 ---------------------

…rce/_rst/callback/optimizer_callback.rst …_rst/callback/optim/switch_optimizer.rstdocs/source/_rst/callback/optimizer_callback.rst renamed to docs/source/_rst/callback/optim/switch_optimizer.rst docs/source/_rst/callback/optimizer_callback.rst renamed to docs/source/_rst/callback/optim/switch_optimizer.rst

@@ -1,7 +1,7 @@
-Optimizer callbacks
+Switch Optimizer
 =====================
 
-.. currentmodule:: pina.callback.optimizer_callback
+.. currentmodule:: pina.callback.optim.switch_optimizer
 .. autoclass:: SwitchOptimizer
    :members:
    :show-inheritance:

docs/source/_rst/callback/optim/switch_scheduler.rst

@@ -0,0 +1,7 @@
+Switch Scheduler
+=====================
+
+.. currentmodule:: pina.callback.optim.switch_scheduler
+.. autoclass:: SwitchScheduler
+   :members:
+   :show-inheritance:

docs/source/_rst/callback/processing/metric_tracker.rst

@@ -0,0 +1,7 @@
+Metric Tracker
+==================
+.. currentmodule:: pina.callback.processing.metric_tracker
+
+.. autoclass:: MetricTracker
+   :members:
+   :show-inheritance:

…st/callback/normalizer_data_callback.rst …/processing/normalizer_data_callback.rstdocs/source/_rst/callback/normalizer_data_callback.rst renamed to docs/source/_rst/callback/processing/normalizer_data_callback.rst docs/source/_rst/callback/normalizer_data_callback.rst renamed to docs/source/_rst/callback/processing/normalizer_data_callback.rst

@@ -1,7 +1,7 @@
-Normalizer callbacks
+Normalizer Data
 =======================
 
-.. currentmodule:: pina.callback.normalizer_data_callback
+.. currentmodule:: pina.callback.processing.normalizer_data_callback
 .. autoclass:: NormalizerDataCallback
    :members:
    :show-inheritance:

docs/source/_rst/callback/processing/pina_progress_bar.rst

@@ -0,0 +1,7 @@
+PINA Progress Bar
+==================
+.. currentmodule:: pina.callback.processing.pina_progress_bar
+
+.. autoclass:: PINAProgressBar
+   :members:
+   :show-inheritance:

docs/source/_rst/callback/processing_callback.rst

@@ -0,0 +1,9 @@
+BaseDomain
+===========
+.. currentmodule:: pina.domain.base_domain
+
+.. automodule:: pina.domain.base_domain
+
+.. autoclass:: BaseDomain
+    :members:
+    :show-inheritance:

docs/source/_rst/domain/base_domain.rst

@@ -0,0 +1,9 @@
+BaseOperation
+==============
+.. currentmodule:: pina.domain.base_operation
+
+.. automodule:: pina.domain.base_operation
+
+.. autoclass:: BaseOperation
+    :members:
+    :show-inheritance: