From 5c4af7cfc5a9431f650eb160ee3f769fb82081b6 Mon Sep 17 00:00:00 2001 From: Nico Trummer Date: Sun, 25 Feb 2024 16:39:37 +0000 Subject: [PATCH] Add README --- README.md | 26 ++++++++++++++++++++++++++ run.sh | 4 ---- 2 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 README.md delete mode 100755 run.sh diff --git a/README.md b/README.md new file mode 100644 index 0000000..eafcc12 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# SIMBA🦁 QC +This repository contains the source code of the python shiny app which is recommended to be used for the quality control of the SIMBA🦁 pipeline. The app is available at [https://exbio.wzw.tum.de/simba-qc/](https://exbio.wzw.tum.de/simba-qc/). + +## Offline Usage +### Docker +The app can be run using the docker image `exbio/simba-qc`. The image can be pulled from the docker hub using the following command: +```bash +docker run -p :8080 bigdatainbiomedicine/simba-qc +``` +The app will be available at [http://localhost:](http://localhost:). + +### Local +The app can also be run locally. The following steps are required to run the app locally: +1. Clone the repository: +```bash +git clone https://github.com/Mye-InfoBank/SIMBA-QC.git +``` +2. Install the required packages: +```bash +pip install -r requirements.txt +``` +3. Run the app: +```bash +cd src +uvicorn app:app --host 0.0.0.0 --port +``` \ No newline at end of file diff --git a/run.sh b/run.sh deleted file mode 100755 index 7d23fe6..0000000 --- a/run.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash - -cd src -uvicorn app:app --host 0.0.0.0 --port 80 \ No newline at end of file