tpackage_contents.md - Granular.jl - Julia package for granular dynamics simulation
HTML git clone git://src.adamsgaard.dk/Granular.jl
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
tpackage_contents.md (2373B)
---
1 # Package contents
2 This package follows the official
3 [guidelines](https://docs.julialang.org/en/latest/manual/packages/#Creating-a-new-Package-1)
4 for Julia package layout and contents.
5
6 ## File locations after installation
7 After installation, the package contents will be installed inside the hidden
8 `~/.julia/` folder in the home directory. The path can be printed from inside
9 the `julia` shell by the command:
10
11 ```julia-repl
12 julia> Pkg.dir("Granular")
13 "/Users/ad/.julia/v0.7/Granular"
14 ```
15
16 The above output will be different for different platforms and Julia versions.
17 In order to open this directory on macOS, run the following command:
18
19 ```julia-repl
20 julia> run(`open $(Pkg.dir("Granular"))`)
21 ```
22
23 On Linux, use the following command:
24
25 ```julia-repl
26 julia> run(`xdg-open $(Pkg.dir("Granular"))`)
27 ```
28
29 The above commands will open the directory containing all of the Granular.jl
30 components. The main component of Granular.jl is the source code contained in
31 the [src/](https://github.com/anders-dc/Granular.jl/tree/master/src) directory.
32 The [docs/](https://github.com/anders-dc/Granular.jl/tree/master/docs)
33 directory contains the documentation source via Markdown files. The online
34 documentation is generated from these files via
35 [Documenter.jl](https://juliadocs.github.io/Documenter.jl/stable/) by the
36 [docs/make.jl](https://github.com/anders-dc/Granular.jl/blob/master/docs/make.jl)
37 script. The documentation consists of manual pages, as well as auto-generated
38 API reference that is parsed from the documentation of the Granular.jl source
39 code ([src/](https://github.com/anders-dc/Granular.jl/tree/master/src)
40 directory).
41
42 ## Example scripts
43 The [examples](https://github.com/anders-dc/Granular.jl/tree/master/examples)
44 directory contains several annotated examples, which are useful for getting
45 started with the Granular.jl package and for demonstrating some of its
46 features. The examples are generally heavily annotated with comments to
47 illustrate the purpose of the included commands.
48
49 The examples can be run by either navigating to the examples directory from the
50 command line, and launching them with a command like `julia -e logo.jl`, or
51 directly from the julia shell with:
52
53 ```julia-repl
54 julia> include("$(Pkg.dir("Granular"))/examples/logo.jl")
55 ```
56
57 It is recommended that the source code of the examples is inspected beforehand.