installation.md (2824B)
1 # Installation 2 3 ## Prerequisites 4 Granular.jl is written as a package for the [Julia programming 5 language](https://julialang.org), which is a computationally efficient, yet 6 high-level language. Julia also includes a very useful package manager which 7 makes it easy to install packages and their requirements, as well as convenient 8 updating features. 9 10 ### Installing Julia 11 If you do not have Julia installed, download the current release from the 12 [official Julia download page](https://julialang.org/downloads), or using your 13 system package manager (e.g. `brew cask install julia` on macOS with the 14 [Homebrew package manager](https://brew.sh)). Afterwards, the program `julia` 15 can be launched from the terminal. 16 17 ### Installing Paraview 18 The core visualization functionality of Granular.jl is based on VTK and 19 ParaView. The most recent stable release can be downloaded from the [ParaView 20 downloads page](https://www.paraview.org/download/). Alternatively, on macOS 21 with Homebrew, Paraview can be installed from the terminal with `brew cask 22 install paraview`. 23 24 ## Stable installation (recommended) 25 The latest stable release of Granular.jl can be installed directly from the 26 Julia shell by: 27 28 ```julia-repl 29 julia> ] 30 (v1.0) pkg> add Granular 31 ``` 32 33 This will install the contents of this repository in the folder 34 `~/.julia/packages/Granular` and install its requirements. 35 36 ## Development installation 37 If desired, the current developmental version of the [Granular.jl Github 38 repository](https://github.com/anders-dc/Granular.jl) can be installed with the 39 command: 40 41 ```julia-repl 42 julia> ] 43 (v1.0) pkg> add Granular#master 44 ``` 45 46 *Please note:* The developmental version is considered unstable and should only 47 be used over the stable version if there is a compelling reason to do so. 48 49 If you want to modify the code base, install the source code in the 50 `~/.julia/dev/` directory with the following command: 51 52 ```julia-repl 53 (v1.0) pkg> dev Granular 54 ``` 55 56 ## Package tests 57 The Granular.jl package contains many tests that verify that the functionality 58 works as intended. The extent of test coverage of the source code is monitored 59 and published with [CodeCov](https://codecov.io/gh/anders-dc/Granular.jl). 60 61 The package tests are during development continuously run with 62 [Travis-CI](https://travis-ci.org/anders-dc/Granular.jl) for Mac (latest stable 63 release) and Linux (Ubuntu stable), and 64 [AppVeyor](https://ci.appveyor.com/project/anders-dc/seaice-jl) for Windows. 65 66 The test scripts are contained in the `test/` directory, can be run locally 67 with the following command: 68 69 ```julia-repl 70 julia> ] 71 (v1.0) pkg> test Granular 72 ``` 73 74 In case any of these tests fail, please open a [Github 75 Issue](https://github.com/anders-dc/Granular.jl/issues) describing the problems 76 so further investigation and diagnosis can follow. 77