Skip to content

Commit 44aee90

Browse files
authored
Added updating, troubleshooting sections
1 parent 898a9bf commit 44aee90

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

Readme.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,27 @@ Each step of this can be run piecemeal by using the rules starting with "all", s
115115
Example: decontaminate all host reads with ```snakemake --configfile=my_config.yml all_decontam```
116116

117117
You can also see what samples Sunbeam detected by running ```snakemake --configfile=my_config.yml samples```.
118+
119+
120+
## Updating Sunbeam
121+
122+
To update sunbeam when a new version is released, it's easiest to simply remove the sunbeam conda environment and reinstall:
123+
124+
```shell
125+
conda env -d sunbeam
126+
cd path/to/sunbeam
127+
git pull
128+
bash install.sh
129+
```
130+
131+
## Troubleshooting
132+
133+
- **Q**: When I type `source activate sunbeam`, I get an error.
134+
- **A**: Make sure that miniconda3 is in your `PATH`: type `echo $PATH` and look for miniconda there. If it does not exist, edit your `.profile` or `.bashrc` file in your home directory and add a line like this:
135+
136+
```
137+
export PATH=$PATH:$HOME/miniconda3/bin
138+
```
139+
140+
- **Q**: I get an error relating to missing files when running on a cluster, and nothing continues after that point.
141+
- **A**: Increase the waiting time for files to appear by adding `-w 90` to the snakemake command.

0 commit comments

Comments
 (0)