Skip to content

QEDjl-project/QEDfields.jl

Repository files navigation

QEDfields

Doc Stable Doc Dev Code Style: Blue

Installation

To install the current stable version of QEDfields.jl you may use the standard julia package manager within the julia REPL

julia> using Pkg
julia> Pkg.add("QEDfields")

or you use the Pkg prompt by hitting ] within the Julia REPL and then type

(@v1.10) pkg> add QEDfields

To install the locally downloaded package on Windows, change to the parent directory and type within the Pkg prompt

(@v1.10) pkg> add ./QEDfields.jl

Development

Formatting

We use JuliaFormatter.jl and the Blue style to format our code. The correct form of the code is checked by a CI job. To format the code manually, run the following commands:

# install dependencies
julia --project=.formatting -e 'import Pkg; Pkg.instantiate()'
# format all documents
julia --project=.formatting .formatting/format_all.jl