Merge branch 'main' into dependabot/github_actions/actions/cache-4

Author: amaurigmartins

.github/workflows/CI.yml

@@ -25,33 +25,55 @@ jobs:
       matrix:
         version:
           - '1.11'
+          - 'pre'
         os:
           - ubuntu-latest
         arch:
           - x64
     steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v5
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v4
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
-      - name: Run tests
-        uses: julia-actions/julia-runtest@v1
-        with:
-          annotate: true
+      - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
-      - name: Upload results to Codecov
-        uses: codecov/codecov-action@v5
+      - uses: codecov/codecov-action@v5
         with:
+          files: lcov.info
           token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false
+  docs:
+    if: ${{ !contains(github.event.head_commit.message, 'skip ci') }}
+    name: Documentation
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created
+      contents: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v5
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v2
+      - name: Configure doc environment
+        shell: julia --project=docs --color=yes {0}
+        run: |
+          using Pkg
+          Pkg.develop(PackageSpec(path=pwd()))
+          Pkg.instantiate()
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      - name: Run doctests
+        shell: julia --project=docs --color=yes {0}
+        run: |
+          using Documenter: DocMeta, doctest
+          using LineCableModels
+          DocMeta.setdocmeta!(LineCableModels, :DocTestSetup, :(using LineCableModels); recursive=true)
+          doctest(LineCableModels)

.github/workflows/create-release.yml

@@ -12,7 +12,7 @@ jobs:
       contents: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Extract Changelog Section
         id: changelog

.github/workflows/make-docs.yml

@@ -17,7 +17,7 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - uses: "actions/checkout@v4"
+      - uses: "actions/checkout@v5"
       - name: "TODO to Issue"
         uses: "alstr/todo-to-issue-action@v5"
         env:

.github/workflows/todo-to-issue.yml

@@ -27,6 +27,7 @@ Manifest.toml
 
 # the hidden folder of shame
 temp/
+@INPROGRESS/
 
 # Internal files
 dev
@@ -41,4 +42,12 @@ confidential/
 !.vscode/tasks.json
 onelab
 showcase
-!showcase/*.jl
+!showcase/*.jl
+papers
+sprint
+*/fem_output
+.github/*.md
+.github/instructions
+.github/prompts
+test/jl_*
+*.sh

.gitignore

@@ -1,3 +1,10 @@
 {
-    "julia.environmentPath": "/home/amartins/Documents/KUL/LineCableModels/dev"
+    "files.exclude": {
+        "**/.github": true,
+        "**/.vscode": true,
+        "**/@INPROGRESS": true,
+        "**/docs": true,
+        "**/examples": true,
+        "**/test": true
+    }
 }

.vscode/settings.json

@@ -6,7 +6,7 @@
                 "panel": "new",
                 "reveal": "always"
             },
-            "command": "julia --project=test -e 'include(\"test/runtests.jl\")'",
+            "command": "julia --project=. -e \"using Pkg; Pkg.test()\"",
             "problemMatcher": [],
             "type": "shell",
             "group": {
@@ -23,7 +23,7 @@
                 "clear": true,
                 "close": true
             },
-            "command": "julia --project -e 'include(\"docs/setup.jl\"); include(\"docs/make.jl\")'",
+            "command": "cd docs && julia --project=. -e \"using Pkg; Pkg.develop(PackageSpec(path=\\\"..\\\")); Pkg.instantiate()\" && julia --project=. make.jl",
             "options": {
                 "cwd": "${workspaceFolder}"
             },
@@ -35,15 +35,18 @@
             }
         },
         {
-            "label": "⚙️ Redefine All Environments",
+            "label": "🧹 Clean Documentation",
             "presentation": {
                 "panel": "new",
                 "showReuseMessage": false,
                 "reveal": "always",
                 "clear": true,
                 "close": true
             },
-            "command": "julia -e 'include(\"setup.jl\"); setup_envs_only()'",
+            "command": "rm -rf docs/build",
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
             "problemMatcher": [],
             "type": "shell",
             "group": {
@@ -52,21 +55,13 @@
             }
         },
         {
-            "label": "🔧 Setup VSCode Configuration",
-            "presentation": {
-                "panel": "new",
-                "showReuseMessage": false,
-                "reveal": "always",
-                "clear": true,
-                "close": true
-            },
-            "command": "julia -e 'include(\"setup.jl\"); setup_vscode_only()'",
-            "problemMatcher": [],
-            "type": "shell",
-            "group": {
-                "kind": "build",
-                "isDefault": false
-            }
+            "label": "📂 Open Julia config folder",
+            "type": "process",
+            "command": "xdg-open", // Use "open" on macOS, "explorer" on Windows
+            "args": [
+                "${env:HOME}/.julia/config/"
+            ],
+            "problemMatcher": []
         }
     ],
     "version": "2.0.0"

.vscode/tasks.json

@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Included interface to run finite element simulations using [Onelab](https://onelab.info/).
+
 - Included basic coverage tests.
 
 - Included import/export of CableDesigns to JSON files.

CHANGELOG.md

@@ -15,18 +15,28 @@ DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 EzXML = "8f5d6c58-4d21-5cfd-889c-e3ad7ee6a615"
 ForceImport = "9dda63f9-cce7-5873-89fa-eccbb2fffcde"
+Functors = "d9f16b24-f501-4c13-a1f2-28368ffc5196"
+GetDP = "dbfd83e6-7aba-450b-9c2b-93ccd973023a"
 Gmsh = "705231aa-382f-11e9-3f0c-b7cb4346fdeb"
 JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
+LoggingExtras = "e6f89c97-d47a-5376-807f-9c37f3926c36"
+MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+PkgTemplates = "14b8a8f1-9102-5b29-a752-f990bacb7fe1"
 PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
+[sources]
+GetDP = {rev = "main", url = "https://github.com/Electa-Git/GetDP.jl"}
+
 [compat]
 CSV = "0.10.15"
 ColorSchemes = "3.27.1"
@@ -38,46 +48,30 @@ DisplayAs = "0.1.6"
 DocStringExtensions = "0.9.3"
 EzXML = "1.2.0"
 ForceImport = "0.0.3"
+Functors = "0.5.2"
 Gmsh = "0.3.1"
-HypertextLiteral = "0.9.5"
 JSON3 = "1.14.2"
 LinearAlgebra = "1.11.0"
+Logging = "1.11.0"
+LoggingExtras = "1.1.0"
+MacroTools = "0.5.16"
 Measurements = "2.11.0"
 Pkg = "1.11.0"
+PkgTemplates = "0.7.56"
 PlotlyJS = "0.18.15"
 Plots = "1.40.9"
+Printf = "1.11.0"
 Reexport = "1.2.2"
-Revise = "3.7.2"
 Serialization = "1.11.0"
 SpecialFunctions = "2.5.0"
 Statistics = "1.11.1"
+TestItemRunner = "1.1.0"
 
 [extras]
-ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"
-BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
-Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Coverage = "a2441757-f6aa-5fb2-8edb-039e3f45d037"
-DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6"
-Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
-Infiltrator = "5903a43b-9cc3-4c30-8d17-598619ec4e9b"
-JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
-JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
-Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
-LocalRegistry = "89398ba2-070a-4b16-a995-9893c55d93cf"
-PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
-Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
-Pluto = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
-PlutoUI = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
-ProfileView = "c46f51b8-102a-5cf2-8d2c-8597cb0e0da7"
-Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
-SymSpellChecker = "bb1b64e9-0ccc-445c-80cb-5313b9f7dfe1"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 TestItemRunner = "f8b46487-2199-4994-9208-9a1283c18c0a"
-HypertextLiteral = "ac1192a8-f4b3-4bfe-ba22-af5b92cd3ab2"
 
 [targets]
-dev = ["ArgParse", "BenchmarkTools", "Infiltrator", "JET", "JuliaFormatter", "LocalRegistry", "ProfileView", "Revise", "SymSpellChecker", "TestItemRunner"]
-docs = ["Pluto", "PlutoUI", "Changelog", "DisplayAs", "Documenter", "DocumenterCitations", "Literate", "HypertextLiteral", "DataFrames", "Plots", "PlotlyJS", "JSON3"]
-test = ["Test", "Coverage"]
+test = ["Test", "Coverage", "SafeTestsets", "TestItemRunner"]