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

README: openPMD-api Install #313

Merged
merged 1 commit into from
Jan 13, 2021
Merged

README: openPMD-api Install #313

merged 1 commit into from
Jan 13, 2021

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Jan 12, 2021

Document openPMD-api dependencies and install.

Related to #306

  • Small enough (< few 100s of lines), otherwise it should probably be split into smaller PRs
  • Tested (describe the tests in the PR description)
  • Runs on GPU (basic: the code compiles and run well with the new module)
  • Contains an automated test (checksum and/or comparison with theory)
  • Documented: all elements (classes and their members, functions, namespaces, etc.) are documented
  • Constified (All that can be const is const)
  • Code is clean (no unwanted comments, )
  • Style and code conventions are respected at the bottom of https://github.com/Hi-PACE/hipace
  • Proper label and GitHub project, if applicable

@ax3l ax3l added documentation Improvements or additions to documentation component: diagnostics About any types of diagnostics labels Jan 12, 2021
@ax3l ax3l requested a review from MaxThevenet January 12, 2021 22:36
@ax3l ax3l force-pushed the doc-openPMDapiDeps branch 3 times, most recently from 7b769fc to d0b3f56 Compare January 12, 2021 22:43
@ax3l
README: openPMD-api Install
5f9ffc5 
Document openPMD-api dependencies and install.
@ax3l ax3l force-pushed the doc-openPMDapiDeps branch from d0b3f56 to 5f9ffc5 Compare January 12, 2021 22:43
MaxThevenet
MaxThevenet approved these changes Jan 13, 2021
View reviewed changes
Copy link
Member

@MaxThevenet MaxThevenet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks! Looks good to me.

@MaxThevenet MaxThevenet merged commit 31881c8 into development Jan 13, 2021
@MaxThevenet MaxThevenet deleted the doc-openPMDapiDeps branch January 13, 2021 08:23
@ax3l ax3l mentioned this pull request Jan 15, 2021
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MaxThevenet MaxThevenet MaxThevenet approved these changes

Assignees
No one assigned
Labels
component: diagnostics About any types of diagnostics documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ax3l @MaxThevenet