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

Don't remove DIA-NN from FragPipe installation. #51317

Merged
merged 2 commits into from
Oct 12, 2024

Conversation

reid-wagner
Copy link
Contributor

It's been confirmed with both the FragPipe and DIA-NN authors that their license confers the ability to distribute the DIA-NN package along with the FragPipe download.


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 Oct 10, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the FragPipe project, specifically within the scripts and license documentation. The build.sh script has been updated to remove lines that previously handled the DIA-NN tool directories, indicating that the DIA-NN license incompatibility issue is no longer addressed. The script still performs its primary functions, such as copying the FragPipe source and Philosopher installation, and creating a symbolic link to the Philosopher binary.

Additionally, the wrapper script for FragPipe has been simplified by removing a block of code that checked for a specific feature related to the DIA-NN license, streamlining its control flow while retaining checks for license keys for MSFragger and IonQuant. Lastly, a new license agreement for the DIA-NN software has been added, detailing its terms of use, limitations, and requirements for attribution, among other legal stipulations. No alterations were made to the declarations of exported or public entities in any of the modified files.

Possibly related PRs

  • Update Earl Grey build.sh #51324: The changes in the build.sh script for Earl Grey involve modifications to executable permissions and symbolic links, which are similar in nature to the updates made in the build.sh script for FragPipe regarding symbolic links and script functionality.

Suggested labels

please review & merge

Suggested reviewers

  • mencian
  • adamhospital

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0f38c39 and af0e0e3.

📒 Files selected for processing (1)
  • recipes/fragpipe/meta.yaml (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
recipes/fragpipe/meta.yaml (2)

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

The build number has been correctly incremented from 3 to 4. This is the standard practice when making changes to a package without altering its version, which aligns with the PR objectives.


Line range hint 1-85: Verify if additional changes are needed in meta.yaml

Given the modifications related to DIA-NN handling mentioned in the AI summary (removal of DIA-NN tool directory handling in build.sh and changes to the wrapper script), please verify if any additional changes are needed in this meta.yaml file. For example:

  1. Are there any DIA-NN related dependencies that need to be updated or removed?
  2. Does the package description or summary need to be updated to reflect the changes in DIA-NN handling?
  3. Are there any license files that need to be added or removed as a result of these changes?

To help verify these points, you can run the following script:

✅ Verification successful

Verification Complete: No Additional Changes Needed in meta.yaml

All references to DIA-NN have been successfully removed. No updates are required for dependencies, package descriptions, summaries, or license files related to DIA-NN.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for DIA-NN related entries in meta.yaml and other relevant files

# Check for DIA-NN mentions in meta.yaml
echo "Checking for DIA-NN mentions in meta.yaml:"
rg -i "dia-nn" recipes/fragpipe/meta.yaml

# Check for DIA-NN related files in the recipe directory
echo "Checking for DIA-NN related files in the recipe directory:"
fd -i "dia-nn" recipes/fragpipe

# Check for DIA-NN mentions in build.sh
echo "Checking for DIA-NN mentions in build.sh:"
rg -i "dia-nn" recipes/fragpipe/build.sh

# Check for DIA-NN mentions in the wrapper script
echo "Checking for DIA-NN mentions in the wrapper script:"
rg -i "dia-nn" recipes/fragpipe/fragpipe.py

Length of output: 655


Script:

#!/bin/bash
# Description: Locate the current wrapper script and check for DIA-NN mentions

# Find Python scripts in the recipe directory
echo "Searching for Python wrapper scripts in recipes/fragpipe:"
fd -e py recipes/fragpipe --exec echo {}

# If a wrapper script is found, check for DIA-NN mentions within it
# Replace 'wrapper_script.py' with the actual script name if found
# Example:
# rg -i "dia-nn" recipes/fragpipe/wrapper_script.py

Length of output: 539


Script:

#!/bin/bash
# Description: Locate the current Python wrapper scripts and check for DIA-NN mentions

# Find Python scripts in the recipe directory
echo "Searching for Python wrapper scripts in recipes/fragpipe:"
fd -e py . recipes/fragpipe --exec echo {}

# Check for DIA-NN mentions within each found Python script
# Replace '{}' with the actual file paths found
fd -e py . recipes/fragpipe --exec rg -i "dia-nn" {}

Length of output: 226


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.

@reid-wagner
Copy link
Contributor Author

@BiocondaBot please add label

@reid-wagner
Copy link
Contributor Author

@bgruening Thanks!

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 12, 2024
@bgruening bgruening merged commit 057d760 into bioconda:master Oct 12, 2024
7 checks passed
@ypriverol
Copy link
Contributor

@reid-wagner @bgruening I talked about the HUPO meeting in Dresden with Vadim from DIANN and nobody is allowed to produce and distribute a valid container singularity or docker with the current license of DIANN 1.9.2. I think is better to double-check with the DIANN developer because this is probably violating the current LICENSE.

@reid-wagner
Copy link
Contributor Author

@ypriverol - The version that's bundled with FragPipe is 1.8.1, which doesn't have this restriction. We've talked with Vadim as well about this specific package. Thanks for bringing this up, though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants