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

Consistency and FAQs #2

Merged
merged 5 commits into from
Aug 20, 2018
Merged

Consistency and FAQs #2

merged 5 commits into from
Aug 20, 2018

Conversation

armintoepfer
Copy link
Member

Consistency

  • Use - for no available packages. Easier on the eyes.
  • bioconda lowercase if not at start of sentence.
  • *-Packages

Clarify conflicts of pb-dazzler

FAQ: No PacBio tech support. Use issue tracker

FAQ: Clarify which tool version to use, bioconda vs SMRT Analysis.

Consistency
 - Use `-` for no available packages. Easier on the eyes.
 - bioconda lowercase if not at start of sentence.
 - *-Packages

Clarify conflicts of `pb-dazzler`

FAQ: No PacBio tech support. Use issue tracker

FAQ: Clarify which tool version to use, bioconda vs SMRT Analysis.
@armintoepfer armintoepfer requested a review from pb-cdunn August 20, 2018 10:34
README.md Outdated
## Availability

**Notes:**
* Python packages require version 2.7

Choose a reason for hiding this comment

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

I guess that's fine. But I'd like to track which packages already work with py3. Hmmm...

... I think we need an Issue. There, we can use check-boxes to track our work on py3-compatibility.

Copy link
Member Author

Choose a reason for hiding this comment

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

Will add a link to your issue

@pb-cdunn
Copy link

pypeflow and falcon can also conflict.

Actually, someone updated pypeflow over the weekend, and it happens to match the code in pb-falcon. One idea: turn those into trivial, immediately crashing code, so nobody will use them. Then, deleted their recipes (which I've seen, so I think it's possible).

Unfortunately, we cannot do that for DALGINER/etc because we do not actually own those. So we need a check in Falcon to test early whether we have our own daligner suite..

@pb-cdunn
Copy link

pb-cdunn commented Aug 20, 2018

Btw, I learned something annoying when I looked into the pypeflow package. These are equivalent ways to obtain source trees from github:

  1. https://github.com/PacificBiosciences/pypeFLOW/archive/{{ version }}.tar.gz
  2. https://github.com/PacificBiosciences/pypeFLOW/archive/{{ commit }}.tar.gz

Unfortunately, commit/version goes into the directory name within the tarball. (And in fact, the directory name does not match the tarball filename; rather, it is prefixed with the repo name. But that's not the problem.) So these 2 100% identical source distributions have different sha256 checksums. That makes equivalence hard to prove. But I did verify it myself.

Copy link

@pb-cdunn pb-cdunn left a comment

Choose a reason for hiding this comment

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

(Does my comment in python versions appear in this review. Let's see...)

README.md Outdated
@@ -112,5 +124,13 @@ There are no plans to provide darwin binaries for packages currently missing Mac
There are no plans to provide executables for Windows.
We do not provide support for WSL (Windows Subsystem for Linux).

### Which version of tool X shall I use, from bioconda or from SMRT Analysis?

Choose a reason for hiding this comment

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

Your usage of "SMRT Analysis" is confusing to me. "SMRT Analysis" is a subcomponent of SMRT Link. Similarly, "smrt-tools" is a subcomponent of "SMRT Link" that is used by several other subcomponents (e.g., SMRT Analysis, RunQC).

"SMRT Analysis build" is an RS-era construct. There is no (or there shouldn't be) a formal SMRT Analysis (only) build. There are only "SMRT Link" and "SMRT Link tools" builds.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you. Will push a fix

@armintoepfer armintoepfer merged commit 50cdc5a into master Aug 20, 2018
@pb-cdunn
Copy link

Remember to click "Delete branch" after merging, if desired.

@armintoepfer armintoepfer deleted the consistency-and-faqs branch August 22, 2018 12:59
@armintoepfer
Copy link
Member Author

Yeah, in bitbucket I have the checkbox activated per default :) Thanks for the reminder

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants