Skip to content

JOSS paper draft #1092

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
Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

JOSS paper draft #1092

wants to merge 5 commits into from

Conversation

simonbyrne
Copy link
Member

@simonbyrne simonbyrne commented Jan 10, 2023 •
edited by valeriabarra
Loading

This is a PR for a potential future JOSS paper, from the software meeting this morning.

Tentative TODOs

In addition to the "white paper", there are a few things we need to address:

Improve Docs:

  • Getting started/How to guide
  • Contributing guide + Code of Conduct (?)
  • Examples documentation (equations set, what to expect from each example, artifacts, if included)

Improve Unit Tests:

  • Unit tests: strive for best code coverage: e.g., double check that all operators are tested

Examples:

  • Address memory usage and OoM issues when examples are run locally

Performance:

  • Distributed computing capability (re-run latest scaling studies)?
  • Multi-threading capability?
  • Might include initial GPU support?

@valeriabarra valeriabarra added the documentation Improvements or additions to documentation label Jan 10, 2023
valeriabarra and others added 4 commits May 31, 2023 08:57
@valeriabarra
Initial commit for JOSS paper notes
0348dc4
@valeriabarra
Add GH Action
dbcdff7
@valeriabarra @dennisYatunin
@simonbyrne @sriharshakandala @charleskawczynski
Some WIP from the Software meeting notes
8cc8cc6 
Co-authored-by: Dennis Yatunin <dyatun@gmail.com>
Co-authored-by: Simon Byrne <simonbyrne@gmail.com>
Co-authored-by: Sriharsha Kandala <sriharsha.kvs@gmail.com>
Co-authored-by: Charles Kawczynski <kawczynski.charles@gmail.com>
@valeriabarra
Rebase onto main and TODOs for the software meeting
55c60f6
@valeriabarra
WIP May Software meeting
0939e47 
Co-authored-by: Dennis Yatunin <dyatun@gmail.com>
Co-authored-by: Simon Byrne <simonbyrne@gmail.com>
Co-authored-by: Sriharsha Kandala <sriharsha.kvs@gmail.com>
Co-authored-by: Charles Kawczynski <kawczynski.charles@gmail.com>
Co-authored-by: LenkaNovak <lenka@caltech.edu>
Co-authored-by: Julia Sloan <jsloan@caltech.edu>
Co-authored-by: Nat Efrat-Henrici <nat.henrici@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@simonbyrne @valeriabarra