You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/installation.md
+10-22Lines changed: 10 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ To install VariantVisualization.jl:
35
35
36
36
```julia
37
37
julia
38
-
]add VarianatVisualization
38
+
]add VariantVisualization
39
39
exit()
40
40
```
41
41
### Step 3: Run `viva`
@@ -99,19 +99,16 @@ We have included in-line comments within the code for the [VIVA command line too
99
99
100
100
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.
101
101
102
-
## Installation Features Under Development
103
102
104
-
### Running VIVA with Docker or Docker Compose (Under Active Development)
103
+
### Running VIVA with Docker or Docker Compose
105
104
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.
109
106
110
107
To run VIVA from a Docker image, first [install Docker](https://docs.docker.com/install/).
111
108
112
109
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."
113
110
114
-
####Using Docker
111
+
### Using Docker
115
112
116
113
*Note*: You must use the flag `--save_remotely` when running VIVA by using Docker.
117
114
@@ -130,31 +127,22 @@ cd project_x
130
127
Make sure to add your project VCF files to that folder.
131
128
132
129
133
-
#####Run the VIVA Command Line Tool from a Docker image:
130
+
#### Run the VIVA Command Line Tool from a Docker image:
134
131
135
132
*Note*: Remember, you must use the flag `--save_remotely` when running VIVA by using Docker.
136
133
137
-
-On Mac or Linux:
134
+
-Example run on Mac or Linux:
138
135
```shell
139
136
docker run -it --rm -v "$PWD":/data compbiocore/viva-cli viva --save_remotely -f file.vcf -s pdf -o output
140
137
```
141
138
142
-
- Example run:
139
+
- Example run on Windows:
143
140
```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
145
142
```
146
143
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
-
```
156
144
157
-
#####Run the VIVA Jupyter Notebook from a Docker image:
145
+
#### Run the VIVA Jupyter Notebook from a Docker image:
158
146
159
147
Copy and run the following line from the terminal or Windows PowerShell:
160
148
@@ -169,7 +157,7 @@ Go to `http://127.0.0.1:8888/?token=<enter token here>`
169
157
170
158
- On Windows:
171
159
```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
173
161
```
174
162
175
163
Go to the following url in your internet browser. You'll receive a token to enter into the url.
0 commit comments