Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs from the perspective of Julia beginner #3

Merged
merged 3 commits into from
Nov 14, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.