Skip to content

Commit f01f648

Browse files
authored
docs: add more info for docker commands (#566)
close #565 Made small tweak to biocommons package install
1 parent 6c32886 commit f01f648

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ transcripts, and genome-transcript alignments.
8282
First, you must install a local [SeqRepo](https://github.com/biocommons/biocommons.seqrepo):
8383

8484
```shell
85-
pip install seqrepo
85+
pip install biocommons.seqrepo
8686
export SEQREPO_VERSION=2024-12-20 # or newer if available -- check `seqrepo list-remote-instances`
8787
sudo mkdir -p /usr/local/share/seqrepo
8888
sudo chown $USER /usr/local/share/seqrepo
@@ -102,8 +102,8 @@ Try moving data manually with `sudo`:
102102
sudo mv /usr/local/share/seqrepo/$SEQREPO_VERSION.* /usr/local/share/seqrepo/$SEQREPO_VERSION
103103
```
104104

105-
To make installation easy, we recommend using Docker to install the other Biocommons
106-
tools - [SeqRepo REST](https://github.com/biocommons/seqrepo-rest-service) and
105+
To make installation easy, we recommend using [Docker](https://docs.docker.com/get-started/get-docker/)
106+
to install the other Biocommons tools - [SeqRepo REST](https://github.com/biocommons/seqrepo-rest-service) and
107107
[UTA](https://github.com/biocommons/uta). If you would like to use local instances of UTA,
108108
see [UTA](https://github.com/biocommons/uta) directly. We do provide some additional
109109
setup help [here](./docs/setup_help/).
@@ -113,9 +113,15 @@ Next, run the following commands:
113113
```shell
114114
docker volume create --name=uta_vol
115115
docker volume create --name=seqrepo_vol
116-
docker-compose up
116+
docker compose up
117117
```
118118

119+
> [!NOTE]
120+
> You must run all Docker commands from the root of the vrs-python repository (where `docker-compose.yml` lives). See [installing for development](#installing-for-development)
121+
> for the clone commands.
122+
> If you use Docker Compose v1, use `docker-compose` instead of `docker compose`.
123+
> However, we do recommend [upgrading to v2](https://docs.docker.com/compose/releases/migrate/).
124+
119125
This should start three containers:
120126

121127
- [seqrepo](https://github.com/biocommons/seqrepo): downloads seqrepo into a
@@ -155,7 +161,7 @@ Here are some things to try.
155161
yet, you might see this:
156162

157163
```shell
158-
$ docker-compose up seqrepo-rest-service
164+
$ docker compose up seqrepo-rest-service
159165
Starting vrs-python_seqrepo-rest-service_1 ... done
160166
Attaching to vrs-python_seqrepo-rest-service_1
161167
seqrepo-rest-service_1 | 2022-07-26 15:59:59 seqrepo_rest_service.__main__[1] INFO Using seqrepo_dir='/usr/local/share/seqrepo/2024-12-20' from command line
@@ -189,7 +195,7 @@ Here are some things to try.
189195
````
190196
ports:
191197
- [your_port_number]:5432
192-
- Repeat the `docker-compose up` command
198+
- Repeat the `docker compose up` command
193199
- Repeat the command above to verify that there is now a docker command
194200
listening at this port.
195201
```
@@ -219,7 +225,7 @@ Here are some things to try.
219225
````
220226
ports:
221227
- [your_port_number]:5000
222-
- Repeat the `docker-compose up` command
228+
- Repeat the `docker compose up` command
223229
- Test the SeqRepo REST API service with this new port
224230
```shell
225231
curl 'http://127.0.0.1:[your_port_number]/seqrepo/1/sequence/refseq:NM_000059.4?end=20'

0 commit comments

Comments
 (0)