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 extra links to README and improve description #264

Merged
merged 6 commits into from
Mar 13, 2024

Conversation

matt-graham
Copy link
Member

Adds badges to README for latest stable version of documentation and GMD journal article (will need to be updated once the accepted version is available online). Also tweaks the description a little bit to mention thread-based parallelism and add a link to ARC website. I also noticed there was a unit_test.h5 HDF5 file we don't appear to use anywhere that was added in #218, I assumne accidentally, so have removed this.

@codecov-commenter
Copy link

codecov-commenter commented Mar 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.48%. Comparing base (3619473) to head (5291fda).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #264   +/-   ##
=======================================
  Coverage   92.48%   92.48%           
=======================================
  Files           7        7           
  Lines         386      386           
=======================================
  Hits          357      357           
  Misses         29       29           

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

README.md Show resolved Hide resolved
unit_test.h5 Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

I now renamed the branch, so should replace master -> main everywhere. Sorry! 😅

Copy link
Member Author

Choose a reason for hiding this comment

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

Do we also want to change master_rankmain_rank?

Copy link
Member

Choose a reason for hiding this comment

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

Potentially yes, but it can be done in a separate PR. Also, it'd probably be a technically breaking change, as I think we expose the name to users at

* `master_rank` : Id of MPI rank that performs serial computations

@matt-graham matt-graham linked an issue Mar 13, 2024 that may be closed by this pull request
@matt-graham
Copy link
Member Author

matt-graham commented Mar 13, 2024

Looks like there is some implicit reference to master branch in benchmarks workflow from the fact it fails with

fatal: couldn't find remote ref refs/heads/master

when running

using PkgBenchmark, BenchmarkCI

BenchmarkCI.judge(
    PkgBenchmark.BenchmarkConfig(
        env = Dict(
            "JULIA_NUM_THREADS" => "2",
        ),
    ),
)

but not sure how to fix - @giordano any ideas?

EDIT: Maybe just passing id="main" to PkgBenchmark.BenchmarkConfig will fix?

(Second) EDIT: Looks like culprit is baseline = "origin/master" default in BenchmarkCI.judge so will try updating that.

@matt-graham matt-graham merged commit b157f0c into main Mar 13, 2024
8 of 10 checks passed
@matt-graham matt-graham deleted the mmg/readme-improvements branch March 13, 2024 14:23
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.

Rename default branch to main
3 participants