Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.92 KB

README.md

File metadata and controls

53 lines (36 loc) · 1.92 KB
Raw

QEDfields

Doc Stable Doc Dev Code Style: Blue

⚠️ This package is under construction and only contains dummy functionality for testing.

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

# add local registry, where QEDfields is registered
julia> Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/QEDjl-project/registry"))
# add general registry again to have it join the local registry
julia> Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/JuliaRegistries/General"))

julia> Pkg.add("QEDfields")

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

# add local registry, where QEDfields is registered
(@v1.9) pkg> registry add https://github.com/QEDjl-project/registry
# add general registry again to have it join the local registry
(@v1.9) pkg> registry add https://github.com/JuliaRegistries/General

(@v1.9) pkg> add QEDfields

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

(@v1.9) 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