Mentors4EDU commited on
Commit
8a91ab9
·
verified ·
1 Parent(s): 89f31f8

Update Getting Started

Browse files
Files changed (1) hide show
  1. README.md +45 -26
README.md CHANGED
@@ -138,37 +138,66 @@ make -j$(nproc)
138
  sudo make install
139
  ```
140
 
141
- ## Quick Start
142
 
143
- ### Web GUI (Recommended!)
144
 
145
  ```bash
 
 
 
 
146
  # Install dependencies
147
  pip install -r requirements.txt
 
148
 
149
- # Start the GUI server
150
- python start.py
 
 
 
 
151
 
152
- # Open browser to: http://localhost:8080
 
 
 
 
 
 
 
153
  ```
154
 
155
- The GUI provides:
156
- - 🖱️ **Drag-and-drop** file upload
157
- - 📊 **Real-time** progress monitoring
158
- - 📈 **Live statistics** dashboard
159
- - 🎯 **Interactive** job management
160
- - 📱 **Responsive** design
161
 
162
- ### Command Line
 
163
 
164
- ```bash
165
- # Run docking from terminal
166
- docking-at-home dock -l molecule.pdbqt -r protein.pdbqt
 
 
 
 
 
 
167
 
 
 
 
 
 
 
 
 
168
  # Start server
169
  docking-at-home server --port 8080
170
 
171
- # Start worker
172
  docking-at-home worker --local
173
  ```
174
 
@@ -199,16 +228,6 @@ async def main():
199
  asyncio.run(main())
200
  ```
201
 
202
- ### Running on Localhost
203
-
204
- ```bash
205
- # Start the local server
206
- docking-at-home server --port 8080
207
-
208
- # In another terminal, run the worker
209
- docking-at-home worker --local
210
- ```
211
-
212
  ## Configuration
213
 
214
  Configuration files are located in `config/`:
 
138
  sudo make install
139
  ```
140
 
141
+ ## Getting Started
142
 
143
+ ### Installation
144
 
145
  ```bash
146
+ # Clone repository
147
+ git clone https://huggingface.co/OpenPeerAI/DockingAtHOME
148
+ cd DockingAtHOME
149
+
150
  # Install dependencies
151
  pip install -r requirements.txt
152
+ npm install
153
 
154
+ # Build C++/CUDA components
155
+ mkdir build && cd build
156
+ cmake .. && make -j$(nproc)
157
+ ```
158
+
159
+ ### Quick Start with GUI
160
 
161
+ ```bash
162
+ # Start the web-based GUI (fastest way to get started)
163
+ docking-at-home gui
164
+
165
+ # Or with Python
166
+ python -m docking_at_home.gui
167
+
168
+ # Open browser to http://localhost:8080
169
  ```
170
 
171
+ ### Quick Start Example (CLI)
172
+
173
+ ```python
174
+ from docking_at_home import DockingClient
 
 
175
 
176
+ # Initialize client (localhost mode)
177
+ client = DockingClient(mode="localhost")
178
 
179
+ # Submit docking job
180
+ job = client.submit_job(
181
+ ligand="path/to/ligand.pdbqt",
182
+ receptor="path/to/receptor.pdbqt",
183
+ num_runs=100
184
+ )
185
+
186
+ # Monitor progress
187
+ status = client.get_status(job.id)
188
 
189
+ # Retrieve results
190
+ results = client.get_results(job.id)
191
+ print(f"Best binding energy: {results.best_energy} kcal/mol")
192
+ ```
193
+
194
+ ### Running on Localhost
195
+
196
+ ```bash
197
  # Start server
198
  docking-at-home server --port 8080
199
 
200
+ # In another terminal, run worker
201
  docking-at-home worker --local
202
  ```
203
 
 
228
  asyncio.run(main())
229
  ```
230
 
 
 
 
 
 
 
 
 
 
 
231
  ## Configuration
232
 
233
  Configuration files are located in `config/`: