Deprecate Fenrir.jl (#30)

* Add a deprecation warning that is shown whenever Fenrir is loaded * Add the deprecation notice to the README * Set an upper bound for the Julia compat * Fix compat issue
nathanaelbosch · Feb 7, 2024 · 8e9af00 · 8e9af00
1 parent d137b81
commit 8e9af00
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/Project.toml b/Project.toml
@@ -16,7 +16,7 @@ LinearAlgebra = "1"
 ProbNumDiffEq = "0.11,0.12,0.13,0.14"
 SimpleUnPack = "1"
 Statistics = "1"
-julia = "1.7"
+julia = "1.7 - 1.10"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

diff --git a/README.md b/README.md
@@ -1,3 +1,6 @@
+**This package is deprecated and will not be maintained anymore, as the functionality of Fenrir.jl is now implemented in [ProbNumDiffEq.jl](https://github.com/nathanaelbosch/ProbNumDiffEq.jl). Just use [ProbNumDiffEq.jl](https://github.com/nathanaelbosch/ProbNumDiffEq.jl) directy.**
+
+
 # Fenrir: Physics-Enhanced Regression for IVPs
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://nathanaelbosch.github.io/Fenrir.jl/stable)

diff --git a/src/Fenrir.jl b/src/Fenrir.jl
@@ -10,4 +10,14 @@ using SimpleUnPack
 include("likelihood.jl")
 export fenrir_nll
 
+function __init__()
+    # Deprecation warning: This package will not be maintained in the future.
+    @warn("""\n
+        # Deprecation warning: This package will not be maintained in the future.
+        The `fenrir_nll` function implemented in this package is now implemented in
+        ProbNumDiffEq.jl, together with other data likelihood functions. So, instead of
+        using Fenrir.jl, use ProbNumDiffEq.jl.
+    """)
+end
+
 end