Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated Docker Documentation on Readme #188

Closed
wants to merge 4 commits into from
Closed

Updated Docker Documentation on Readme #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b5b5ed
Updated Docker Documentation on Readme
kehshiba May 10, 2023
1c7fa44
fixes documentation
kehshiba May 10, 2023
e728f58
remove .idea
kehshiba May 10, 2023
62845f8
remove .idea
kehshiba May 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ venv
lint
uta_*.pgd.gz
.vscode
*.log
*.log
.idea/
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,35 @@ The `[extras]` argument tells pip to install packages to fullfill the dependenci

## Installing dependencies for ga4gh.vrs.extras

Note : The ga4gh.vrs.extras package used in this project has dependencies on services like *SeqRepo*. To simplify the setup process and ensure consistency across different environments, **Docker** is used to manage these dependencies. Docker allows you to package the required services and their configurations into containers, making it easier to deploy and run them on any system.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is good, but should be integrated in the context of why they would want to get started with Docker (answer: because the ga4gh.vrs.extra utils are dependent upon them). I think this README would therefore make sense with a little transition text, in an introductory subsection under "Installing dependencies for ga4gh.vrs.extras" section, below.



#### Step 1: Install Docker
To begin, you need to install Docker on your machine. Follow the official Docker installation guide for your specific operating system:

[Docker Installation Guide](https://docs.docker.com/get-docker/)

### Step 2: Verify Docker Installation
Once Docker is installed, you can verify the installation by running the following command in your terminal:


``` docker version ```

This command displays the Docker client and server versions, indicating that Docker is successfully installed on your machine.

### Step 3: Run a Docker Container
To test Docker, let's run a simple container. In your terminal, execute the following command:

``` docker run hello-world ```

This command pulls the hello-world Docker image (if not already present) and runs it in a container. You should see a message confirming that Docker is working correctly.

[Refer Documentation](https://docs.docker.com/)




The `ga4gh.vrs.extras` modules are not part of the VR spec per se. They are
bundled with ga4gh.vrs for development and installation convenience. These
modules depend directly and indrectly on external data sources of sequences,
Expand Down