The subpackage QEDevents.jl needs to be integrated into QED.jl. This includes the following tasks
[ ] make the top-level namespace of QEDevents.jl available in QED.jl
[ ] add docs of QEDevents.jl as a page to the docs of QED.jl
[ ] add integration tests from QEDevents.jl into the test suite of QED.jl
[ ] pin the version of QEDevents.jl used in the current version of QED.jl
Requirements
The following items are required for QEDevents.jl to be integrated into QED.jl:
[ ] implement necessary functions and data types to convert the differential cross-section of a given scattering process into a probability distribution
[ ] implement sampler, pdf, and rand functions for the probability distributions to follow the random number interface of Julia
[ ] unit tests to check the exposed functions for correctness (this will be called by QED.jl test suite)
[ ] integration tests for any dependency within QED.jl (this will be called by QED.jl test suite)
The docs of QEDevents.jl should at least contain
[ ] a landing page in the QEDevents.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 QEDevents.jl
[ ] a quickstart section showing the main functionality
The subpackage
QEDevents.jlneeds to be integrated intoQED.jl. This includes the following tasksQEDevents.jlavailable inQED.jlQEDevents.jlas a page to the docs ofQED.jlQEDevents.jlinto the test suite ofQED.jlQEDevents.jlused in the current version ofQED.jlRequirements
The following items are required for
QEDevents.jlto be integrated intoQED.jl:randfunctions for the probability distributions to follow the random number interface of JuliaQED.jltest suite)QED.jl(this will be called byQED.jltest suite)The docs of
QEDevents.jlshould at least containQEDevents.jldocs describing the purpose of the packageQEDevents.jl