This repository has been archived by the owner on Sep 14, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README to point to readthedocs.
Removed docs directory. Update source to remove "bigtools" nomenclature.
- Loading branch information
Showing
14 changed files
with
85 additions
and
863 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,34 @@ | ||
BigTools | ||
========================== | ||
grid-computing-tools | ||
==================== | ||
|
||
BigTools is intended to be a place for scripts and recipes for solving some very common issues, | ||
which typically fall under the category of "simple for a few files, hard for many files." | ||
The grid-computing-tools repo is intended to be a place for scripts and | ||
recipes for solving some very common issues, which typically fall under | ||
the category of "simple for a few files, hard for many files." | ||
Examples include: | ||
|
||
* I have many VCFs in Cloud Storage that I need to (de)compress | ||
* I have many VCFs in Cloud Storage that have something wrong with the header | ||
* I have many BAMs in Cloud Storage for which I need to compute index files | ||
|
||
BigTools Components | ||
------------------- | ||
grid-computing-tools components | ||
------------------------------- | ||
|
||
The primary components of the BigTools examples are: | ||
The primary components of the grid-computing-tools examples are: | ||
|
||
* Google Cloud Storage - location of source input files and destination for output files | ||
* Google Compute Engine - virtual machines in the cloud | ||
* Grid Engine - job scheduling software to distribute commands across a cluster of virtual machines | ||
* [Google Cloud Storage](https://cloud.google.com/storage/) - location of source input files and destination for output files | ||
* [Google Compute Engine](https://cloud.google.com/compute/) - virtual machines in the cloud | ||
* [Grid Engine](http://gridengine.info/) - job scheduling software to distribute commands across a cluster of virtual machines | ||
|
||
The BigTools approach is intended to provide a familiar environment to computational scientists who | ||
are accustomed to using Grid Engine to submit jobs to fixed-size clusters available at their research institution. | ||
The approach here is intended to provide a familiar environment to | ||
computational scientists who are accustomed to using Grid Engine to | ||
submit jobs to fixed-size clusters available at their research institution. | ||
|
||
Available Tools | ||
--------------- | ||
Documentation for the tools in this repo can be found at | ||
http://googlegenomics.readthedocs.org/ | ||
|
||
The following tools are available: | ||
|
||
* [Compress/Decompress files in Google Cloud Storage] (https://github.com/googlegenomics/bigtools/blob/master/docs/compress.rst) | ||
* [Compress/Decompress files in Google Cloud Storage](http://googlegenomics.readthedocs.org/en/latest/use_cases/compress_or_decompress_many_files/index.html) | ||
* [With SAMtools index BAM files in Google Cloud Storage](http://googlegenomics.readthedocs.org/en/latest/use_cases/run_samtools_over_many_files/index.html) |
Oops, something went wrong.