From dabc545dd0cee311a4be85e2b7529f6fbb609a6e Mon Sep 17 00:00:00 2001 From: Chris Scott Date: Wed, 18 Sep 2024 10:49:22 +1200 Subject: [PATCH] update docs to install from registry --- README.md | 31 +++++++++++++++++-------------- docs/Project.toml | 2 +- docs/src/index.md | 8 ++------ examples/ode_integration.jl | 2 +- examples/polynomial_inversion.jl | 2 +- examples/sine.jl | 2 +- 6 files changed, 23 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index cf1fc92..0a1e38d 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,22 @@ # DACE.jl -**Work in progress** +DACE.jl is a Julia interface to the [DACE](https://github.com/dacelib/dace) library. -Julia interface to [DACE](https://github.com/dacelib/dace). - -Documentation is [here](https://a-ev.github.io/DACE.jl/). +Documentation can be found [here](https://a-ev.github.io/DACE.jl/). ## Example usage -Install dependencies: +DACE.jl can be installed using the Julia package manager. From the Julia REPL, +type `]` to enter the Pkg REPL mode and run ``` -$ julia --project -(DACE) pkg> add https://github.com/a-ev/DACE.jl.git +pkg> add DACE ``` -Note: the `add` command above may not be needed if you are -running from the directory containing this file. - -Run an example: +Run a simple example: ``` -$ julia --project examples/sine.jl +$ julia examples/sine.jl x I COEFFICIENT ORDER EXPONENTS 1 1.0000000000000000e+00 1 1 @@ -47,9 +42,17 @@ sin(1.0) = 0.8414709848078965 More examples of how to use *DACE.jl* can be found in the tests, for example [validation_2.jl](test/validation_2.jl). -You can run the validation tests with (using `]` to enter pkg mode from the Julia REPL): +You can run the validation tests using the Julia package manager. +Clone this git repository and change into the cloned directory. +Then enter the Julia REPL using `julia --project` and +type `]` to enter the Pkg REPL mode and instantiate the package: + +``` +(DACE) pkg> instantiate +``` + +Then run the tests: ``` -$ julia --project (DACE) pkg> test ``` diff --git a/docs/Project.toml b/docs/Project.toml index 0fc0286..26061b8 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -10,7 +10,7 @@ DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" [compat] CxxWrap = "~0.16" -DACE_jll = "~0.4" +DACE_jll = "~0.5" DiffEqBase = "^6" SpecialFunctions = "^2" DocStringExtensions = "^0.9" diff --git a/docs/src/index.md b/docs/src/index.md index b77312e..5c6e959 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,8 +1,5 @@ # DACE.jl -!!! warning - This package is still in development, is not complete and instructions may change significantly - This is the documentation page for [DACE.jl](https://github.com/a-ev/DACE.jl), a Julia interface to the [DACE library](https://github.com/dacelib/dace). @@ -12,11 +9,9 @@ DACE.jl can be installed using the Julia package manager. From the Julia REPL, type `]` to enter the Pkg REPL mode and run ``` -pkg> add https://github.com/a-ev/DACE.jl.git +pkg> add DACE ``` -Note: the `add` command above may not be needed if you are running from main directory of the repository. - ## Notes about the interface - The Julia interface is built using [CxxWrap.jl](https://github.com/JuliaInterop/CxxWrap.jl) @@ -25,6 +20,7 @@ Note: the `add` command above may not be needed if you are running from main dir - The C++ code gets built by [BinaryBuilder](https://docs.binarybuilder.org/stable/) and released into the Julia registry - the build recipe is located [here](https://github.com/JuliaPackaging/Yggdrasil/tree/master/D/DACE) - The Julia component of the interface is currently [here](https://github.com/a-ev/DACE.jl) + - the DACE library has been released to the Julia General registry The above may change, in particular we hope to: diff --git a/examples/ode_integration.jl b/examples/ode_integration.jl index 6fc47e0..12e6971 100644 --- a/examples/ode_integration.jl +++ b/examples/ode_integration.jl @@ -16,7 +16,7 @@ # ```julia # using Pkg -# Pkg.add("https://github.com/a-ev/DACE.jl.git") +# Pkg.add("DACE") # ``` # ## Using DACE diff --git a/examples/polynomial_inversion.jl b/examples/polynomial_inversion.jl index 47b0486..7122ac0 100644 --- a/examples/polynomial_inversion.jl +++ b/examples/polynomial_inversion.jl @@ -14,7 +14,7 @@ # ```julia # using Pkg -# Pkg.add("https://github.com/a-ev/DACE.jl.git") +# Pkg.add("DACE") # ``` # ## Using DACE diff --git a/examples/sine.jl b/examples/sine.jl index 4929cbd..db68fe7 100644 --- a/examples/sine.jl +++ b/examples/sine.jl @@ -15,7 +15,7 @@ # ```julia # using Pkg -# Pkg.add("https://github.com/a-ev/DACE.jl.git") +# Pkg.add("DACE") # ``` # ## Using DACE