Rename to Ariadne (#30)

vchuravy · web-flow · commit c6ec180d49ca · 2025-05-26T15:31:08.000+02:00
diff --git a/.github/workflows/Comment.yml b/.github/workflows/Comment.yml
@@ -11,5 +11,5 @@ jobs:
         if: github.event_name == 'pull_request' && github.repository == github.event.pull_request.head.repo.full_name
         uses: thollander/actions-comment-pull-request@71efef56b184328c7ef1f213577c3a90edaa4aff
         with:
-          message: 'Once the build has completed, you can preview your PR at this URL: https://vchuravy.dev/NewtonKrylov.jl/previews/PR${{ github.event.number }}/ in a couple of minutes.'
+          message: 'Once the build has completed, you can preview your PR at this URL: https://vchuravy.dev/Ariadne.jl/previews/PR${{ github.event.number }}/ in a couple of minutes.'
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -31,9 +31,9 @@ jobs:
         run: |
           julia --project=docs -e '
             using Documenter: DocMeta, doctest
-            using NewtonKrylov
-            DocMeta.setdocmeta!(NewtonKrylov, :DocTestSetup, :(using NewtonKrylov); recursive=true)
-            doctest(NewtonKrylov)
+            using Ariadne
+            DocMeta.setdocmeta!(Ariadne, :DocTestSetup, :(using Ariadne); recursive=true)
+            doctest(Ariadne)
           '
       - name: generate docs
         run: julia --project=docs docs/make.jl
diff --git a/Project.toml b/Project.toml
@@ -1,4 +1,4 @@
-name = "NewtonKrylov"
+name = "Ariadne"
 uuid = "0be81120-40bf-4f8b-adf0-26103efb66f1"
 authors = ["Valentin Churavy <v.churavy@gmail.com>"]
 version = "0.1.0"
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -7,11 +7,11 @@ Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
 KrylovPreconditioners = "45d422c2-293f-44ce-8315-2cb988662dec"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
-NewtonKrylov = "0be81120-40bf-4f8b-adf0-26103efb66f1"
+Ariadne = "0be81120-40bf-4f8b-adf0-26103efb66f1"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
 PlutoStaticHTML = "359b1769-a58e-495b-9770-312e911026ad"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
 
 [sources]
-NewtonKrylov = {path = ".."}
+Ariadne = {path = ".."}
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,6 +1,6 @@
-pushfirst!(LOAD_PATH, joinpath(@__DIR__, "..")) # add NewtonKrylov to environment stack
+pushfirst!(LOAD_PATH, joinpath(@__DIR__, "..")) # add Ariadne to environment stack
 
-using NewtonKrylov
+using Ariadne
 using Documenter
 import Documenter.Remotes: GitHub
 using Literate
@@ -29,7 +29,7 @@ if get(ENV, "BUILD_DOCS_NOTEBOOKS", "true") == "true"
 end
 
 
-DocMeta.setdocmeta!(NewtonKrylov, :DocTestSetup, :(using NewtonKrylov); recursive = true)
+DocMeta.setdocmeta!(Ariadne, :DocTestSetup, :(using Ariadne); recursive = true)
 
 
 ##
@@ -61,13 +61,13 @@ examples = [title => joinpath("generated", string(name, ".md")) for (title, name
 bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"))
 
 makedocs(;
-    modules = [NewtonKrylov],
+    modules = [Ariadne],
     authors = "Valentin Churavy",
-    repo = GitHub("vchuravy", "NewtonKrylov.jl"),
-    sitename = "NewtonKrylov.jl",
+    repo = GitHub("vchuravy", "Ariadne.jl"),
+    sitename = "Ariadne.jl",
     format = Documenter.HTML(;
         prettyurls = get(ENV, "CI", "false") == "true",
-        canonical = "https://vchuravy.dev/NewtonKrylov.jl",
+        canonical = "https://vchuravy.dev/Ariadne.jl",
         assets = [
             asset(
                 "https://plausible.io/js/plausible.js",
@@ -93,7 +93,7 @@ makedocs(;
 )
 
 deploydocs(;
-    repo = "github.com/vchuravy/NewtonKrylov.jl.git",
+    repo = "github.com/vchuravy/Ariadne.jl.git",
     devbranch = "main",
     push_preview = true,
 )
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,4 +1,4 @@
-# NewtonKrylov.jl
+# Ariadne.jl
 
 Newton Method using Krylov.jl (montoison-orban-2023)[@cite]
 
@@ -12,15 +12,15 @@ newton_krylov
 ### Parameters
 
 ```@docs
-NewtonKrylov.Forcing
-NewtonKrylov.Fixed
-NewtonKrylov.EisenstatWalker
+Ariadne.Forcing
+Ariadne.Fixed
+Ariadne.EisenstatWalker
 ```
 
 ### Internal
 
 ```@docs
-NewtonKrylov.JacobianOperator
+Ariadne.JacobianOperator
 ```
 
 ## Bibliography
diff --git a/docs/src/notebooks/Project.toml b/docs/src/notebooks/Project.toml
@@ -1,12 +1,12 @@
 [deps]
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
-NewtonKrylov = "0be81120-40bf-4f8b-adf0-26103efb66f1"
+Ariadne = "0be81120-40bf-4f8b-adf0-26103efb66f1"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
 Pluto = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
 PlutoLinks = "0ff47ea0-7a50-410d-8455-4348d5de0420"
 PlutoUI = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
 SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
 
 [sources]
-NewtonKrylov = {path = "../../.."}
+Ariadne = {path = "../../.."}
diff --git a/docs/src/notebooks/heat_1D_DG.jl b/docs/src/notebooks/heat_1D_DG.jl
@@ -28,7 +28,7 @@ begin
 end
 
 # ╔═╡ 32e51b56-268b-11f0-2d27-f3a6d736affe
-@revise using NewtonKrylov
+@revise using Ariadne
 
 # ╔═╡ 42460e8e-91ea-488f-9833-c660d26bad75
 using SummationByPartsOperators
@@ -37,7 +37,7 @@ using SummationByPartsOperators
 using LinearAlgebra
 
 # ╔═╡ 5bffc041-0019-4f1f-9711-170b82f62926
-Implicit = @ingredients(joinpath(dirname(pathof(NewtonKrylov)), "../examples/implicit.jl"));
+Implicit = @ingredients(joinpath(dirname(pathof(Ariadne)), "../examples/implicit.jl"));
 
 # ╔═╡ 493850fa-87db-452d-961a-26f92c88d18f
 md"""
diff --git a/docs/src/notebooks/heat_2d.jl b/docs/src/notebooks/heat_2d.jl
@@ -28,7 +28,7 @@ begin
 end
 
 # ╔═╡ 0d2ecac4-e987-408f-8ffe-50f8c935b93d
-@revise using NewtonKrylov
+@revise using Ariadne
 
 # ╔═╡ 46f41bde-5d70-47a3-b010-8d1cfa02728e
 using Krylov
@@ -85,13 +85,13 @@ function diffusion!(du, u, (a, Δx, Δy, bc!), _)
 end
 
 # ╔═╡ 91d3c59d-a144-4dd2-9e1f-d532c010f442
-HaloVectors = @ingredients(joinpath(dirname(pathof(NewtonKrylov)), "../examples/halovector.jl"))
+HaloVectors = @ingredients(joinpath(dirname(pathof(Ariadne)), "../examples/halovector.jl"))
 
 # ╔═╡ 2031ff0e-3b8a-4b21-a49f-e661d810994f
 import .HaloVectors: HaloVector
 
 # ╔═╡ 8aebcc1b-ac2b-40a5-9ca2-cbf3e24fdbb8
-Implicit = @ingredients(joinpath(dirname(pathof(NewtonKrylov)), "../examples/implicit.jl"));
+Implicit = @ingredients(joinpath(dirname(pathof(Ariadne)), "../examples/implicit.jl"));
 
 # ╔═╡ 56354eaa-a634-45e1-9001-84c1d69f845f
 import .Implicit: jacobian, solve, G_Euler!
diff --git a/examples/Project.toml b/examples/Project.toml
@@ -6,11 +6,11 @@ KernelAbstractions = "63c18a36-062a-441e-b654-da1e3ab1ce7c"
 Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
 KrylovPreconditioners = "45d422c2-293f-44ce-8315-2cb988662dec"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
-NewtonKrylov = "0be81120-40bf-4f8b-adf0-26103efb66f1"
+Ariadne = "0be81120-40bf-4f8b-adf0-26103efb66f1"
 Observables = "510215fc-4207-5dde-b226-833fc4488ee2"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
 
 [sources]
-NewtonKrylov = {path = ".."}
+Ariadne = {path = ".."}
diff --git a/examples/bratu.jl b/examples/bratu.jl
@@ -1,7 +1,7 @@
 # # 1D bratu equation from (Kan2022-ko)[@cite]
 
 # ## Necessary packages
-using NewtonKrylov, Krylov
+using Ariadne, Krylov
 using KrylovPreconditioners
 using SparseArrays, LinearAlgebra
 using CairoMakie
@@ -94,7 +94,7 @@ _, stats = newton_krylov!(
     bratu!,
     copy(u₀), (dx, λ), similar(u₀);
     algo = :cg,
-    forcing = NewtonKrylov.Fixed(0.1)
+    forcing = Ariadne.Fixed(0.1)
 )
 stats
 
diff --git a/examples/bratu_ka.jl b/examples/bratu_ka.jl
@@ -1,7 +1,7 @@
 # # 1D bratu equation from (Kan2022-ko)[@cite]
 
 # ## Necessary packages
-using NewtonKrylov, Krylov
+using Ariadne, Krylov
 using KrylovPreconditioners
 using SparseArrays, LinearAlgebra
 using CairoMakie
diff --git a/examples/bvp.jl b/examples/bvp.jl
@@ -1,6 +1,6 @@
 # BVP from (Kelley2022)[@cite]
 
-using NewtonKrylov, Krylov, LinearAlgebra
+using Ariadne, Krylov, LinearAlgebra
 
 function Phi(t, tdag, vp, v)
     phi = 4.0 * tdag * vp + (t * v - 1.0) * v
diff --git a/examples/heat_1D.jl b/examples/heat_1D.jl
@@ -1,10 +1,10 @@
 # # Implicit time-integration
 
 # ## Necessary packages
-using NewtonKrylov
+using Ariadne
 using CairoMakie
 
-include(joinpath(dirname(pathof(NewtonKrylov)), "..", "examples", "implicit.jl"))
+include(joinpath(dirname(pathof(Ariadne)), "..", "examples", "implicit.jl"))
 
 # ## Heat 1D
 # $ \frac{\partial u(x, t)}{\partial t} = a * \frac{\partial^2 u(x, t)}{\partial x^2 $
diff --git a/examples/heat_1D_DG.jl b/examples/heat_1D_DG.jl
@@ -1,14 +1,14 @@
 # # Implicit time-integration (With DG)
 
 # ## Necessary packages
-using NewtonKrylov
+using Ariadne
 using CairoMakie
 using LinearAlgebra
 using SummationByPartsOperators
 
 # Include the implicit time-steppers from [`Implicit schemes`](@ref implicit_schemes)
 
-include(joinpath(dirname(pathof(NewtonKrylov)), "..", "examples", "implicit.jl"));
+include(joinpath(dirname(pathof(Ariadne)), "..", "examples", "implicit.jl"));
 
 # ## Setting up the space discretization
 xmin = 0.0
diff --git a/examples/heat_2D.jl b/examples/heat_2D.jl
@@ -1,12 +1,12 @@
 # # Implicit time-integration
 
 # ## Necessary packages
-using NewtonKrylov
+using Ariadne
 using CairoMakie
 using OffsetArrays
 
-include(joinpath(dirname(pathof(NewtonKrylov)), "..", "examples", "implicit.jl"))
-include(joinpath(dirname(pathof(NewtonKrylov)), "..", "examples", "halovector.jl"))
+include(joinpath(dirname(pathof(Ariadne)), "..", "examples", "implicit.jl"))
+include(joinpath(dirname(pathof(Ariadne)), "..", "examples", "halovector.jl"))
 
 # ## Diffusion 2D
 
diff --git a/examples/implicit.jl b/examples/implicit.jl
@@ -1,7 +1,7 @@
 # # [Implicit schemes](@id implicit_schemes)
-using NewtonKrylov
+using Ariadne
 
-using NewtonKrylov
+using Ariadne
 
 # ## Implicit Euler
 
@@ -45,7 +45,7 @@ function jacobian(G!, f!, uₙ, p, Δt, t)
 
     F!(res, u, (uₙ, Δt, du, p, t)) = G!(res, uₙ, Δt, f!, du, u, p, t)
 
-    J = NewtonKrylov.JacobianOperator(F!, res, u, (uₙ, Δt, du, p, t))
+    J = Ariadne.JacobianOperator(F!, res, u, (uₙ, Δt, du, p, t))
     return collect(J)
 end
 
diff --git a/examples/simple.jl b/examples/simple.jl
@@ -1,6 +1,6 @@
 ## Simple 2D example from (Kelley2003)[@cite]
 
-using NewtonKrylov, LinearAlgebra
+using Ariadne, LinearAlgebra
 using CairoMakie
 
 function F!(res, x, _)
@@ -41,7 +41,7 @@ lines!(ax, trace_2)
 trace_3 = let x₀ = [3.0, 4.0]
     xs = Vector{Tuple{Float64, Float64}}(undef, 0)
     hist(x, res, n_res) = (push!(xs, (x[1], x[2])); nothing)
-    x, stats = newton_krylov!(F!, x₀, nothing, callback = hist, forcing = NewtonKrylov.EisenstatWalker(η_max = 0.68949), verbose = 1)
+    x, stats = newton_krylov!(F!, x₀, nothing, callback = hist, forcing = Ariadne.EisenstatWalker(η_max = 0.68949), verbose = 1)
     @show stats.solved
     xs
 end
diff --git a/examples/spring.jl b/examples/spring.jl
@@ -1,12 +1,12 @@
 # # Implicit time-integration (Spring example)
 
 # ## Necessary packages
-using NewtonKrylov
+using Ariadne
 using CairoMakie
 
 # Include the implicit time-steppers from [`Implicit schemes`](@ref implicit_schemes)
 
-include(joinpath(dirname(pathof(NewtonKrylov)), "..", "examples", "implicit.jl"))
+include(joinpath(dirname(pathof(Ariadne)), "..", "examples", "implicit.jl"))
 
 # ## Spring equations
 
diff --git a/src/Ariadne.jl b/src/Ariadne.jl
@@ -1,4 +1,4 @@
-module NewtonKrylov
+module Ariadne
 
 export newton_krylov, newton_krylov!
 
@@ -371,4 +371,4 @@ function newton_krylov!(
     return u, (; solved = n_res <= tol, stats, t)
 end
 
-end # module NewtonKrylov
+end # module Ariadne
diff --git a/test/Project.toml b/test/Project.toml
@@ -2,7 +2,7 @@
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Enzyme = "7da242da-08ed-463a-9acd-ee780be4f1d9"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
-NewtonKrylov = "0be81120-40bf-4f8b-adf0-26103efb66f1"
+Ariadne = "0be81120-40bf-4f8b-adf0-26103efb66f1"
 
-[sources.NewtonKrylov]
+[sources.Ariadne]
 path = ".."
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,5 +1,5 @@
 using Test
-using NewtonKrylov
+using Ariadne
 
 function F!(res, x, _)
     res[1] = x[1]^2 + x[2]^2 - 2
@@ -22,7 +22,7 @@ let x₀ = [3.0, 5.0]
     @test stats.solved
 end
 
-import NewtonKrylov: JacobianOperator
+import Ariadne: JacobianOperator
 using Enzyme, LinearAlgebra
 
 @testset "Jacobian" begin

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name = "NewtonKrylov"`
	`1`	`+name = "Ariadne"`
`2`	`2`	`uuid = "0be81120-40bf-4f8b-adf0-26103efb66f1"`
`3`	`3`	`authors = ["Valentin Churavy <[email protected]>"]`
`4`	`4`	`version = "0.1.0"`