Skip to content

Commit

Permalink
Link to QED dev guide and correctly link the example pages (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonReinhard authored Sep 11, 2024
1 parent 1b9b331 commit 763ffc1
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ links = InterLinks(
"ComputableDAGs" => "https://computabledags.github.io/ComputableDAGs.jl/dev/",
"QEDbase" => "https://qedjl-project.github.io/QEDbase.jl/dev/",
"QEDcore" => "https://qedjl-project.github.io/QEDcore.jl/dev/",
"QuantumElectrodynamics" => "https://qedjl-project.github.io/QuantumElectrodynamics.jl/dev/",
)

# setup examples using Literate.jl
Expand Down
2 changes: 2 additions & 0 deletions docs/src/contribution.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Contribution

Feel free to open issues or pull requests to the official repository. Ideas, tips, bug reports, or contributions are all welcome.

As part of the [QEDjl-project](https://github.com/QEDjl-project), this repository uses gitflow. For details on the development and release process, see the [Development Guide](@extref QuantumElectrodynamics Development-Guide) in the `QuantumElectrodynamics.jl` documentation.
4 changes: 3 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# QEDFeynmanDiagrams.jl

This project is dedicated to generating Feynman diagrams for scattering processes in perturbative QED. It is part of the [QEDjl-project](https://github.com/QEDjl-project) and relies on [QEDcore.jl](https://github.com/QEDjl-project/QEDcore.jl).
Furthermore, it can generate code to compute the matrix element for scattering processes, using [ComputableDAGs.jl](https://github.com/ComputableDAGs/ComputableDAGs.jl) and [RuntimeGeneratedFunctions.jl](https://github.com/SciML/RuntimeGeneratedFunctions.jl). For an example usage see the Jupyter notebooks in the `notebooks` directory.
Furthermore, it can generate code to compute the matrix element for scattering processes, using [ComputableDAGs.jl](https://github.com/ComputableDAGs/ComputableDAGs.jl) and [RuntimeGeneratedFunctions.jl](https://github.com/SciML/RuntimeGeneratedFunctions.jl).

For example usage, see the [n-photon Compton](examples/compton.md) or [trident](examples/trident.md) pages.

The inner workings of the project are explained in the [manual](manual.md).

0 comments on commit 763ffc1

Please sign in to comment.