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

331 update readme #573

Merged
merged 13 commits into from
Nov 9, 2024
Merged

331 update readme #573

merged 13 commits into from
Nov 9, 2024

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Oct 16, 2024 •
edited
Loading

Description

This is a revision of the README with feedback from @jpmorgan98 as part of the review of MontePy for pyOpenSCi.

This included:

  • Updating example code to be runnable by doctest.
  • Added required badges to be PyOpenSci compliant
  • Added citation information (will need to update once JOSS article is complete).
  • Added comparisons to competition.
  • Updated contributing guide for accuracy.

Currently the too much example code is broken to implement CI testing here, but that is currently in the works in #575.

Fixes #331

Checklist

  • I have made corresponding changes to the documentation (if applicable)

@MicahGale MicahGale added documentation Improvements or additions to documentation PyOpenSci / JOSS labels Oct 16, 2024
@MicahGale MicahGale self-assigned this Oct 16, 2024
@MicahGale MicahGale linked an issue Oct 16, 2024 that may be closed by this pull request
Update README #331
Closed
5 tasks
@MicahGale MicahGale mentioned this pull request Oct 16, 2024
Open
@MicahGale MicahGale marked this pull request as ready for review October 30, 2024 19:12
@MicahGale
Copy link
Collaborator Author

@jpmorgan98, if you are willing to do so, I would appreciate your review on this PR.

jpmorgan98
jpmorgan98 reviewed Oct 30, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@MicahGale
Copy link
Collaborator Author

image
The test is failing right now because nature.com is currently down. Wasn't expecting that to be the issue.

@MicahGale MicahGale merged commit e3933fb into develop Nov 9, 2024
20 checks passed
@MicahGale MicahGale deleted the 331-update-readme branch November 9, 2024 19:23
@MicahGale MicahGale mentioned this pull request Nov 12, 2024
Open
32 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jpmorgan98 jpmorgan98 jpmorgan98 approved these changes

@tjlaboss tjlaboss tjlaboss approved these changes

Assignees

@MicahGale MicahGale

Labels
documentation Improvements or additions to documentation PyOpenSci / JOSS
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update README
3 participants
@MicahGale @tjlaboss @jpmorgan98