Skip to content

Commit abd06ac

Browse files
Merge pull request #74 from compbiocore/alperuzun-patch-2
Update installation.md
2 parents 2e4954c + a5908e9 commit abd06ac

File tree

1 file changed

+10
-22
lines changed

1 file changed

+10
-22
lines changed

docs/src/installation.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To install VariantVisualization.jl:
3535

3636
```julia
3737
julia
38-
]add VarianatVisualization
38+
]add VariantVisualization
3939
exit()
4040
```
4141
### Step 3: Run `viva`
@@ -99,19 +99,16 @@ We have included in-line comments within the code for the [VIVA command line too
9999

100100
The ***VIVA Jupyter notebook*** is powered by a [main function](https://github.com/compbiocore/VariantVisualization.jl/tree/master/src/new_notebook_utils.jl) which takes arguments defined by the user in the notebook. We welcome users to post in issues to request a new feature or bug fix.
101101

102-
## Installation Features Under Development
103102

104-
### Running VIVA with Docker or Docker Compose (Under Active Development)
103+
### Running VIVA with Docker or Docker Compose
105104

106-
Soon, you will be able to run VIVA using Docker images. This is not yet a supported feature. The instructions below will be helpful once this is supported.
107-
108-
Alternatively, you can run VIVA using the Docker images we've provided if you don't want to install Julia and the VariantVisualization.jl Julia package. You may only save images to HTML format using the Docker, for now, due to technical limitations of dependency packages. We've actively developing a feature to save to all formats using Docker.
105+
You can run VIVA using the Docker images we've provided if you don't want to install Julia and the VariantVisualization.jl Julia package.
109106

110107
To run VIVA from a Docker image, first [install Docker](https://docs.docker.com/install/).
111108

112109
Then double-click the Docker.app in the Applications folder to start Docker. You will see a whale icon in the top status bar to indicate that Docker is running and accessible from the terminal. You can quit Docker once you are finished using VIVA by clicking the Docker whale icon in the top status bar and clicking "Quit Docker Desktop."
113110

114-
#### Using Docker
111+
### Using Docker
115112

116113
*Note*: You must use the flag `--save_remotely` when running VIVA by using Docker.
117114

@@ -130,31 +127,22 @@ cd project_x
130127
Make sure to add your project VCF files to that folder.
131128

132129

133-
##### Run the VIVA Command Line Tool from a Docker image:
130+
#### Run the VIVA Command Line Tool from a Docker image:
134131

135132
*Note*: Remember, you must use the flag `--save_remotely` when running VIVA by using Docker.
136133

137-
- On Mac or Linux:
134+
- Example run on Mac or Linux:
138135
```shell
139136
docker run -it --rm -v "$PWD":/data compbiocore/viva-cli viva --save_remotely -f file.vcf -s pdf -o output
140137
```
141138

142-
- Example run:
139+
- Example run on Windows:
143140
```shell
144-
docker run -it --rm -v "$PWD":/data compbiocore/viva-cli viva --save_remotely -f file.vcf -s pdf -o output
141+
docker run -it --rm -v ${pwd}:/data compbiocore/viva-cli viva --save_remotely -f file.vcf -s pdf -o output
145142
```
146143

147-
- On Windows:
148-
```shell
149-
docker run -it --rm -v "${pwd}":/data compbiocore/viva-cli viva --save_remotely -f file.vcf -s pdf -o output
150-
```
151-
152-
- Example run:
153-
```shell
154-
docker run -it --rm -v "${pwd}":/data compbiocore/viva-cli viva --save_remotely -f file.vcf -s pdf -o output
155-
```
156144

157-
##### Run the VIVA Jupyter Notebook from a Docker image:
145+
#### Run the VIVA Jupyter Notebook from a Docker image:
158146

159147
Copy and run the following line from the terminal or Windows PowerShell:
160148

@@ -169,7 +157,7 @@ Go to `http://127.0.0.1:8888/?token=<enter token here>`
169157

170158
- On Windows:
171159
```shell
172-
docker run --rm -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -v "${pwd}":/home/jovyan/notebook/data compbiocore/viva-notebook:v0.3.9
160+
docker run --rm -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -v ${pwd}:/home/jovyan/notebook/data compbiocore/viva-notebook:v0.3.9
173161
```
174162

175163
Go to the following url in your internet browser. You'll receive a token to enter into the url.

0 commit comments

Comments
 (0)