Skip to content

[DO NOT MERGE] JOSS Paper Draft #138

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

Draft
wants to merge 58 commits into
base: main
Choose a base branch
from
Draft

[DO NOT MERGE] JOSS Paper Draft #138

wants to merge 58 commits into from

Conversation

ranocha
Copy link
Member

@ranocha ranocha commented Feb 20, 2025

DO NOT MERGE THIS PR

We can use this PR to check and discuss the paper draft. The PR can be closed when the JOSS paper is finished. The branch paper-2025-joss must be kept around forever.

You can download the PDF of the paper draft from the GitHub action Build JOSS paper draft PDF / JOSS Paper Draft (pull_request) below.

  • Click on it
  • Go to Summary on the left
  • Download the artifact

@codecov-commenter
Copy link

codecov-commenter commented Feb 20, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.18%. Comparing base (63c826d) to head (fc31c14).
Report is 1 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #138   +/-   ##
=======================================
  Coverage   98.18%   98.18%           
=======================================
  Files           7        7           
  Lines        1546     1546           
=======================================
  Hits         1518     1518           
  Misses         28       28           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@SKopecz
Copy link
Collaborator

SKopecz commented Feb 24, 2025

I added bibliography information for all the papers that I could think of that describe or analyze the currently implemented schemes. Do we also want to make reference to schemes that could be implemented in the future?

What's the purpose of the section "Related research and software"? Do want to give a general overview or do we want to describe exactly in which paper which implemented method can be found?

@ranocha
Copy link
Member Author

ranocha commented Feb 24, 2025

Thanks!

I added bibliography information for all the papers that I could think of that describe or analyze the currently implemented schemes. Do we also want to make reference to schemes that could be implemented in the future?

We should only describe what kind of schemes are implemented - plans may change and we may not implement other methods we could list...

What's the purpose of the section "Related research and software"? Do want to give a general overview or do we want to describe exactly in which paper which implemented method can be found?

This section should contain

  • papers where this package and/or the methods implemented here have been used
  • other open-source software implementing the same or related methods
  • maybe also papers developing the methods implemented in this package

Copy link
Contributor

@JoshuaLampert JoshuaLampert left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the draft! I had a brief look and left some comments below.

@coveralls
Copy link

coveralls commented Apr 3, 2025

Pull Request Test Coverage Report for Build 14623225132

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.76%

Totals Coverage Status
Change from base Build 14598967342: 0.0%
Covered Lines: 1964
Relevant Lines: 2009

💛 - Coveralls

SKopecz and others added 2 commits April 3, 2025 16:58
Copy link
Contributor

@JoshuaLampert JoshuaLampert 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 final comments below.

@SKopecz
Copy link
Collaborator

SKopecz commented Apr 22, 2025

I added tags and set the date to tomorrow.

@ranocha @JoshuaLampert if you agree with the tags, I will submit tomorrow.

Copy link
Contributor

@JoshuaLampert JoshuaLampert left a comment

Choose a reason for hiding this comment

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

Sounds good to me. I have only two final minor comments/suggestions.

Co-authored-by: Joshua Lampert <[email protected]>
@ranocha
Copy link
Member Author

ranocha commented Apr 22, 2025

I added tags and set the date to tomorrow.

@ranocha @JoshuaLampert if you agree with the tags, I will submit tomorrow.

Great, thanks a lot! I am fine submitting the paper 👍

@SKopecz
Copy link
Collaborator

SKopecz commented Apr 22, 2025

CI is failing again on macOS inside a work_precision test.

work-precision fixed: Test Failed at /Users/runner/work/PositiveIntegrators.jl/PositiveIntegrators.jl/test/runtests.jl:2594
  Expression: maximum((v .- m1) ./ m1) < 1.5
   Evaluated: 1.8971724926437623 < 1.5

But I don't see why this happens, since the allowed tolerance for macOS should be 10.0 now.

@JoshuaLampert
Copy link
Contributor

JoshuaLampert commented Apr 22, 2025

I guess we should delete this line:

@test maximum((v .- m1) ./ m1) < 1.5

because it is doubled in
@test maximum((v .- m1) ./ m1) < allowed

with the platform dependent tolerance.

@JoshuaLampert JoshuaLampert mentioned this pull request Apr 22, 2025
@SKopecz
Copy link
Collaborator

SKopecz commented Apr 22, 2025

Thanks!

@SKopecz
Copy link
Collaborator

SKopecz commented Apr 22, 2025

Now building the docs fails.

To github.com:NumericalMathematics/PositiveIntegrators.jl
 ! [rejected]        HEAD -> gh-pages (fetch first)
error: failed to push some refs to 'github.com:NumericalMathematics/PositiveIntegrators.jl'
hint: Updates were rejected because the remote contains work that you do not
hint: have locally. This is usually caused by another repository pushing to
hint: the same ref. If you want to integrate the remote changes, use
hint: 'git pull' before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.

@ranocha
Copy link
Member Author

ranocha commented Apr 23, 2025

Now building the docs fails.

To github.com:NumericalMathematics/PositiveIntegrators.jl
 ! [rejected]        HEAD -> gh-pages (fetch first)
error: failed to push some refs to 'github.com:NumericalMathematics/PositiveIntegrators.jl'
hint: Updates were rejected because the remote contains work that you do not
hint: have locally. This is usually caused by another repository pushing to
hint: the same ref. If you want to integrate the remote changes, use
hint: 'git pull' before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.

Where do you see this error?

It is likely just a race condition from two CI jobs trying to push changes at the same time. We can submit the paper anyway

@JoshuaLampert
Copy link
Contributor

I restarted CI yesterday evening. This error was just spurious.

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.

5 participants