QEDjl-project / QEDprocesses.jl

[WIP]: QEDprocesses.jl: Modeling of scattering processes for QED.jl
MIT License
1 stars 3 forks source link

QEDprocesses

Doc Stable Doc Dev Code Style: Blue

Installation

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

julia> using Pkg

julia> Pkg.add("QEDprocesses")

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

(@v1.9) pkg> add QEDprocesses

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

(@v1.9) pkg> add ./QEDprocesses.jl

Building the documentation locally

To build the documentation of QEDprocesses.jl locally, first clone this repository. Then, you instantiate the documentation subpackage by hitting

julia --project=docs -e 'using Pkg; Pkg.instantiate(); Pkg.develop(PackageSpec(path=pwd()))'

in the root directory of this repository. Afterwards, the dokumentation can be built by running

julia --project=docs --color=yes docs/make.jl

To access the documentation site, just open the file docs/_build/index.html in your favorite browser.