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

Racon: add arm64 build #52209

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Racon: add arm64 build #52209

merged 1 commit into from
Nov 19, 2024

Conversation

mencian
Copy link
Contributor

@mencian mencian commented Nov 19, 2024

Describe your pull request here


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

📝 Walkthrough

Walkthrough

The pull request introduces several modifications to the Racon package, primarily focusing on enhancing support for the arm64 architecture. The build.sh script has been updated to optimize for portability and includes a conditional check for macOS, adjusting the build configuration accordingly. The build process has transitioned to utilize modern CMake syntax, enabling parallel builds and verbose output. Changes to the meta.yaml file include an increment in the build number, the addition of new metadata fields such as dev_url, doc_url, and license_family, and the introduction of a new platform (osx-arm64). Furthermore, the run requirements have been simplified by removing the explicit listing of zlib. In the racon_wrapper.patch, the CMake configuration has been modified to use environment variables for binary paths instead of project-relative paths, maintaining the overall build logic while enhancing flexibility.

Possibly related PRs

Suggested labels

aarch64, osx-arm64

Warning

Rate limit exceeded

@mencian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 27 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 892854c and a338a0b.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (4)
recipes/racon/build.sh (2)

25-29: Consider conditional verbose output.

The build configuration is well-structured using modern CMake practices. However, the verbose flag (-v) might generate excessive output in CI logs.

Consider making verbose output conditional:

-cmake --build build --target install -j "${CPU_COUNT}" -v
+cmake --build build --target install -j "${CPU_COUNT}" ${VERBOSE_BUILD:+-v}

31-32: Add error handling for wrapper operations.

While the operations are correct, consider adding error checking to handle cases where the wrapper build might fail.

Consider this safer approach:

-chmod +w build/bin/racon_wrapper
-cp -f build/bin/racon_wrapper ${PREFIX}/bin
+if [ -f build/bin/racon_wrapper ]; then
+    chmod +w build/bin/racon_wrapper
+    cp -f build/bin/racon_wrapper ${PREFIX}/bin
+else
+    echo "Error: racon_wrapper not found in build/bin" >&2
+    exit 1
+fi
recipes/racon/meta.yaml (2)

37-41: Consider improving documentation URL

While the added metadata fields are good, pointing doc_url to the README.md file might not be the best practice. Consider creating more comprehensive documentation (e.g., ReadTheDocs, Wiki) for better user experience.


Based on the analysis of similar arm64-compatible packages in the output, I can generate the final response:

Add zlib to run requirements and include OpenMP dependencies

Please update the dependencies section to include:

  • Add zlib to run requirements since it's needed at runtime (seen in multiple similar packages)
  • Add OpenMP dependencies for proper arm64 support:
    host:
      - llvm-openmp  # [osx]
      - libgomp      # [linux]
    run:
      - llvm-openmp  # [osx]
      - libgomp      # [linux]
🔗 Analysis chain

Line range hint 18-28: Verify dependencies for arm64 build

Please ensure all necessary dependencies are included for arm64 support:

  1. Verify if zlib is needed in run requirements
  2. Check if there are any architecture-specific dependencies needed for arm64
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for architecture-specific dependencies in similar bioconda packages

# Look for patterns in other arm64-compatible packages
rg -l "osx-arm64" | xargs cat | rg "requirements:" -A 10

Length of output: 49484

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 892854c and a338a0b.

📒 Files selected for processing (3)
  • recipes/racon/build.sh (1 hunks)
  • recipes/racon/meta.yaml (2 hunks)
  • recipes/racon/racon_wrapper.patch (0 hunks)
💤 Files with no reviewable changes (1)
  • recipes/racon/racon_wrapper.patch
🔇 Additional comments (3)
recipes/racon/build.sh (1)

17-21: LGTM! Proper macOS build configuration.

The Darwin-specific configuration correctly disables framework and bundle searches, which is essential for clean builds on macOS systems.

recipes/racon/meta.yaml (2)

9-9: LGTM: Build number increment is appropriate

The build number increment is correct for adding arm64 support.


46-49: Verify the added identifiers

Please verify that Racon is actually registered in both biotools and Galaxy EU.

Comment on lines +10 to +12
arm64)
SPOA_OPTS="-Dspoa_optimize_for_portability=ON"
;;
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Architecture detection pattern needs to be updated for arm64 support

The codebase analysis reveals that the current implementation in recipes/racon/build.sh is inconsistent with the established patterns across other Bioconda recipes. Several key observations:

  • Many recipes (e.g., wfa2-lib, vcf-validator, spacepharer) use aarch64 | arm64 pattern to handle both Linux and macOS ARM architectures in a single case
  • The SPOA options in racon should align with its dependency spoa's configuration (recipes/spoa/build.sh)
  • The current implementation might miss optimizations for macOS ARM (arm64)

Suggested changes:

  • Combine arm64 and aarch64 cases to use the same SIMDE configuration
  • Match the pattern used by other recipes: aarch64 | arm64)
🔗 Analysis chain

LGTM! Architecture-specific optimization correctly configured.

The arm64 case (Apple Silicon) appropriately uses portability optimization, distinct from the aarch64 (Linux ARM64) configuration. This aligns with platform-specific best practices.

Let's verify the architecture detection logic:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify architecture detection patterns in other bioconda recipes
# Expected: Find similar architecture detection patterns in other recipes

# Search for similar architecture detection patterns
rg -A 5 "case.*uname -m.*in" 

Length of output: 11438

@mencian mencian added the osx-arm64 Related to adding osx-arm64 support label Nov 19, 2024
@mencian mencian merged commit 65f207e into master Nov 19, 2024
6 checks passed
@mencian mencian deleted the racon branch November 19, 2024 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
osx-arm64 Related to adding osx-arm64 support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant