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 QEDprocesses.jl #7

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

Integrate QEDprocesses.jl #7

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: QEDprocesses Related to the subpackage `QEDprocesses`

Comments

@szabo137
Copy link
Member

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

  • make the top-level namespace of QEDprocesses.jl available in QED.jl
  • add docs of QEDprocesses.jl as a page to the docs of QED.jl
  • add integration tests from QEDprocesses.jl into the test suite of QED.jl
  • pin the version of QEDprocesses.jl used in the current version of QED.jl

Requirements

The following items are required for QEDprocesses.jl to be integrated into QED.jl:

  • implementation of a static process type defining the scattering process, e.g. Compton, Breit-Wheeler and trident
  • implementation of the necessary type parameters for the process type, including model types for perturbative and pulsed-perturbative QED
  • implementation of a data structure to hold and propagate the kinematical information about the initial particles of a given process
  • implementation of differential and total cross-sections as well as the maximum of the differential cross-section for all included processes
  • 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 QEDprocesses.jl should at least contain

  • a landing page in the QEDprocesses.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 QEDprocesses.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: QEDprocesses Related to the subpackage `QEDprocesses` 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: QEDprocesses Related to the subpackage `QEDprocesses`
Projects
None yet
Development

No branches or pull requests

1 participant