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

Follow numpy structure and add asv-specific README #104

Merged
merged 20 commits into from
May 13, 2024
Merged

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented Apr 30, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

What does this PR do?

  • Modifies the asv benchmarks structure to one similar to numpy's and scipy's.
  • Adds a benchmark specific readme with some more details on the usage.
  • Reverts the workflows to use read_from_dask (until read_z_stack is added to the new release)
  • After requested changes: removes [asv_version] as an "extra" for pip install.

References

Please reference any existing issues/PRs that relate to this PR.

How has this PR been tested?

Please explain how any new code has been tested, and how you have ensured that no existing functionality has changed.

Is this a breaking change?

If this PR breaks any existing functionality, please explain how and why.

Does this PR require an update to the documentation?

If any features have changed, or have been added. Please explain how the documentation has been updated (and link to the associated PR). See here for details.

Checklist:

  • The code has been tested locally
  • [ n/a ] Tests have been added to cover all new functionality (unit & integration)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@sfmig sfmig changed the title replicate structure of numpy Add asv README Apr 30, 2024
Copy link

codecov bot commented Apr 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.68%. Comparing base (8d5a0f5) to head (8484663).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #104   +/-   ##
=======================================
  Coverage   85.68%   85.68%           
=======================================
  Files          16       16           
  Lines         838      838           
=======================================
  Hits          718      718           
  Misses        120      120           

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

@sfmig sfmig changed the title Add asv README Follow numpy structure and add asv-specific README May 10, 2024
@sfmig sfmig mentioned this pull request May 10, 2024
7 tasks
@sfmig sfmig marked this pull request as ready for review May 10, 2024 16:59
@sfmig sfmig requested a review from a team May 10, 2024 17:09
README.md Outdated Show resolved Hide resolved
benchmarks/README.md Outdated Show resolved Hide resolved
benchmarks/README.md Outdated Show resolved Hide resolved
benchmarks/README.md Show resolved Hide resolved
benchmarks/README.md Outdated Show resolved Hide resolved
benchmarks/README.md Outdated Show resolved Hide resolved
@sfmig sfmig requested a review from adamltyson May 13, 2024 15:38
@adamltyson adamltyson merged commit 31b0594 into main May 13, 2024
12 checks passed
@adamltyson adamltyson deleted the smg/asv-readme branch May 13, 2024 16:36
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

2 participants