Skip to content

Commit

Permalink
organizing
Browse files Browse the repository at this point in the history
  • Loading branch information
wclose authored Oct 29, 2019
1 parent c1decce commit 251c56b
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,37 +59,39 @@ nano ~/.bashrc
source ~/.bash_profile
```

<br />
<br />

## Using Snakemake to Submit Jobs

**5.** Clone this repository and move into the main project folder:
**1.** Clone this repository and move into the main project folder:
```
git clone https://github.com/SchlossLab/snakemake_cluster_tutorial.git
cd snakemake_cluster_tutorial
```

<br />

**6.** Create an environment called `clusterTutorial` with the dependencies we need:
**2.** Create an environment called `clusterTutorial` with the dependencies we need:
```
conda env create -f envs/clusterTutorial.yaml
```

<br />

**7.** Activate the environment before running any code:
**3.** Activate the environment before running any code:
```
conda activate clusterTutorial
```

<br />

**8.** Before running any jobs on the cluster, don't forget to change the `ACCOUNT` and `EMAIL` fields in the following files for whichever cluster you're using:
**4.** Before running any jobs on the cluster, don't forget to change the `ACCOUNT` and `EMAIL` fields in the following files for whichever cluster you're using:
* PBS: [cluster profile configuration](config/pbs-torque/cluster.json) and the [cluster submission script](code/clusterSnakemake.pbs)
* Slurm: [cluster profile configuration](config/slurm/cluster.json) and the [cluster submission script](code/clusterSnakemake.sh)

<br />

**9.** Run the Snakemake workflow. **Note**: If you wish to rerun the workflow after having it successfully complete, use the `--forcerun` or the `--forceall` flags or just delete the `results/` directory by running `snakemake clean`.
**5.** Run the Snakemake workflow. **Note**: If you wish to rerun the workflow after having it successfully complete, use the `--forcerun` or the `--forceall` flags or just delete the `results/` directory by running `snakemake clean`.
* To run the entire workflow locally (without the cluster):
```
snakemake
Expand Down

0 comments on commit 251c56b

Please sign in to comment.