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

Add JOSS paper #203

Merged
merged 93 commits into from
Jun 9, 2023
Merged

Add JOSS paper #203

merged 93 commits into from
Jun 9, 2023

Conversation

hajdik
Copy link
Contributor

@hajdik hajdik commented May 24, 2023

Purpose

Bring the paper branch into main as the review is nearly complete. Also bump the version and add a metadata file for the zenodo build to pick up on.

Expected time until merged

A day or two so we can do a final proofread

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (final paper!)

Testing

PDF can be viewed here

Checklist

  • I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@codecov
Copy link

codecov bot commented May 24, 2023

Codecov Report

Merging #203 (18ef1e8) into main (4f18d04) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #203   +/-   ##
=======================================
  Coverage   64.76%   64.76%           
=======================================
  Files          47       47           
  Lines       12018    12018           
=======================================
  Hits         7783     7783           
  Misses       4235     4235           
Impacted Files Coverage Δ
pygeo/__init__.py 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@sseraj sseraj left a comment

Choose a reason for hiding this comment

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

I left some minor comments

.github/workflows/draft-pdf.yml Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
@ewu63 ewu63 self-requested a review May 24, 2023 20:51
.zenodo.json Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
sseraj
sseraj previously approved these changes May 29, 2023
Copy link
Collaborator

@ewu63 ewu63 left a comment

Choose a reason for hiding this comment

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

LGTM other than two minor things. Once fixed (and required approvals are obtained) we can remove the GHA file, and merge.

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ewu63 ewu63 left a comment

Choose a reason for hiding this comment

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

LGTM, don't forget to make a release after merged!

@sseraj sseraj merged commit 2827954 into main Jun 9, 2023
12 checks passed
@sseraj sseraj deleted the joss-paper branch June 9, 2023 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants