diff --git a/README.md b/README.md index ce9b99ef44f99b3b03b1922425191e979c3da4c9..35166c0e6142e4cf6d63facc6da189ba2171a03e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -[](https://travis-ci.org/DynareTeam/Dynare.jl) - ## Dynare for Julia This package aims at bringing to Julia some of the functionality provided by @@ -13,18 +11,86 @@ time. For the moment the package is only able to compute a model’s steady state, first order decision rules and perfect foresight simulations. -The package is tested against Julia 0.6.x. +The package is tested against Julia 1.0.x and 1.2.x. ## Installation Assuming you already have [julia](https://julialang.org/) (version -0.6.x), just do: +1.0.x), enter the Pkg REPL by pressing ] from the Julia REPL.: ```jl - julia> Pkg.clone("https://github.com/DynareTeam/Dynare.jl", "Dynare") - julia> Pkg.clone("Dynare", "with-preprocessor") - julia> Pkg.build("Dynare") + (v1.0) pkg> add https://git.dynare.org/Dynare/Dynare.jl#with-preprocessor ``` -The last command will install the preprocessor, selecting the binary +This will also install the preprocessor, selecting the binary corresponding to your platform (Linux/Windows/MacOS). If you do not -already have them, other packages will be fetched during the installation. +already have them, other required packages will be fetched during the installation. + +## Update + +To update the julia codes and the preprocessor, again the Pkg REPL, do: +```jl + (v1.0) pkg> up Dynare +``` +## Check + +The package comes with a testsuite, to check that evrything is fine with the installation, do (still in the Pkg REPL): +```jl + (v1.0) pkg> up Dynare +``` +you should then obtain something like: +```jl + Testing Dynare + Status `/tmp/jl_BASs9T/Manifest.toml` + [4fba245c] ArrayInterface v1.2.1 + [9e28174c] BinDeps v0.8.10 + [b99e7846] BinaryProvider v0.5.6 + [49dc2e85] Calculus v0.5.0 + [bbf7d656] CommonSubexpressions v0.2.0 + [34da2185] Compat v2.2.0 + [01453d9d] DiffEqDiffTools v1.3.0 + [163ba53b] DiffResults v0.0.4 + [b552c78f] DiffRules v0.0.10 + [b4f34e82] Distances v0.8.2 + [63ac760c] Dynare v0.0.0 #with-preprocessor (https://git.dynare.org/Dynare/Dynare.jl) + [f6369f11] ForwardDiff v0.10.3 + [d3d80556] LineSearches v7.0.1 + [d41bc354] NLSolversBase v7.5.0 + [2774e3e8] NLsolve v4.1.0 + [77ba4419] NaNMath v0.3.2 + [bac558e1] OrderedCollections v1.1.0 + [d96e819e] Parameters v0.12.0 + [189a3867] Reexport v0.2.0 + [ae029012] Requires v0.5.2 + [276daf66] SpecialFunctions v0.8.0 + [90137ffa] StaticArrays v0.11.0 + [fd094767] Suppressor v0.1.1 + [30578b45] URIParser v0.4.0 + [2a0f44e3] Base64 [`@stdlib/Base64`] + [ade2ca70] Dates [`@stdlib/Dates`] + [8bb1440f] DelimitedFiles [`@stdlib/DelimitedFiles`] + [8ba89e20] Distributed [`@stdlib/Distributed`] + [b77e0a4c] InteractiveUtils [`@stdlib/InteractiveUtils`] + [76f85450] LibGit2 [`@stdlib/LibGit2`] + [8f399da3] Libdl [`@stdlib/Libdl`] + [37e2e46d] LinearAlgebra [`@stdlib/LinearAlgebra`] + [56ddb016] Logging [`@stdlib/Logging`] + [d6f4376e] Markdown [`@stdlib/Markdown`] + [a63ad114] Mmap [`@stdlib/Mmap`] + [44cfe95a] Pkg [`@stdlib/Pkg`] + [de0858da] Printf [`@stdlib/Printf`] + [3fa0cd96] REPL [`@stdlib/REPL`] + [9a3f8284] Random [`@stdlib/Random`] + [ea8e919c] SHA [`@stdlib/SHA`] + [9e88b42a] Serialization [`@stdlib/Serialization`] + [1a1011a3] SharedArrays [`@stdlib/SharedArrays`] + [6462fe0b] Sockets [`@stdlib/Sockets`] + [2f01184e] SparseArrays [`@stdlib/SparseArrays`] + [10745b16] Statistics [`@stdlib/Statistics`] + [8dfed614] Test [`@stdlib/Test`] + [cf7118a7] UUIDs [`@stdlib/UUIDs`] + [4ec0a83e] Unicode [`@stdlib/Unicode`] + 6.029385 seconds (10.42 M allocations: 512.897 MiB, 4.70% gc time) +Test Summary: | Pass Total +Dynare.jl testsuite | 188 188 + Testing Dynare tests passed +```