Skip to content

Commit

Permalink
Merge pull request aidenlab#304 from aidenlab/nchernia-patch-1
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
sa501428 authored Feb 3, 2023
2 parents 5a471a4 + bb2287b commit 290e443
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

To access Juicer 1.6 (last stable release), please see [the Github Release](https://github.com/aidenlab/juicer/releases/tag/1.6). If you clone the Juicer repo directly from Github, it will clone Juicer 2, which is under active development. If you encounter any bugs, please let us know.

ENCODE's Hi-C uniform processing pipeline based on Juicer can be found [here](https://github.com/ENCODE-DCC/hic-pipeline).

# About Juicer

Juicer is a platform for analyzing kilobase resolution Hi-C data. In this
Expand Down Expand Up @@ -32,17 +34,19 @@ Distribution
------------

In this repository, we include the scripts for running Juicer on AWS, LSF,
Univa Grid Engine, SLURM, and a single CPU

/AWS - scripts for running pipeline and postprocessing on AWS
Univa Grid Engine, SLURM, and a single CPU.

/UGER - scripts for running pipeline and postprocessing on UGER (Univa)
The SLURM and CPU scripts are the most up to date. For cloud computing, we recommend the [ENCODE uniform processing pipeline based on Juicer](https://github.com/ENCODE-DCC/hic-pipeline)

/SLURM - scripts for running pipeline and postprocessing on SLURM

/LSF - scripts for running pipeline and postprocessing on LSF **BETA**
/CPU - scripts for running pipeline and postprocessing on a single CPU

/AWS - scripts for running pipeline and postprocessing on AWS **Deprecated**

/CPU - scripts for running pipeline and postprocessing on a single CPU **BETA**
/UGER - scripts for running pipeline and postprocessing on UGER (Univa) **Deprecated**

/LSF - scripts for running pipeline and postprocessing on LSF **Deprecated**

/misc - miscellaneous helpful scripts

Expand All @@ -55,7 +59,7 @@ and the post-processing command line tools.

### Cluster requirements:

Juicer requires the use of a cluster, with ideally >= 4 cores (min 1 core)
Juicer requires the use of a cluster or the cloud, with ideally >= 4 cores (min 1 core)
and >= 64 GB RAM (min 16 GB RAM)

Juicer currently works with the following resource management software:
Expand All @@ -64,6 +68,8 @@ Juicer currently works with the following resource management software:
- [SLURM](https://slurm.schedmd.com/download.html)
- GridEngine (Univa, etc. any flavor)

We recommend [ENCODE's Hi-C processing pipeline, based on Juicer](https://github.com/ENCODE-DCC/hic-pipeline) to run in the cloud; the AWS scripts are out of date.

### Juicer tools requirements

The minimum software requirement to run Juicer is a working Java installation
Expand Down Expand Up @@ -102,7 +108,7 @@ respective native libraries from
[JCuda](http://www.jcuda.org/downloads/downloads.html).

For best performance, use a dedicated GPU. You may also be able to obtain
access to GPU clusters through Amazon Web Services or a local research
access to GPU clusters through Amazon Web Services, Google cloud, or a local research
institution.

If you cannot access a GPU, you can run the [CPU version of HiCCUPS](https://github.com/aidenlab/juicer/wiki/CPU-HiCCUPS) directly using the `.hic` file and Juicer Tools.
Expand Down

0 comments on commit 290e443

Please sign in to comment.