QEDjl-project / QED.jl

[WIP] QED.jl: A strong-field particle physics framework

MIT License

5 stars 3 forks source link

Integrate QEDbase.jl #6

Open szabo137 opened 1 year ago

szabo137 commented 1 year ago

The subpackage QEDbase.jl needs to be integrated into QED.jl. This includes the following tasks:

[ ] make the top-level namespace of QEDbase.jl available in QED.jl
[ ] add docs of QEDbase.jl to the docs of QED.jl
[ ] pin the version of QEDbase.jl used in the current version of QED.jl

No integration test is needed because QEDbase.jl is designed to have no dependencies within QED.jl.

Requirements

The following items are required for QEDbase.jl to be included:

[ ] implementations for four-momenta and particle spinors together with the necessary underlying datatypes and functionalities
[ ] unit tests to check the exposed functions for correctness (this will be called by QED.jl test suite)

The docs of QEDbase.jl should at least contain

[ ] a landing page in the QEDbase.jl docs describing the purpose of the package
[ ] API reference for all exposed functions and data types, as well as the respective page in the docs of QEDbase.jl
[ ] a quickstart section showing the main functionality