diff --git a/.gitignore b/.gitignore index cb2a21d6..adf964d3 100644 --- a/.gitignore +++ b/.gitignore @@ -21,4 +21,5 @@ venv lint uta_*.pgd.gz .vscode -*.log \ No newline at end of file +*.log +.idea/ \ No newline at end of file diff --git a/README.md b/README.md index 538dd7d5..70a604a1 100644 --- a/README.md +++ b/README.md @@ -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. + + + +#### 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,