Skip to content

Commit

Permalink
Merge pull request #3 from andriish/beginner_docs
Browse files Browse the repository at this point in the history
Docs from the perspective of Julia beginner
  • Loading branch information
cescalara authored Nov 14, 2021
2 parents 1ec93df + a6a3cfd commit 2ad04ac
Showing 1 changed file with 50 additions and 2 deletions.
52 changes: 50 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,60 @@

Fast QCD evolution and convolution.

QCDNUM.jl is a Julia wrapper for Michiel Botje's [QCDNUM](https://www.nikhef.nl/~h24/qcdnum/), written in Fortran77. QCDNUM.jl is currently under development and more functionality and documentation will be added soon.
QCDNUM.jl is a Julia wrapper for Michiel Botje's [QCDNUM](https://www.nikhef.nl/~h24/qcdnum/), written in Fortran77.
QCDNUM.jl is currently under development and more functionality and documentation will be added soon.

## Installation

Install from GitHub in Julia's [Pkg REPL](https://docs.julialang.org/en/v1.6/stdlib/Pkg/):
The QCDNUM package can be installed either from the github repository in a semi-automatic way or from the local derectory

### Installation from github

- Start Julia interpreter and the to open the Julia package management environment pressing ``]``.
```
julia> ]
```

- Install from GitHub in Julia's [Pkg REPL](https://docs.julialang.org/en/v1.6/stdlib/Pkg/):
```
pkg> add https://github.com/cescalara/QCDNUM.jl.git
```

- Exit the package manager using backspace or pressing `Ctrl+C`


### Installation from local directory

- Clone the github repository, e.g.
```
git clone https://github.com/cescalara/QCDNUM.jl.git
```

- Enter the directory and start Julia interpreter
```
cd QCDNUM.jl
julia
```

- Open the Julia package management environment pressing ``]``.

```
julia> ]
```

- Execute
```
(@v1.6) pkg> generate QCDNUM
......
(@v1.6) pkg> . dev
```
- Exit the package manager using backspace or pressing `Ctrl+C`


In both cases the QCDNUM package will be available via `using QCDNUM`.
To show the available functions, execute
```
names(QCDNUM, all=true)
```
in the Julia interpreter.

0 comments on commit 2ad04ac

Please sign in to comment.