diff --git a/.github/workflows/create-tag.yml b/.github/workflows/create-tag.yml new file mode 100644 index 000000000..fbdb16185 --- /dev/null +++ b/.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" diff --git a/docs/source/_rst/_code.rst b/docs/source/_rst/_code.rst index 151699449..64d88bc8b 100644 --- a/docs/source/_rst/_code.rst +++ b/docs/source/_rst/_code.rst @@ -215,6 +215,7 @@ Problems Zoo .. toctree:: :titlesonly: + AcousticWaveProblem AdvectionProblem AllenCahnProblem DiffusionReactionProblem @@ -230,10 +231,11 @@ Geometrical Domains .. toctree:: :titlesonly: - Domain - CartesianDomain - EllipsoidDomain - SimplexDomain + DomainInterface + BaseDomain + CartesianDomain + EllipsoidDomain + SimplexDomain Domain Operations ------------------ @@ -242,10 +244,11 @@ Domain Operations :titlesonly: OperationInterface - Union - Intersection - Difference - Exclusion + BaseOperation + Union + Intersection + Difference + Exclusion Callbacks ----------- @@ -253,11 +256,13 @@ Callbacks .. toctree:: :titlesonly: - Processing callback - Optimizer callback - R3 Refinment callback - Refinment Interface callback - Normalizer callback + Switch Optimizer + Switch Scheduler + Normalizer Data + PINA Progress Bar + Metric Tracker + Refinement Interface + R3 Refinement Losses and Weightings --------------------- diff --git a/docs/source/_rst/callback/optimizer_callback.rst b/docs/source/_rst/callback/optim/switch_optimizer.rst similarity index 54% rename from docs/source/_rst/callback/optimizer_callback.rst rename to docs/source/_rst/callback/optim/switch_optimizer.rst index 0afdc2669..635e79a18 100644 --- a/docs/source/_rst/callback/optimizer_callback.rst +++ b/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: \ No newline at end of file diff --git a/docs/source/_rst/callback/optim/switch_scheduler.rst b/docs/source/_rst/callback/optim/switch_scheduler.rst new file mode 100644 index 000000000..3176904da --- /dev/null +++ b/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: \ No newline at end of file diff --git a/docs/source/_rst/callback/processing/metric_tracker.rst b/docs/source/_rst/callback/processing/metric_tracker.rst new file mode 100644 index 000000000..f21cc7730 --- /dev/null +++ b/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: \ No newline at end of file diff --git a/docs/source/_rst/callback/normalizer_data_callback.rst b/docs/source/_rst/callback/processing/normalizer_data_callback.rst similarity index 53% rename from docs/source/_rst/callback/normalizer_data_callback.rst rename to docs/source/_rst/callback/processing/normalizer_data_callback.rst index 6f59f7aee..a44f0c402 100644 --- a/docs/source/_rst/callback/normalizer_data_callback.rst +++ b/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: \ No newline at end of file diff --git a/docs/source/_rst/callback/processing/pina_progress_bar.rst b/docs/source/_rst/callback/processing/pina_progress_bar.rst new file mode 100644 index 000000000..1d42ad120 --- /dev/null +++ b/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: \ No newline at end of file diff --git a/docs/source/_rst/callback/processing_callback.rst b/docs/source/_rst/callback/processing_callback.rst deleted file mode 100644 index a06bb8b17..000000000 --- a/docs/source/_rst/callback/processing_callback.rst +++ /dev/null @@ -1,11 +0,0 @@ -Processing callbacks -======================= - -.. currentmodule:: pina.callback.processing_callback -.. autoclass:: MetricTracker - :members: - :show-inheritance: - -.. autoclass:: PINAProgressBar - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/domain/base_domain.rst b/docs/source/_rst/domain/base_domain.rst new file mode 100644 index 000000000..e6b9ce88c --- /dev/null +++ b/docs/source/_rst/domain/base_domain.rst @@ -0,0 +1,9 @@ +BaseDomain +=========== +.. currentmodule:: pina.domain.base_domain + +.. automodule:: pina.domain.base_domain + +.. autoclass:: BaseDomain + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/domain/base_operation.rst b/docs/source/_rst/domain/base_operation.rst new file mode 100644 index 000000000..cfa145f03 --- /dev/null +++ b/docs/source/_rst/domain/base_operation.rst @@ -0,0 +1,9 @@ +BaseOperation +============== +.. currentmodule:: pina.domain.base_operation + +.. automodule:: pina.domain.base_operation + +.. autoclass:: BaseOperation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/domain/cartesian.rst b/docs/source/_rst/domain/cartesian_domain.rst similarity index 56% rename from docs/source/_rst/domain/cartesian.rst rename to docs/source/_rst/domain/cartesian_domain.rst index 97f5e8974..15491be8c 100644 --- a/docs/source/_rst/domain/cartesian.rst +++ b/docs/source/_rst/domain/cartesian_domain.rst @@ -1,8 +1,8 @@ CartesianDomain ====================== -.. currentmodule:: pina.domain.cartesian +.. currentmodule:: pina.domain.cartesian_domain -.. automodule:: pina.domain.cartesian +.. automodule:: pina.domain.cartesian_domain .. autoclass:: CartesianDomain :members: diff --git a/docs/source/_rst/domain/difference_domain.rst b/docs/source/_rst/domain/difference.rst similarity index 51% rename from docs/source/_rst/domain/difference_domain.rst rename to docs/source/_rst/domain/difference.rst index f25daa522..0167c3062 100644 --- a/docs/source/_rst/domain/difference_domain.rst +++ b/docs/source/_rst/domain/difference.rst @@ -1,8 +1,8 @@ Difference ====================== -.. currentmodule:: pina.domain.difference_domain +.. currentmodule:: pina.domain.difference -.. automodule:: pina.domain.difference_domain +.. automodule:: pina.domain.difference .. autoclass:: Difference :members: diff --git a/docs/source/_rst/domain/domain.rst b/docs/source/_rst/domain/domain_interface.rst similarity index 83% rename from docs/source/_rst/domain/domain.rst rename to docs/source/_rst/domain/domain_interface.rst index 27adcf0bc..898896ba3 100644 --- a/docs/source/_rst/domain/domain.rst +++ b/docs/source/_rst/domain/domain_interface.rst @@ -1,5 +1,5 @@ -Domain -=========== +DomainInterface +================ .. currentmodule:: pina.domain.domain_interface .. automodule:: pina.domain.domain_interface diff --git a/docs/source/_rst/domain/ellipsoid.rst b/docs/source/_rst/domain/ellipsoid_domain.rst similarity index 56% rename from docs/source/_rst/domain/ellipsoid.rst rename to docs/source/_rst/domain/ellipsoid_domain.rst index ee0d2b7a4..4a9799e29 100644 --- a/docs/source/_rst/domain/ellipsoid.rst +++ b/docs/source/_rst/domain/ellipsoid_domain.rst @@ -1,8 +1,8 @@ EllipsoidDomain ====================== -.. currentmodule:: pina.domain.ellipsoid +.. currentmodule:: pina.domain.ellipsoid_domain -.. automodule:: pina.domain.ellipsoid +.. automodule:: pina.domain.ellipsoid_domain .. autoclass:: EllipsoidDomain :members: diff --git a/docs/source/_rst/domain/exclusion_domain.rst b/docs/source/_rst/domain/exclusion.rst similarity index 51% rename from docs/source/_rst/domain/exclusion_domain.rst rename to docs/source/_rst/domain/exclusion.rst index 8d18be199..f624122ae 100644 --- a/docs/source/_rst/domain/exclusion_domain.rst +++ b/docs/source/_rst/domain/exclusion.rst @@ -1,8 +1,8 @@ Exclusion ====================== -.. currentmodule:: pina.domain.exclusion_domain +.. currentmodule:: pina.domain.exclusion -.. automodule:: pina.domain.exclusion_domain +.. automodule:: pina.domain.exclusion .. autoclass:: Exclusion :members: diff --git a/docs/source/_rst/domain/intersection_domain.rst b/docs/source/_rst/domain/intersection.rst similarity index 50% rename from docs/source/_rst/domain/intersection_domain.rst rename to docs/source/_rst/domain/intersection.rst index 8b2498661..fade1d042 100644 --- a/docs/source/_rst/domain/intersection_domain.rst +++ b/docs/source/_rst/domain/intersection.rst @@ -1,8 +1,8 @@ Intersection ====================== -.. currentmodule:: pina.domain.intersection_domain +.. currentmodule:: pina.domain.intersection -.. automodule:: pina.domain.intersection_domain +.. automodule:: pina.domain.intersection .. autoclass:: Intersection :members: diff --git a/docs/source/_rst/domain/simplex.rst b/docs/source/_rst/domain/simplex_domain.rst similarity index 57% rename from docs/source/_rst/domain/simplex.rst rename to docs/source/_rst/domain/simplex_domain.rst index 7accd7f84..5f1d31c9b 100644 --- a/docs/source/_rst/domain/simplex.rst +++ b/docs/source/_rst/domain/simplex_domain.rst @@ -1,8 +1,8 @@ SimplexDomain ====================== -.. currentmodule:: pina.domain.simplex +.. currentmodule:: pina.domain.simplex_domain -.. automodule:: pina.domain.simplex +.. automodule:: pina.domain.simplex_domain .. autoclass:: SimplexDomain :members: diff --git a/docs/source/_rst/domain/union_domain.rst b/docs/source/_rst/domain/union.rst similarity index 51% rename from docs/source/_rst/domain/union_domain.rst rename to docs/source/_rst/domain/union.rst index 921e430cf..614bb351c 100644 --- a/docs/source/_rst/domain/union_domain.rst +++ b/docs/source/_rst/domain/union.rst @@ -1,8 +1,8 @@ Union ====================== -.. currentmodule:: pina.domain.union_domain +.. currentmodule:: pina.domain.union -.. automodule:: pina.domain.union_domain +.. automodule:: pina.domain.union .. autoclass:: Union :members: diff --git a/docs/source/_rst/problem/zoo/acoustic_wave.rst b/docs/source/_rst/problem/zoo/acoustic_wave.rst new file mode 100644 index 000000000..4a9489667 --- /dev/null +++ b/docs/source/_rst/problem/zoo/acoustic_wave.rst @@ -0,0 +1,9 @@ +AcousticWaveProblem +===================== +.. currentmodule:: pina.problem.zoo.acoustic_wave + +.. automodule:: pina.problem.zoo.acoustic_wave + +.. autoclass:: AcousticWaveProblem + :members: + :show-inheritance: diff --git a/docs/source/_tutorial.rst b/docs/source/_tutorial.rst index 0bcc62418..99958ffcd 100644 --- a/docs/source/_tutorial.rst +++ b/docs/source/_tutorial.rst @@ -33,6 +33,7 @@ Neural Operator Learning - `Introductory Tutorial: Neural Operator Learning with PINA `_ - `Modeling 2D Darcy Flow with the Fourier Neural Operator `_ - `Solving the Kuramoto-Sivashinsky Equation with Averaging Neural Operator `_ +- `Advection Equation with data driven DeepONet `_ Supervised Learning ------------------- @@ -42,4 +43,4 @@ Supervised Learning - `Reduced Order Model with Graph Neural Networks for Unstructured Domains `_ - `Data-driven System Identification with SINDy `_ - `Unstructured Convolutional Autoencoders with Continuous Convolution `_ -- `Reduced Order Modeling with POD-RBF and POD-NN Approaches for Fluid Dynamics `_ +- `Reduced Order Modeling with POD-RBF and POD-NN Approaches for Fluid Dynamics `_ \ No newline at end of file diff --git a/docs/source/tutorials/tutorial1/tutorial.html b/docs/source/tutorials/tutorial1/tutorial.html index 3d8bffc16..7b489f71b 100644 --- a/docs/source/tutorials/tutorial1/tutorial.html +++ b/docs/source/tutorials/tutorial1/tutorial.html @@ -7643,7 +7643,7 @@

Build the problemdomains = { "x0": CartesianDomain({"x": 0.0}), - "D": CartesianDomain({"x": [0, 1]}), + "D": spatial_domain, } conditions = { @@ -7785,7 +7785,7 @@

Generate data @@ -7925,7 +7925,7 @@
⚠️ Important Note: @@ -7945,19 +7945,12 @@
⚠️ Important Note: - @@ -8048,7 +8041,7 @@
⚠️ Important Note: @@ -8093,7 +8086,7 @@
⚠️ Important Note: @@ -8126,6 +8119,6 @@

What's Next? diff --git a/docs/source/tutorials/tutorial10/tutorial.html b/docs/source/tutorials/tutorial10/tutorial.html index 9f8312553..e11d870be 100644 --- a/docs/source/tutorials/tutorial10/tutorial.html +++ b/docs/source/tutorials/tutorial10/tutorial.html @@ -7760,7 +7760,7 @@

Data Generation @@ -7881,7 +7881,7 @@

Solving the KS problem @@ -7901,19 +7901,12 @@

Solving the KS problem - @@ -8016,8 +8009,8 @@

Solving the KS problem @@ -8058,6 +8051,6 @@

What's Next? diff --git a/docs/source/tutorials/tutorial11/tutorial.html b/docs/source/tutorials/tutorial11/tutorial.html index 912f398bf..f70bcea18 100644 --- a/docs/source/tutorials/tutorial11/tutorial.html +++ b/docs/source/tutorials/tutorial11/tutorial.html @@ -7658,7 +7658,7 @@

Tutorial: Introduction to