Skip to content

Commit

Permalink
Add a tutorial about pulling and running FragPipe using Docker
Browse files Browse the repository at this point in the history
  • Loading branch information
fcyu committed Jul 23, 2024
1 parent 77db81d commit e080234
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ FragPipe is a comprehensive computational platform for analyzing mass spectromet
#### FragPipe tutorials
* [Using FragPipe](https://fragpipe.nesvilab.org/docs/tutorial_fragpipe.html) (general tutorial covering all FragPipe modules)
* [Running FragPipe in command line interface](https://fragpipe.nesvilab.org/docs/tutorial_headless.html)
* [Pulling and running FragPipe using Docker](https://fragpipe.nesvilab.org/docs/tutorial_docker.html)
* PTM discovery
* [Open search](https://fragpipe.nesvilab.org/docs/tutorial_open.html)
* [Mass offset search](https://fragpipe.nesvilab.org/docs/tutorial_offset.html)
Expand Down
10 changes: 10 additions & 0 deletions docs/tutorial_docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Pulling and running FragPipe using Docker

- Install docker by following the [instruction](https://docs.docker.com/desktop/install/mac-install/)
- Open terminal and pull the docker image: `docker pull fcyucn/fragpipe`
- (optional) Check the pulled image: `docker image ls -a`
- Create a Docker container: `docker run -it -v <host directory>:<container directory> fcyucn/fragpipe /bin/bash`. `<host directory>` is the directory in your host machine, and `<container directory>` is the directory you want to map the host directory to container.
- Then, you have entered the docker, and FragPipe is located in `/fragpipe_bin`
- Go to `/fragpipe_bin/fragPipe-x.x/fragpipe/bin` directory and execute `./fragpipe --help` in the terminal

Read more: Check [Running FragPipe in command line interface](https://fragpipe.nesvilab.org/docs/tutorial_headless.html) for the instructions running FragPipe in command line interface.

0 comments on commit e080234

Please sign in to comment.