diff --git a/README.md b/README.md index e1442aac93c14cb2b133779392460c57bc927309..773c539b16db3dd6b0772ea3d0cc46f658dfa04e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,21 @@ # SemiSmoothNewton -Research code to produce numerical results for [1]. +Research code to produce numerical results for [1, 2]. Read and use at your own risk. -[1] Martin Alkämper, Stephan Hilb and Andreas Langer. 'A primal-dual adaptive -finite element method for scalar and vectorial total variation minimization'. -In preparation. 2022 +## Getting started + +Adjust data paths and experiments in `run.jl`, install dependencies and run: +```julia +using Pkg; Pkg.instantiate() +include("run.jl") +``` + +## References + +[1] Hilb S., Langer A, Alkämper M.: A primal-dual finite element method for +scalar and vectorial total variation minimization. Journal of Scientific +Computing 96, 24 (2023). +https://doi.org/10.1007/s10915-023-02209-2 +[2] Hilb S., Langer A, Alkämper M.: A primal-dual adaptive finite element +method for total variation minimization. (2024). \[Submitted\]