Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate QEDevents.jl #9

Open
11 tasks
szabo137 opened this issue Jul 16, 2023 · 0 comments
Open
11 tasks

Integrate QEDevents.jl #9

szabo137 opened this issue Jul 16, 2023 · 0 comments
Labels
06 - Feature-request Missing feature or functionality 07 - Documentation Improvements or additions to documentation 08 - Testing Related to unit or integration tests 09 - Maintenance Related to maintenance, housekeeping, repo-config Component: QEDevents Related to the subpackage `QEDevents.jl`

Comments

@szabo137
Copy link
Member

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
@szabo137 szabo137 added 06 - Feature-request Missing feature or functionality 07 - Documentation Improvements or additions to documentation 08 - Testing Related to unit or integration tests 09 - Maintenance Related to maintenance, housekeeping, repo-config Component: QEDevents Related to the subpackage `QEDevents.jl` labels Jul 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
06 - Feature-request Missing feature or functionality 07 - Documentation Improvements or additions to documentation 08 - Testing Related to unit or integration tests 09 - Maintenance Related to maintenance, housekeeping, repo-config Component: QEDevents Related to the subpackage `QEDevents.jl`
Projects
None yet
Development

No branches or pull requests

1 participant