Getting Started

Getting Started: Quick Overview

This guide provides the minimal steps necessary to install DeepDock and start the API service. For detailed prerequisites (Docker, NVIDIA drivers, etc.), please refer to the Installation & Setup guide.

Prerequisites Check

Before proceeding with the installation, ensure the following core components are correctly installed and verified on your host machine. For detailed installation instructions and troubleshooting, please consult the full Installation & Setup guide:

Component	Verification Command	Purpose
Docker Engine	docker --version	Container management
NVIDIA Drivers	nvidia-smi	GPU and Driver functionality
NVIDIA Container Toolkit	nvidia-container-cli --version	GPU access inside containers

1. Installation

DeepDock can be installed directly from its GitHub repository using pip. Ensure you have Python installed on your host system.

pip install git+https://github.com/JuniorDurand/DeepDock.git

This command installs the DeepDock API and all necessary dependencies.

2. Running the Service

Once installed, use the dedicated command to launch the DeepDock API service.

Standard Execution

Run the following command in your terminal:

deepdock

What this does:

• Starts the FastAPI server (default host: 127.0.0.1, default port: 8000).

• Enables automatic real-time GPU monitoring.

• The API is now active and ready to receive requests for container management.

If you encounter issues, verify the prerequisites (Docker, NVIDIA Toolkit) are met, or check the full Installation & Setup guide.