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

kmercamel: add aarch64/arm64 builds #51267

Merged
merged 1 commit into from
Oct 9, 2024

Conversation

martin-g
Copy link
Contributor

@martin-g martin-g commented Oct 9, 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>.

Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
@martin-g martin-g added aarch64 Related to adding linux-aarch64 support osx-arm64 Related to adding osx-arm64 support labels Oct 9, 2024
Copy link
Contributor

coderabbitai bot commented Oct 9, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to both the build.sh and meta.yaml files for the kmercamel package. In build.sh, the addition of the set -xe command enhances debugging and error tracing by ensuring that each command is printed before execution and that the script terminates on failure. Furthermore, the make command has been updated to utilize the -j ${CPU_COUNT} option, enabling parallel compilation based on available CPU cores. The meta.yaml file has been revised to reflect a new version "1.0.2" and an incremented build number from 0 to 1. A SHA256 checksum has been specified, and the indentation for the sha256 line has been corrected. Additionally, an extra section has been introduced, which includes a new key additional-platforms that specifies support for linux-aarch64 and osx-arm64. Indentation adjustments have also been made for the license_file and summary lines.

Possibly related PRs

Suggested labels

please review & merge


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d7edafa and 3194f69.

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

3-4: Excellent addition of set -xe for improved debugging and error handling.

The addition of set -xe is a great improvement to the build script. It enhances the script's robustness and debuggability in the following ways:

  • The -e flag ensures the script exits immediately if any command fails, preventing cascading errors.
  • The -x flag enables debugging by printing each command before it's executed, making it easier to identify where issues occur.

This change aligns with best practices for bash scripting in build environments.


5-7: Great optimization of the make command for parallel compilation.

The modification of the make command is an excellent improvement:

  1. The addition of -j ${CPU_COUNT} enables parallel compilation, which can significantly speed up the build process, especially on multi-core systems.
  2. The use of environment variables (${CXX}, ${CXXFLAGS}, ${CPPFLAGS}, ${LDFLAGS}) ensures that the build respects the system's compiler settings and flags.

This change aligns with Conda build best practices and enhances the portability of the build process across different environments.


Line range hint 1-8: Overall, excellent improvements to the build script.

The changes made to this build script are well-considered and improve both the build process and its debuggability. The script now follows best practices for Conda builds and bash scripting in general. The parallel compilation option and the use of environment variables for compiler settings enhance the script's efficiency and portability.

The installation commands remain unchanged, maintaining the existing functionality while benefiting from the improved build process.

recipes/kmercamel/meta.yaml (3)

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

The build number has been correctly incremented from 0 to 1. This is the expected practice when modifying a package without changing its version, which aligns with the PR objective of adding new architecture builds.


39-42: LGTM: Additional platforms correctly specified.

The addition of the 'extra' section with 'additional-platforms' correctly specifies support for ARM64 architecture on both Linux (linux-aarch64) and macOS (osx-arm64). This aligns perfectly with the PR objective of adding aarch64/arm64 builds.


Line range hint 1-42: Verify compatibility of version 1.0.2 with ARM64 architectures.

The package has been updated to version 1.0.2 and now includes support for ARM64 architectures. While this aligns with the PR objectives, it's important to ensure that this version of kmercamel is indeed compatible with the newly added architectures (linux-aarch64 and osx-arm64).

Could you please confirm that version 1.0.2 of kmercamel supports ARM64 architectures? You may want to check the release notes or the project's documentation for this information.

Additionally, let's verify if there are any architecture-specific build instructions or dependencies:

✅ Verification successful

ARM64 Architecture Compatibility Verified

The update to version 1.0.2 of kmercamel includes support for ARM64 architectures as specified in the additional-platforms section. No architecture-specific build instructions or dependencies were found to conflict with this compatibility.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for architecture-specific instructions or dependencies

# Test: Search for architecture-specific mentions in the build script
echo "Checking build.sh for architecture-specific instructions:"
rg -i 'aarch64|arm64' recipes/kmercamel/build.sh

# Test: Check if there are any architecture-specific dependencies in meta.yaml
echo "Checking meta.yaml for architecture-specific dependencies:"
rg -i 'aarch64|arm64' recipes/kmercamel/meta.yaml | grep -v 'additional-platforms'

# Test: Look for any README or documentation files that might mention architecture support
echo "Checking for README or documentation files:"
fd -i readme recipes/kmercamel
fd -i docs recipes/kmercamel

Length of output: 582


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.

@martin-g
Copy link
Contributor Author

martin-g commented Oct 9, 2024

@BiocondaBot please fetch artifacts

@BiocondaBot
Copy link
Collaborator

Package(s) built are ready for inspection:

Arch Package Zip File / Repodata CI Instructions
linux-64 kmercamel-1.0.2-hc4f6fa1_1.tar.bz2 LinuxArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the LinuxArtifacts directory: conda install -c ./packages <package name>
osx-64 kmercamel-1.0.2-h7560eef_1.tar.bz2 OSXArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the OSXArtifacts directory: conda install -c ./packages <package name>
osx-arm64 kmercamel-1.0.2-h0fb2f90_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/f7539a0c-623b-405b-b07c-6a298c6b0dd7/artifacts/0/tmp/artifacts/packages <package name>
linux-aarch64 kmercamel-1.0.2-h02ce0e3_1.tar.bz2 repodata.json CircleCI
showYou may also use conda to install:conda install -c https://output.circle-artifacts.com/output/job/c361821c-8018-41da-a94e-cb166ab137cb/artifacts/0/tmp/artifacts/packages <package name>

Docker image(s) built:

Package Tag CI Install with docker
kmercamel 1.0.2--hc4f6fa1_1 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/kmercamel:1.0.2--hc4f6fa1_1.tar.gz | docker load

@martin-g
Copy link
Contributor Author

martin-g commented Oct 9, 2024

mgrigorov in 🌐 euler-arm-22 in /tmp/kmercamel via 🅒 test123 took 2s 
❯ tar xvf kmercamel-1.0.2-h02ce0e3_1.tar.bz2                                                                                                                                                               (test123) 
info/files
info/run_exports.json
info/test/run_test.sh
info/recipe/build.sh
info/hash_input.json
info/paths.json
info/index.json
info/recipe/meta.yaml.template
info/licenses/LICENSE.txt
info/recipe/meta.yaml
info/recipe/conda_build_config.yaml
info/about.json
info/git
bin/kmercamel

mgrigorov in 🌐 euler-arm-22 in /tmp/kmercamel via 🅒 test123 
❯ file bin/*                                                                                                                                                                                               (test123) 
bin/kmercamel: ELF 64-bit LSB pie executable, ARM aarch64, version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux-aarch64.so.1, for GNU/Linux 3.7.0, with debug_info, not stripped

mgrigorov in 🌐 euler-arm-22 in /tmp/kmercamel via 🅒 test123 
❯ ./bin/kmercamel                                                                                                                                                                                          (test123) 
Required parameter p not set.
KmerCamel version v1.0.2
Accepted arguments:
  -p path_to_fasta - required; valid path to fasta file (can be gziped)
  -k k_value       - required; integer value for k (up to 127)
  -a algorithm     - the algorithm to be run [global (default), globalAC, local, localAC, streaming]
  -o output_path   - if not specified, the output is printed to stdout
  -d d_value       - integer value for d_max; default 5
  -c               - treat k-mer and its reverse complement as equal
  -m               - turn off the memory optimizations for global
  -l               - compute the cycle cover lower bound instead of masked superstring
  -h               - print help
  -v               - print version
Example usage:       ./kmercamel -p path_to_fasta -k 31 -d 5 -a local -c
Possible algorithms: global globalAC local localAC streaming

For optimization of masks use `kmercamel optimize`.
Accepted arguments:
  -p path_to_fasta - required; valid path to fasta file (can be gziped)
  -k k_value       - required; integer value for k (up to 127)
  -a algorithm     - the algorithm to be run [ones (default), runs, runsapprox, zeros]
  -o output_path   - if not specified, the output is printed to stdout
  -c               - treat k-mer and its reverse complement as equal
  -h               - print help
  -v               - print version

LGTM!

@martin-g
Copy link
Contributor Author

martin-g commented Oct 9, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 9, 2024
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 please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants