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.

Sign up for GitHub

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

Jump to bottom

Integrate QEDbase.jl #6

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

Integrate QEDbase.jl #6

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: QEDbase Related to the subpackage `QEDbase.jl`
Milestone
The proof-of-conc...

Comments

@szabo137
Copy link
Member

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
@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: QEDbase Related to the subpackage `QEDbase.jl` labels Jul 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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: QEDbase Related to the subpackage `QEDbase.jl`
Projects
None yet
Milestone
The proof-of-concept: v0.1.0-alpha
Development

No branches or pull requests
1 participant
@szabo137