Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.3 KB

README.md

File metadata and controls

40 lines (30 loc) · 1.3 KB
Raw

MathStudy

This code base is using the Julia Language and DrWatson to make a reproducible scientific project named

MathStudy

It is authored by AronT-Tlv.

To (locally) reproduce this project, do the following:

  1. Download this code base. Notice that raw data are typically not included in the git-history and may need to be downloaded independently.
  2. Open a Julia console and do: 
    julia> using Pkg
julia> Pkg.add("DrWatson") # install globally, for using `quickactivate`
julia> Pkg.activate("path/to/this/project")
julia> Pkg.instantiate()

This will install all necessary packages for you to be able to run the scripts and everything should work out of the box, including correctly finding local paths.

You may notice that most scripts start with the commands:

using DrWatson
@quickactivate "MathStudy"

which auto-activate the project and enable local path handling from DrWatson.

Some documentation has been set up for this project. It can be viewed by running the file docs/make.jl, and then launching the generated file docs/build/index.html. Alternatively, the documentation may be already hosted online. If this is the case it should be at:

https://FourMInfo.github.io/MathStudy/dev/