gadopt 2.2.0__tar.gz → 2.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. gadopt-2.3.0/.gitattributes +1 -0
  2. gadopt-2.3.0/.github/workflows/lint.yml +20 -0
  3. gadopt-2.3.0/.github/workflows/longtest.yml +61 -0
  4. gadopt-2.3.0/.github/workflows/test.yml +144 -0
  5. gadopt-2.3.0/.gitignore +4 -0
  6. gadopt-2.3.0/CITATION.cff +23 -0
  7. gadopt-2.3.0/Makefile +20 -0
  8. gadopt-2.3.0/PKG-INFO +102 -0
  9. gadopt-2.3.0/README.md +80 -0
  10. gadopt-2.3.0/demos/.pages +16 -0
  11. gadopt-2.3.0/demos/2d_compressible_ALA/2d_compressible_ALA.py +279 -0
  12. gadopt-2.3.0/demos/2d_compressible_ALA/Makefile +10 -0
  13. gadopt-2.3.0/demos/2d_compressible_ALA/expected.pkl +0 -0
  14. gadopt-2.3.0/demos/2d_compressible_TALA/2d_compressible_TALA.py +205 -0
  15. gadopt-2.3.0/demos/2d_compressible_TALA/Makefile +10 -0
  16. gadopt-2.3.0/demos/2d_compressible_TALA/expected.pkl +0 -0
  17. gadopt-2.3.0/demos/2d_cylindrical/2d_cylindrical.py +231 -0
  18. gadopt-2.3.0/demos/2d_cylindrical/Makefile +10 -0
  19. gadopt-2.3.0/demos/2d_cylindrical/expected.pkl +0 -0
  20. gadopt-2.3.0/demos/3d_cartesian/3d_cartesian.py +215 -0
  21. gadopt-2.3.0/demos/3d_cartesian/Makefile +10 -0
  22. gadopt-2.3.0/demos/3d_cartesian/expected.pkl +0 -0
  23. gadopt-2.3.0/demos/3d_spherical/3d_spherical.py +194 -0
  24. gadopt-2.3.0/demos/3d_spherical/Makefile +10 -0
  25. gadopt-2.3.0/demos/3d_spherical/expected.pkl +0 -0
  26. gadopt-2.3.0/demos/Drucker-Prager_rheology/Makefile +10 -0
  27. gadopt-2.3.0/demos/Drucker-Prager_rheology/plot_convergence.py +46 -0
  28. gadopt-2.3.0/demos/Drucker-Prager_rheology/spiegelman.py +285 -0
  29. gadopt-2.3.0/demos/Drucker-Prager_rheology/test_spiegelman.py +89 -0
  30. gadopt-2.3.0/demos/Makefile +26 -0
  31. gadopt-2.3.0/demos/adjoint/Makefile +16 -0
  32. gadopt-2.3.0/demos/adjoint/cases.py +1 -0
  33. gadopt-2.3.0/demos/adjoint/forward.py +111 -0
  34. gadopt-2.3.0/demos/adjoint/inverse.py +211 -0
  35. gadopt-2.3.0/demos/adjoint/taylor_test.py +190 -0
  36. gadopt-2.3.0/demos/adjoint/test_adjoint.py +11 -0
  37. gadopt-2.3.0/demos/adjoint_2d_cylindrical/Checkpoint230.h5 +3 -0
  38. gadopt-2.3.0/demos/adjoint_2d_cylindrical/Makefile +16 -0
  39. gadopt-2.3.0/demos/adjoint_2d_cylindrical/cases.py +1 -0
  40. gadopt-2.3.0/demos/adjoint_2d_cylindrical/forward.py +175 -0
  41. gadopt-2.3.0/demos/adjoint_2d_cylindrical/inverse.py +260 -0
  42. gadopt-2.3.0/demos/adjoint_2d_cylindrical/taylor_test.py +256 -0
  43. gadopt-2.3.0/demos/adjoint_2d_cylindrical/test_cylindrical_adjoint.py +12 -0
  44. gadopt-2.3.0/demos/analytical_comparisons/Makefile +29 -0
  45. gadopt-2.3.0/demos/analytical_comparisons/analytical.py +177 -0
  46. gadopt-2.3.0/demos/analytical_comparisons/delta_cylindrical_freeslip.py +142 -0
  47. gadopt-2.3.0/demos/analytical_comparisons/delta_cylindrical_freeslip_dpc.py +142 -0
  48. gadopt-2.3.0/demos/analytical_comparisons/delta_cylindrical_zeroslip.py +142 -0
  49. gadopt-2.3.0/demos/analytical_comparisons/delta_cylindrical_zeroslip_dpc.py +142 -0
  50. gadopt-2.3.0/demos/analytical_comparisons/run_gadi.sh +20 -0
  51. gadopt-2.3.0/demos/analytical_comparisons/smooth_cylindrical_freeslip.py +123 -0
  52. gadopt-2.3.0/demos/analytical_comparisons/smooth_cylindrical_zeroslip.py +123 -0
  53. gadopt-2.3.0/demos/analytical_comparisons/smooth_spherical_freeslip.py +133 -0
  54. gadopt-2.3.0/demos/analytical_comparisons/smooth_spherical_zeroslip.py +133 -0
  55. gadopt-2.3.0/demos/analytical_comparisons/test_analytical.py +79 -0
  56. gadopt-2.3.0/demos/base_case/Makefile +8 -0
  57. gadopt-2.3.0/demos/base_case/base_case.py +392 -0
  58. gadopt-2.3.0/demos/base_case/expected.pkl +0 -0
  59. gadopt-2.3.0/demos/generate_expected.py +21 -0
  60. gadopt-2.3.0/demos/multi_material/Makefile +9 -0
  61. gadopt-2.3.0/demos/multi_material/README.md +47 -0
  62. gadopt-2.3.0/demos/multi_material/benchmarks/__init__.py +0 -0
  63. gadopt-2.3.0/demos/multi_material/benchmarks/crameri_2012.geo +30 -0
  64. gadopt-2.3.0/demos/multi_material/benchmarks/crameri_2012.py +220 -0
  65. gadopt-2.3.0/demos/multi_material/benchmarks/gerya_2003.py +133 -0
  66. gadopt-2.3.0/demos/multi_material/benchmarks/robey_2019.py +175 -0
  67. gadopt-2.3.0/demos/multi_material/benchmarks/schmalholz_2011.py +295 -0
  68. gadopt-2.3.0/demos/multi_material/benchmarks/schmeling_2008.geo +31 -0
  69. gadopt-2.3.0/demos/multi_material/benchmarks/schmeling_2008.py +207 -0
  70. gadopt-2.3.0/demos/multi_material/benchmarks/tosi_2015.py +192 -0
  71. gadopt-2.3.0/demos/multi_material/benchmarks/trim_2023.py +205 -0
  72. gadopt-2.3.0/demos/multi_material/benchmarks/van_keken_1997_isothermal.py +165 -0
  73. gadopt-2.3.0/demos/multi_material/benchmarks/van_keken_1997_thermochemical.py +231 -0
  74. gadopt-2.3.0/demos/multi_material/compositional_buoyancy/compositional_buoyancy.py +291 -0
  75. gadopt-2.3.0/demos/multi_material/data/DET_FREE_NEW_TOP_R100.mat +0 -0
  76. gadopt-2.3.0/demos/multi_material/data/HSentr4800.dat +2588 -0
  77. gadopt-2.3.0/demos/multi_material/data/HSvrms4800.dat +2588 -0
  78. gadopt-2.3.0/demos/multi_material/data/URC125x40_240k.entr.dat +1024 -0
  79. gadopt-2.3.0/demos/multi_material/data/URC125x40_240k.vrms.dat +1024 -0
  80. gadopt-2.3.0/demos/multi_material/data/URCchain.entr.dat +794 -0
  81. gadopt-2.3.0/demos/multi_material/data/URCchain.vrms.dat +794 -0
  82. gadopt-2.3.0/demos/multi_material/data/pvk120_003.entr.dat +2038 -0
  83. gadopt-2.3.0/demos/multi_material/data/pvk120_003.vrms.dat +2038 -0
  84. gadopt-2.3.0/demos/multi_material/data/pvk80_001.entr.dat +657 -0
  85. gadopt-2.3.0/demos/multi_material/data/pvk80_001.vrms.dat +657 -0
  86. gadopt-2.3.0/demos/multi_material/data/zslab-case1-best-reformatted.xlsx +0 -0
  87. gadopt-2.3.0/demos/multi_material/initial_signed_distance.py +124 -0
  88. gadopt-2.3.0/demos/multi_material/run_benchmark.py +336 -0
  89. gadopt-2.3.0/demos/multi_material/test_multi_material.py +99 -0
  90. gadopt-2.3.0/demos/multi_material/thermochemical_buoyancy/thermochemical_buoyancy.py +340 -0
  91. gadopt-2.3.0/demos/optimisation_checkpointing/Makefile +8 -0
  92. gadopt-2.3.0/demos/optimisation_checkpointing/helmholtz.py +84 -0
  93. gadopt-2.3.0/demos/optimisation_checkpointing/test_checkpointing.py +17 -0
  94. gadopt-2.3.0/demos/parallel_scaling/Makefile +19 -0
  95. gadopt-2.3.0/demos/parallel_scaling/expected.csv +4 -0
  96. gadopt-2.3.0/demos/parallel_scaling/plot_scaling_diagnostics.py +90 -0
  97. gadopt-2.3.0/demos/parallel_scaling/run_gadi.sh +28 -0
  98. gadopt-2.3.0/demos/parallel_scaling/scaling.py +128 -0
  99. gadopt-2.3.0/demos/parallel_scaling/stokes_cubed_sphere.py +103 -0
  100. gadopt-2.3.0/demos/parallel_scaling/test_scaling.py +50 -0
  101. gadopt-2.3.0/demos/scalar_advection/scalar_advection.py +106 -0
  102. gadopt-2.3.0/demos/scalar_advection_diffusion/Makefile +8 -0
  103. gadopt-2.3.0/demos/scalar_advection_diffusion/expected_errors.npz +0 -0
  104. gadopt-2.3.0/demos/scalar_advection_diffusion/generate_expected.py +13 -0
  105. gadopt-2.3.0/demos/scalar_advection_diffusion/plot_convergence.py +39 -0
  106. gadopt-2.3.0/demos/scalar_advection_diffusion/scalar_advection_diffusion.py +87 -0
  107. gadopt-2.3.0/demos/scalar_advection_diffusion/scalar_advection_diffusion_DH219_skew.py +73 -0
  108. gadopt-2.3.0/demos/scalar_advection_diffusion/scalar_advection_diffusion_DH27.py +125 -0
  109. gadopt-2.3.0/demos/scalar_advection_diffusion/test_scalar_advection_diffusion_DH27.py +57 -0
  110. gadopt-2.3.0/demos/test_all.py +51 -0
  111. gadopt-2.3.0/demos/viscoplastic_case/Makefile +10 -0
  112. gadopt-2.3.0/demos/viscoplastic_case/expected.pkl +0 -0
  113. gadopt-2.3.0/demos/viscoplastic_case/viscoplastic_case.py +214 -0
  114. gadopt-2.3.0/docs/testing.md +50 -0
  115. gadopt-2.3.0/gadopt/__init__.py +34 -0
  116. gadopt-2.3.0/gadopt/approximations.py +321 -0
  117. gadopt-2.3.0/gadopt/diagnostics.py +84 -0
  118. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt/energy_solver.py +48 -9
  119. gadopt-2.3.0/gadopt/equations.py +188 -0
  120. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt/inverse.py +126 -98
  121. gadopt-2.3.0/gadopt/level_set_tools.py +541 -0
  122. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt/limiter.py +92 -56
  123. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt/momentum_equation.py +55 -34
  124. gadopt-2.3.0/gadopt/preconditioners.py +22 -0
  125. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt/scalar_equation.py +91 -53
  126. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt/stokes_integrators.py +95 -26
  127. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt/time_stepper.py +465 -104
  128. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt/utility.py +14 -5
  129. gadopt-2.3.0/gadopt.egg-info/PKG-INFO +102 -0
  130. gadopt-2.3.0/gadopt.egg-info/SOURCES.txt +141 -0
  131. gadopt-2.3.0/gadopt.egg-info/requires.txt +13 -0
  132. gadopt-2.3.0/get_software_citation.py +38 -0
  133. {gadopt-2.2.0 → gadopt-2.3.0}/pyproject.toml +8 -3
  134. gadopt-2.3.0/pytest.ini +4 -0
  135. {gadopt-2.2.0 → gadopt-2.3.0}/setup.cfg +1 -1
  136. gadopt-2.3.0/tests/test_stokes_solver_configuration.py +87 -0
  137. gadopt-2.2.0/PKG-INFO +0 -39
  138. gadopt-2.2.0/README.md +0 -23
  139. gadopt-2.2.0/gadopt/__init__.py +0 -14
  140. gadopt-2.2.0/gadopt/approximations.py +0 -210
  141. gadopt-2.2.0/gadopt/diagnostics.py +0 -41
  142. gadopt-2.2.0/gadopt/equations.py +0 -88
  143. gadopt-2.2.0/gadopt/preconditioners.py +0 -92
  144. gadopt-2.2.0/gadopt.egg-info/PKG-INFO +0 -39
  145. gadopt-2.2.0/gadopt.egg-info/SOURCES.txt +0 -25
  146. gadopt-2.2.0/gadopt.egg-info/requires.txt +0 -7
  147. {gadopt-2.2.0 → gadopt-2.3.0}/LICENSE +0 -0
  148. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt.egg-info/dependency_links.txt +0 -0
  149. {gadopt-2.2.0 → gadopt-2.3.0}/gadopt.egg-info/top_level.txt +0 -0
  150. {gadopt-2.2.0 → gadopt-2.3.0}/tests/test_continuity.py +0 -0
  151. {gadopt-2.2.0 → gadopt-2.3.0}/tests/test_extrusion_tools.py +0 -0
  152. {gadopt-2.2.0 → gadopt-2.3.0}/tests/test_limiters.py +0 -0
@@ -0,0 +1 @@
1
+ demos/adjoint_2d_cylindrical/Checkpoint230.h5 filter=lfs diff=lfs merge=lfs -text
@@ -0,0 +1,20 @@
1
+ name: Run lint
2
+
3
+ on: [push, pull_request]
4
+
5
+ jobs:
6
+ linter:
7
+ name: "Run linter"
8
+ runs-on: ubuntu-latest
9
+ steps:
10
+ - uses: actions/checkout@v4
11
+ - name: Setup Python
12
+ uses: actions/setup-python@v4
13
+ with:
14
+ python-version: '3.10'
15
+ - name: Install linter
16
+ run: |
17
+ python3 -m pip install flake8 pylint
18
+ - name: Lint
19
+ run: |
20
+ make lint
@@ -0,0 +1,61 @@
1
+ name: Run long regression tests
2
+
3
+ on:
4
+ workflow_dispatch:
5
+
6
+ concurrency: longtest_environment
7
+
8
+ jobs:
9
+ build:
10
+ runs-on: ubuntu-latest
11
+ steps:
12
+ - uses: actions/checkout@v4
13
+ - name: Sync repository to Gadi
14
+ uses: up9cloud/action-rsync@v1.4
15
+ env:
16
+ HOST: gadi.nci.org.au
17
+ TARGET: ${{secrets.GADI_REPO_PATH}}
18
+ KEY: ${{secrets.GADI_TESTING_KEY}}
19
+ USER: ${{secrets.GADI_USER}}
20
+ - name: Configure SSH
21
+ run: |
22
+ mkdir -p ~/.ssh/
23
+ echo "${{secrets.GADI_TESTING_KEY}}" > ~/.ssh/gadi.key
24
+ chmod 600 ~/.ssh/gadi.key
25
+ echo "${{secrets.GADI_HOST_KEY}}" >> ~/.ssh/known_hosts
26
+ chmod 600 ~/.ssh/known_hosts
27
+ cat >>~/.ssh/config <<EOF
28
+ Host gadi
29
+ Hostname gadi.nci.org.au
30
+ User ${{secrets.GADI_USER}}
31
+ IdentityFile ~/.ssh/gadi.key
32
+ EOF
33
+
34
+ - name: Run test cases
35
+ id: run_tests
36
+ run: |
37
+ ssh gadi "cd ${{secrets.GADI_REPO_PATH}} && module load python3/3.10.4 && make -j longtest gadopt_checkout=${{secrets.GADI_REPO_PATH}} gadopt_prefix_image=${{secrets.GADI_PREFIX_IMAGE}} project=${{secrets.GADI_PROJECT}}"
38
+
39
+ - name: Test results
40
+ if: ${{ success() }}
41
+ run: |
42
+ ssh gadi "cd ${{secrets.GADI_REPO_PATH}} && module load python3/3.10.4 && python3 -m pytest -m longtest --junit-xml=test_results.xml demos"
43
+
44
+ - name: Retrieve test results
45
+ if: ${{ !cancelled() }}
46
+ run: |
47
+ scp gadi:${{secrets.GADI_REPO_PATH}}/test_results.xml .
48
+
49
+ - name: Pytest report
50
+ uses: mikepenz/action-junit-report@v4
51
+ if: ${{ !cancelled() }}
52
+ with:
53
+ check_name: Test suite report
54
+ report_paths: test_results.xml
55
+ include_passed: true
56
+ annotate_only: true
57
+
58
+ - name: Get error output
59
+ if: ${{ failure() }}
60
+ run: |
61
+ ssh gadi "cd ${{secrets.GADI_REPO_PATH}} && make longtest_output"
@@ -0,0 +1,144 @@
1
+ name: Run regression tests
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - master
7
+ pull_request:
8
+ workflow_dispatch:
9
+
10
+ jobs:
11
+ check_commit:
12
+ runs-on: ubuntu-latest
13
+ outputs:
14
+ skip: ${{ steps.check_commit.outputs.skip }}
15
+ steps:
16
+ - name: Always run tests on workflow dispatch
17
+ id: early_exit
18
+ if: ${{ github.event_name == 'workflow_dispatch' }}
19
+ run:
20
+ echo skip=true >> "$GITHUB_OUTPUT"
21
+ - uses: actions/checkout@v4
22
+ if: ${{ steps.early_exit.outputs.skip != 'true' }}
23
+ with:
24
+ ref: ${{ github.event.push.after || github.event.pull_request.head.sha || github.event.workflow_dispatch.ref }}
25
+ - name: Check if message contains skip keyword
26
+ id: check_commit
27
+ if: ${{ steps.early_exit.outputs.skip != 'true' }}
28
+ run: |
29
+ message=$(git log -1 --pretty=format:'%B')
30
+ regex="\[skip tests\]"
31
+ if [[ "$message" =~ $regex ]]; then
32
+ echo skip=true >> "$GITHUB_OUTPUT"
33
+ fi
34
+ build:
35
+ name: Benchmark regression test
36
+ runs-on: self-hosted
37
+ container:
38
+ image: firedrakeproject/firedrake:latest
39
+ options: --shm-size 2g
40
+
41
+ concurrency:
42
+ group: testing-${{ github.head_ref || github.run_id }}
43
+ cancel-in-progress: true
44
+
45
+ needs: check_commit
46
+ if: ${{ needs.check_commit.outputs.skip != 'true' }}
47
+
48
+ env:
49
+ OMP_NUM_THREADS: 1
50
+
51
+ steps:
52
+ - name: Install prerequisites
53
+ run: |
54
+ sudo apt update
55
+ sudo apt install -y task-spooler time
56
+ tsp -S 48
57
+
58
+ - uses: actions/checkout@v4
59
+
60
+ - name: Install Python dependencies
61
+ run: |
62
+ . /home/firedrake/firedrake/bin/activate
63
+ python3 -m pip install .[demos,optimisation]
64
+
65
+ - name: Check out repository linked to Trim et al. (2023)
66
+ uses: actions/checkout@v4
67
+ with:
68
+ repository: seantrim/exact-thermochem-solution
69
+ path: ./flib
70
+
71
+ - name: Compile flib (Trim et al., 2023)
72
+ run: |
73
+ . /home/firedrake/firedrake/bin/activate
74
+ cd flib/Python
75
+ rm *.so
76
+ source create_library.sh
77
+ cp *.so ../../demos/multi_material
78
+ shell: bash
79
+
80
+ - name: Run test
81
+ id: run_tests
82
+ run: |
83
+ . /home/firedrake/firedrake/bin/activate
84
+ make -j test
85
+ env:
86
+ GADOPT_LOGLEVEL: INFO
87
+ TS_MAXFINISHED: 100
88
+
89
+ - name: Pytest
90
+ id: run_pytest
91
+ run: |
92
+ . /home/firedrake/firedrake/bin/activate
93
+ python -m pytest -m 'not longtest' --junit-xml=test_results.xml
94
+
95
+ - name: Pytest report
96
+ uses: mikepenz/action-junit-report@v4
97
+ if: ${{ !cancelled() && steps.run_pytest.conclusion != 'skipped' }}
98
+ with:
99
+ check_name: Test suite report
100
+ report_paths: test_results.xml
101
+ include_passed: true
102
+ annotate_only: true
103
+
104
+ - name: Output timing information
105
+ if: ${{ !cancelled() }}
106
+ shell: bash
107
+ run: |
108
+ declare -A timings
109
+ declare -A success
110
+
111
+ # extract info
112
+ for id in $(tsp | awk 'NR>1 { print $1 }'); do
113
+ st="$(tsp -i $id)"
114
+ command=$(sed -En 's/^Command.*python3? //p' <<< "$st")
115
+ timings["$command"]=$(sed -n 's/^Time run: //p' <<< "$st")
116
+
117
+ if grep -q "exit code 0" <<< "$st"; then
118
+ success["$command"]=Yes
119
+ else
120
+ success["$command"]=No
121
+ echo "$command failed:"
122
+ tsp -c $id | tail -n 10 || true
123
+ echo $command >> test_output.log
124
+ tsp -c $id >> test_output.log || true
125
+ fi
126
+ done
127
+
128
+ # sort by case name
129
+ declare -a cases
130
+ while IFS= read -r -d '' entry; do
131
+ cases+=("$entry")
132
+ done < <(printf "%s\0" "${!timings[@]}" | sort -z)
133
+
134
+ printf "## Case timings\nCase | Time | Success?\n---- | ---- | ----\n" >> "$GITHUB_STEP_SUMMARY"
135
+ for case in "${cases[@]}"; do
136
+ printf "%s | %s | %s\n" "$case" ${timings["$case"]} ${success["$case"]} >> "$GITHUB_STEP_SUMMARY"
137
+ done
138
+
139
+ - name: Upload failed run log
140
+ if: steps.run_tests.conclusion == 'failure'
141
+ uses: actions/upload-artifact@v3
142
+ with:
143
+ name: run-log
144
+ path: test_output.log
@@ -0,0 +1,4 @@
1
+ *.pvd
2
+ *.vtu
3
+ *.h5
4
+ __pycache__/
@@ -0,0 +1,23 @@
1
+ authors:
2
+ - family-names: Gibson
3
+ given-names: Angus
4
+ - family-names: Davies
5
+ given-names: Rhodri
6
+ - family-names: Kramer
7
+ given-names: Stephan
8
+ - family-names: Ghelichkhan
9
+ given-names: Sia
10
+ - family-names: Turner
11
+ given-names: Ruby
12
+ - family-names: Duvernay
13
+ given-names: Thomas
14
+ - family-names: Scott
15
+ given-names: Will
16
+ cff-version: 1.2.0
17
+ date-released: '2024-02-07'
18
+ doi: 10.5281/zenodo.5644391
19
+ message: If you use this software, please cite it as below.
20
+ repository-code: https://github.com/g-adopt/g-adopt
21
+ title: G-ADOPT
22
+ type: software
23
+ version: v2.2.0
gadopt-2.3.0/Makefile ADDED
@@ -0,0 +1,20 @@
1
+ .PHONY: lint test longtest longtest_output convert_demos
2
+
3
+ lint:
4
+ @echo "Linting module code"
5
+ @python3 -m flake8 gadopt
6
+ @echo "Linting demos"
7
+ @python3 -m flake8 demos
8
+
9
+ test:
10
+ $(MAKE) -C demos
11
+
12
+ longtest:
13
+ $(MAKE) -C demos longtest
14
+
15
+ longtest_output:
16
+ $(MAKE) -C demos longtest_output
17
+
18
+ # convert demo Python scripts to executed notebooks
19
+ convert_demos:
20
+ $(MAKE) -C demos convert_demos
gadopt-2.3.0/PKG-INFO ADDED
@@ -0,0 +1,102 @@
1
+ Metadata-Version: 2.1
2
+ Name: gadopt
3
+ Version: 2.3.0
4
+ Summary: A computational platform for inverse geodynamics
5
+ Author: G-ADOPT Contributors
6
+ Classifier: Programming Language :: Python :: 3
7
+ Classifier: License :: OSI Approved :: MIT License
8
+ Classifier: Operating System :: OS Independent
9
+ Description-Content-Type: text/markdown
10
+ License-File: LICENSE
11
+ Requires-Dist: vtk>=9.0.1
12
+ Provides-Extra: demos
13
+ Requires-Dist: assess; extra == "demos"
14
+ Requires-Dist: gmsh; extra == "demos"
15
+ Requires-Dist: jupytext; extra == "demos"
16
+ Requires-Dist: openpyxl; extra == "demos"
17
+ Requires-Dist: pandas; extra == "demos"
18
+ Requires-Dist: pyvista; extra == "demos"
19
+ Requires-Dist: shapely; extra == "demos"
20
+ Provides-Extra: optimisation
21
+ Requires-Dist: pyroltrilinos; extra == "optimisation"
22
+
23
+ G-ADOPT
24
+ =======
25
+
26
+ This repository contains material and examples relating to the G-ADOPT
27
+ Platform, a computational platform for inverse geodynamics, being
28
+ developed and maintained by researchers from the Research School of
29
+ Earth Sciences at the Australian National University. It builds on a
30
+ recent surge in accessible observational datasets and advances in
31
+ inversion methods using sophisticated adjoint techniques that provide
32
+ a mechanism for fusing these observations with dynamics, physics and
33
+ chemistry.
34
+
35
+ G-ADOPT is supported and funded by the Australian Research Data
36
+ Commons (ARDC), with additional partner contributions from AuScope,
37
+ the NCI and Geosciences Australia.
38
+
39
+ Installation
40
+ ------------
41
+
42
+ G-ADOPT is available on PyPI as `gadopt`, and requires a working
43
+ [Firedrake](https://www.firedrakeproject.org/) installation. To bring
44
+ in the optional nonlinear optimisation dependencies, install the
45
+ `gadopt[optimisation]` variant. See [the G-ADOPT
46
+ website](https://gadopt.org/install/) for more detailed installation
47
+ instructions, including directions for getting started with the demo
48
+ notebooks.
49
+
50
+ Citing
51
+ ------
52
+
53
+ If you use this software in your work, please cite the software using the following metadata and the two articles below:
54
+ <details>
55
+ <summary> APA references</summary>
56
+
57
+ Gibson, A., Davies, R., Kramer, S., Ghelichkhan, S., Turner, R., Duvernay, T., & Scott, W. (2024). G-ADOPT (Version v2.2.0) [Computer software]. https://doi.org/10.5281/zenodo.5644391
58
+
59
+ Davies, D. R., Kramer, S. C., Ghelichkhan, S., & Gibson, A. (2022). Towards automatic finite-element methods for geodynamics via Firedrake. Geoscientific Model Development, 15(13), 5127–5166. doi:10.5194/gmd-15-5127-2022
60
+
61
+ Ghelichkhan, S., Gibson, A., Davies, D. R., Kramer, S. C., & Ham, D. A. (2023). Automatic adjoint-based inversion schemes for geodynamics: Reconstructing the evolution of Earth’s mantle in space and time. EGUsphere, 2023, 1–46. doi:10.5194/egusphere-2023-2683
62
+ </details>
63
+
64
+ <details>
65
+ <summary> Bibtex references</summary>
66
+
67
+ @software{Gibson_G-ADOPT_2024,
68
+ author = {Gibson, Angus and Davies, Rhodri and Kramer, Stephan and Ghelichkhan, Sia and Turner, Ruby and Duvernay, Thomas and Scott, Will},
69
+ doi = {10.5281/zenodo.5644391},
70
+ month = feb,
71
+ title = {{G-ADOPT}},
72
+ url = {https://github.com/g-adopt/g-adopt},
73
+ version = {v2.2.0},
74
+ year = {2024}
75
+ }
76
+
77
+ @Article{Davies_Towards_2022,
78
+ AUTHOR = {Davies, D. R. and Kramer, S. C. and Ghelichkhan, S. and Gibson, A.},
79
+ TITLE = {Towards automatic finite-element methods for geodynamics via Firedrake},
80
+ JOURNAL = {Geoscientific Model Development},
81
+ VOLUME = {15},
82
+ YEAR = {2022},
83
+ NUMBER = {13},
84
+ PAGES = {5127--5166},
85
+ URL = {https://gmd.copernicus.org/articles/15/5127/2022/},
86
+ DOI = {10.5194/gmd-15-5127-2022}
87
+ }
88
+
89
+ @Article{Ghelichkhan_Automatic_2024,
90
+ AUTHOR = {Ghelichkhan, S. and Gibson, A. and Davies, D. R. and Kramer, S. C. and Ham, D. A.},
91
+ TITLE = {Automatic adjoint-based inversion schemes for geodynamics: Reconstructing the evolution of Earth’s mantle in space and time},
92
+ JOURNAL = {EGUsphere},
93
+ VOLUME = {2023},
94
+ YEAR = {2023},
95
+ PAGES = {1--46},
96
+ URL = {https://egusphere.copernicus.org/preprints/2023/egusphere-2023-2683/},
97
+ DOI = {10.5194/egusphere-2023-2683}
98
+ }
99
+ </details>
100
+
101
+
102
+ Please also cite Firedrake using the instructions [here](https://www.firedrakeproject.org/citing.html).
gadopt-2.3.0/README.md ADDED
@@ -0,0 +1,80 @@
1
+ G-ADOPT
2
+ =======
3
+
4
+ This repository contains material and examples relating to the G-ADOPT
5
+ Platform, a computational platform for inverse geodynamics, being
6
+ developed and maintained by researchers from the Research School of
7
+ Earth Sciences at the Australian National University. It builds on a
8
+ recent surge in accessible observational datasets and advances in
9
+ inversion methods using sophisticated adjoint techniques that provide
10
+ a mechanism for fusing these observations with dynamics, physics and
11
+ chemistry.
12
+
13
+ G-ADOPT is supported and funded by the Australian Research Data
14
+ Commons (ARDC), with additional partner contributions from AuScope,
15
+ the NCI and Geosciences Australia.
16
+
17
+ Installation
18
+ ------------
19
+
20
+ G-ADOPT is available on PyPI as `gadopt`, and requires a working
21
+ [Firedrake](https://www.firedrakeproject.org/) installation. To bring
22
+ in the optional nonlinear optimisation dependencies, install the
23
+ `gadopt[optimisation]` variant. See [the G-ADOPT
24
+ website](https://gadopt.org/install/) for more detailed installation
25
+ instructions, including directions for getting started with the demo
26
+ notebooks.
27
+
28
+ Citing
29
+ ------
30
+
31
+ If you use this software in your work, please cite the software using the following metadata and the two articles below:
32
+ <details>
33
+ <summary> APA references</summary>
34
+
35
+ Gibson, A., Davies, R., Kramer, S., Ghelichkhan, S., Turner, R., Duvernay, T., & Scott, W. (2024). G-ADOPT (Version v2.2.0) [Computer software]. https://doi.org/10.5281/zenodo.5644391
36
+
37
+ Davies, D. R., Kramer, S. C., Ghelichkhan, S., & Gibson, A. (2022). Towards automatic finite-element methods for geodynamics via Firedrake. Geoscientific Model Development, 15(13), 5127–5166. doi:10.5194/gmd-15-5127-2022
38
+
39
+ Ghelichkhan, S., Gibson, A., Davies, D. R., Kramer, S. C., & Ham, D. A. (2023). Automatic adjoint-based inversion schemes for geodynamics: Reconstructing the evolution of Earth’s mantle in space and time. EGUsphere, 2023, 1–46. doi:10.5194/egusphere-2023-2683
40
+ </details>
41
+
42
+ <details>
43
+ <summary> Bibtex references</summary>
44
+
45
+ @software{Gibson_G-ADOPT_2024,
46
+ author = {Gibson, Angus and Davies, Rhodri and Kramer, Stephan and Ghelichkhan, Sia and Turner, Ruby and Duvernay, Thomas and Scott, Will},
47
+ doi = {10.5281/zenodo.5644391},
48
+ month = feb,
49
+ title = {{G-ADOPT}},
50
+ url = {https://github.com/g-adopt/g-adopt},
51
+ version = {v2.2.0},
52
+ year = {2024}
53
+ }
54
+
55
+ @Article{Davies_Towards_2022,
56
+ AUTHOR = {Davies, D. R. and Kramer, S. C. and Ghelichkhan, S. and Gibson, A.},
57
+ TITLE = {Towards automatic finite-element methods for geodynamics via Firedrake},
58
+ JOURNAL = {Geoscientific Model Development},
59
+ VOLUME = {15},
60
+ YEAR = {2022},
61
+ NUMBER = {13},
62
+ PAGES = {5127--5166},
63
+ URL = {https://gmd.copernicus.org/articles/15/5127/2022/},
64
+ DOI = {10.5194/gmd-15-5127-2022}
65
+ }
66
+
67
+ @Article{Ghelichkhan_Automatic_2024,
68
+ AUTHOR = {Ghelichkhan, S. and Gibson, A. and Davies, D. R. and Kramer, S. C. and Ham, D. A.},
69
+ TITLE = {Automatic adjoint-based inversion schemes for geodynamics: Reconstructing the evolution of Earth’s mantle in space and time},
70
+ JOURNAL = {EGUsphere},
71
+ VOLUME = {2023},
72
+ YEAR = {2023},
73
+ PAGES = {1--46},
74
+ URL = {https://egusphere.copernicus.org/preprints/2023/egusphere-2023-2683/},
75
+ DOI = {10.5194/egusphere-2023-2683}
76
+ }
77
+ </details>
78
+
79
+
80
+ Please also cite Firedrake using the instructions [here](https://www.firedrakeproject.org/citing.html).
@@ -0,0 +1,16 @@
1
+ nav:
2
+ - index.md
3
+ - Base case:
4
+ - base_case.ipynb
5
+ - Physical approximation:
6
+ - 2d_compressible_ALA.ipynb
7
+ - 2d_compressible_TALA.ipynb
8
+ - viscoplastic_case.ipynb
9
+ - Dimension:
10
+ - 3d_cartesian.ipynb
11
+ - Geometry:
12
+ - 2d_cylindrical.ipynb
13
+ - 3d_spherical.ipynb
14
+ - Multi-material:
15
+ - compositional_buoyancy.ipynb
16
+ - thermochemical_buoyancy.ipynb