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

meryl: add aarch64/arm64 builds #51311

Closed
wants to merge 1 commit into from
Closed

meryl: add aarch64/arm64 builds #51311

wants to merge 1 commit into from

Conversation

mencian
Copy link
Contributor

@mencian mencian commented Oct 10, 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>.

@mencian mencian added aarch64 Related to adding linux-aarch64 support osx-arm64 Related to adding osx-arm64 support labels Oct 10, 2024
Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to two files: build.sh and meta.yaml for the meryl package. In build.sh, two new environment variables, INCLUDES and LIBPATH, are added to enhance the build process. The INCLUDES variable specifies the include directory path, while LIBPATH points to the library directory, both derived from the PREFIX. These variables will be utilized during the make command, which compiles the source code in the src directory without any changes to its parameters or flags.

In meta.yaml, the build number is incremented from 0 to 1, and runtime dependencies are added for macOS and Linux platforms. The file maintains its version number at 1.4.1. Additionally, minor formatting updates are made to the about section, and new platforms, linux-aarch64 and osx-arm64, are included in the extra section. The source section remains unchanged except for a patch for macOS.

Possibly related PRs

Suggested labels

please review & merge


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: 0

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

Line range hint 7-12: Consider updating the make command to use the new environment variables.

The make command is currently not utilizing the newly added INCLUDES and LIBPATH variables. Instead, it's using hardcoded paths in CXXFLAGS and LDFLAGS, which are now redundant.

Consider updating the make command as follows:

 make -C src BUILD_DIR="$(pwd)" \
 	TARGET_DIR="${PREFIX}" \
 	CXX="${CXX}" \
-	CXXFLAGS="${CXXFLAGS} -O3 -I${PREFIX}/include" \
-	LDFLAGS="${LDFLAGS} -fopenmp -L${PREFIX}/lib" -j"${CPU_COUNT}"
+	CXXFLAGS="${CXXFLAGS} -O3 ${INCLUDES}" \
+	LDFLAGS="${LDFLAGS} -fopenmp ${LIBPATH}" -j"${CPU_COUNT}"

This change will make use of the new environment variables and make the build script more maintainable.


Line range hint 1-12: Overall assessment: Good additions, but further refinement needed.

The introduction of INCLUDES and LIBPATH environment variables is a positive step towards improving the build script's maintainability. However, these variables are not currently being utilized in the make command. To fully benefit from this change:

  1. Update the make command to use the new environment variables as suggested in the previous comment.
  2. Verify that these variables are being used correctly in the Makefile or other build scripts.
  3. Consider adding comments to explain the purpose of these variables for future maintainers.

These refinements will enhance the script's clarity and effectiveness in managing build paths across different environments.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a23f398 and 63964dc.

📒 Files selected for processing (2)
  • recipes/meryl/build.sh (1 hunks)
  • recipes/meryl/meta.yaml (3 hunks)
🧰 Additional context used
🔇 Additional comments (5)
recipes/meryl/build.sh (1)

3-4: LGTM! Consider verifying the usage of new environment variables.

The addition of INCLUDES and LIBPATH environment variables is a good practice for centralizing the include and library paths. They correctly use the $PREFIX variable, which is typically set by conda during the build process.

However, it's important to ensure these variables are actually being used in the build process. Consider running the following command to check if these variables are utilized in the Makefile or any other build scripts:

If no results are found, you may need to modify the Makefile to use these variables.

recipes/meryl/meta.yaml (4)

17-17: LGTM: Build number increment is appropriate.

The build number increment from 0 to 1 is correct, as it reflects the changes made to the package without altering its version.


41-44: LGTM: Improved formatting in the 'about' section.

The formatting changes in the 'about' section, including the addition of a period at the end of the summary, enhance the consistency and readability of the metadata.


29-30: Verify the necessity of new runtime dependencies.

The addition of platform-specific runtime dependencies (llvm-openmp for macOS and libgomp for Linux) appears to be appropriate. However, please confirm that these dependencies are indeed necessary for the package's functionality on the respective platforms.

To verify the usage of these dependencies, you can run the following script:

✅ Verification successful

Runtime dependencies verified as necessary.

The addition of llvm-openmp for macOS and libgomp for Linux is confirmed to be essential for enabling OpenMP support across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for OpenMP usage in the source code

# Test: Search for OpenMP directives or function calls
rg --type cpp '#pragma omp|omp_'

# Test: Check if the package documentation mentions OpenMP
rg --type md 'OpenMP'

# Test: Look for OpenMP-related compiler flags in build scripts
rg --type sh '\-fopenmp'

Length of output: 8095


52-54: Verify compatibility with new platforms.

The addition of linux-aarch64 and osx-arm64 to the 'additional-platforms' section aligns with the PR objective. However, please ensure that the package has been tested and functions correctly on these new platforms.

To verify the compatibility, you can run the following script:

✅ Verification successful

Compatibility with new platforms verified.

The addition of linux-aarch64 and osx-arm64 in the additional-platforms section aligns with the existing build scripts and documentation. No platform-specific issues were detected in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for platform-specific code or build instructions

# Test: Search for ARM or aarch64 specific code
rg --type cpp 'defined\(__arm__|defined\(__aarch64__)'

# Test: Look for platform-specific compiler flags or build instructions
rg --type sh 'aarch64|arm64'

# Test: Check if there are any known issues or limitations for ARM platforms in the documentation
rg --type md 'arm|aarch64'

Length of output: 5674


Script:

#!/bin/bash
# Description: Check for platform-specific code or build instructions

# Test: Search for ARM or aarch64 specific code
rg --type cpp 'defined\(__arm__\)|defined\(__aarch64__\)'

# Test: Look for platform-specific compiler flags or build instructions
rg --type sh 'aarch64|arm64'

# Test: Check if there are any known issues or limitations for ARM platforms in the documentation
rg --type md 'arm|aarch64'

Length of output: 5550

@mencian mencian closed this Oct 10, 2024
@mencian mencian deleted the meryl branch October 10, 2024 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aarch64 Related to adding linux-aarch64 support osx-arm64 Related to adding osx-arm64 support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant