Skip to content
This repository has been archived by the owner on Sep 14, 2021. It is now read-only.

Commit

Permalink
Update README to point to readthedocs.
Browse files Browse the repository at this point in the history
Removed docs directory.
Update source to remove "bigtools" nomenclature.
  • Loading branch information
mbookman committed Jul 3, 2015
1 parent 661168d commit 6a30079
Show file tree
Hide file tree
Showing 14 changed files with 85 additions and 863 deletions.
32 changes: 19 additions & 13 deletions README.md
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)
Loading

0 comments on commit 6a30079

Please sign in to comment.