Update README.md
Browse files
README.md
CHANGED
|
@@ -1,172 +1,181 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
-
|
| 50 |
-
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
-
|
| 55 |
-
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
-
|
| 60 |
-
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
-
|
| 65 |
-
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
β
|
| 83 |
-
|
| 84 |
-
βββ
|
| 85 |
-
β βββ Neo4j
|
| 86 |
-
β
|
| 87 |
-
β
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
βββ
|
| 100 |
-
|
| 101 |
-
|
| 102 |
-
|
| 103 |
-
|
| 104 |
-
|
| 105 |
-
|
| 106 |
-
|
| 107 |
-
|
| 108 |
-
|
| 109 |
-
β
|
| 110 |
-
β
|
| 111 |
-
β
|
| 112 |
-
βββ
|
| 113 |
-
βββ
|
| 114 |
-
|
| 115 |
-
|
| 116 |
-
|
| 117 |
-
|
| 118 |
-
|
| 119 |
-
|
| 120 |
-
|
| 121 |
-
|
| 122 |
-
|
| 123 |
-
|
| 124 |
-
|
| 125 |
-
|
| 126 |
-
|
| 127 |
-
|
| 128 |
-
|
| 129 |
-
|
| 130 |
-
|
| 131 |
-
|
| 132 |
-
|
| 133 |
-
|
| 134 |
-
|
| 135 |
-
|
| 136 |
-
|
| 137 |
-
|
| 138 |
-
|
| 139 |
-
|
| 140 |
-
|
| 141 |
-
|
| 142 |
-
|
| 143 |
-
|
| 144 |
-
|
| 145 |
-
|
| 146 |
-
|
| 147 |
-
|
| 148 |
-
|
| 149 |
-
|
| 150 |
-
|
| 151 |
-
|
| 152 |
-
|
| 153 |
-
|
| 154 |
-
|
| 155 |
-
|
| 156 |
-
|
| 157 |
-
|
| 158 |
-
|
| 159 |
-
|
| 160 |
-
|
| 161 |
-
|
| 162 |
-
|
| 163 |
-
|
| 164 |
-
|
| 165 |
-
|
| 166 |
-
|
| 167 |
-
|
| 168 |
-
|
| 169 |
-
|
| 170 |
-
##
|
| 171 |
-
|
| 172 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
metrics:
|
| 6 |
+
- accuracy
|
| 7 |
+
- bleu
|
| 8 |
+
- bleurt
|
| 9 |
+
---
|
| 10 |
+
# Cancer@Home v2
|
| 11 |
+
|
| 12 |
+
A distributed computing platform for cancer genomics research, combining BOINC distributed computing, GDC cancer data analysis, sequence processing (FASTQ/BLAST), and Neo4j graph visualization.
|
| 13 |
+
|
| 14 |
+
## π Quick Start (5 minutes)
|
| 15 |
+
|
| 16 |
+
### Prerequisites
|
| 17 |
+
- Python 3.8+
|
| 18 |
+
- Docker Desktop
|
| 19 |
+
- 8GB RAM minimum
|
| 20 |
+
|
| 21 |
+
### Installation
|
| 22 |
+
|
| 23 |
+
1. **Clone and setup**
|
| 24 |
+
```bash
|
| 25 |
+
cd CancerAtHome2
|
| 26 |
+
python -m venv venv
|
| 27 |
+
venv\Scripts\activate # Windows
|
| 28 |
+
pip install -r requirements.txt
|
| 29 |
+
```
|
| 30 |
+
|
| 31 |
+
2. **Start Neo4j Database**
|
| 32 |
+
```bash
|
| 33 |
+
docker-compose up -d
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
3. **Run the application**
|
| 37 |
+
```bash
|
| 38 |
+
python run.py
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
4. **Open your browser**
|
| 42 |
+
- Application: http://localhost:5000
|
| 43 |
+
- Neo4j Browser: http://localhost:7474 (username: neo4j, password: cancer123)
|
| 44 |
+
|
| 45 |
+
## π― Features
|
| 46 |
+
|
| 47 |
+
### 1. **Distributed Computing (BOINC Integration)**
|
| 48 |
+
- Submit cancer research computational tasks
|
| 49 |
+
- Monitor distributed workload processing
|
| 50 |
+
- Real-time task status tracking
|
| 51 |
+
|
| 52 |
+
### 2. **GDC Data Integration**
|
| 53 |
+
- Download cancer genomics data from GDC Portal
|
| 54 |
+
- Support for various cancer types (TCGA, TARGET projects)
|
| 55 |
+
- Automatic data parsing and normalization
|
| 56 |
+
|
| 57 |
+
### 3. **Sequence Analysis Pipeline**
|
| 58 |
+
- FASTQ file processing
|
| 59 |
+
- BLAST sequence alignment
|
| 60 |
+
- Variant calling and annotation
|
| 61 |
+
|
| 62 |
+
### 4. **Neo4j Graph Database**
|
| 63 |
+
- Graph-based cancer data modeling
|
| 64 |
+
- Relationships: Gene β Mutation β Patient β Cancer Type
|
| 65 |
+
- Interactive graph visualization
|
| 66 |
+
|
| 67 |
+
### 5. **GraphQL API**
|
| 68 |
+
- Query cancer data flexibly
|
| 69 |
+
- Filter by gene, mutation, patient cohort
|
| 70 |
+
- Aggregate statistics
|
| 71 |
+
|
| 72 |
+
### 6. **Interactive Dashboard**
|
| 73 |
+
- Real-time data visualization
|
| 74 |
+
- Network graphs for gene interactions
|
| 75 |
+
- Mutation frequency charts
|
| 76 |
+
- Patient cohort analysis
|
| 77 |
+
|
| 78 |
+
## π Architecture
|
| 79 |
+
|
| 80 |
+
```
|
| 81 |
+
Cancer@Home v2
|
| 82 |
+
β
|
| 83 |
+
βββ Frontend (React + D3.js)
|
| 84 |
+
β βββ Dashboard
|
| 85 |
+
β βββ Neo4j Visualization
|
| 86 |
+
β βββ Task Monitor
|
| 87 |
+
β
|
| 88 |
+
βββ Backend (FastAPI)
|
| 89 |
+
β βββ REST API
|
| 90 |
+
β βββ GraphQL Endpoint
|
| 91 |
+
β βββ WebSocket (real-time updates)
|
| 92 |
+
β
|
| 93 |
+
βββ Data Layer
|
| 94 |
+
β βββ Neo4j (Graph Database)
|
| 95 |
+
β βββ BOINC Client
|
| 96 |
+
β βββ GDC API Client
|
| 97 |
+
β
|
| 98 |
+
βββ Analysis Pipeline
|
| 99 |
+
βββ FASTQ Parser
|
| 100 |
+
βββ BLAST Wrapper
|
| 101 |
+
βββ Variant Annotator
|
| 102 |
+
```
|
| 103 |
+
|
| 104 |
+
## ποΈ Project Structure
|
| 105 |
+
|
| 106 |
+
```
|
| 107 |
+
CancerAtHome2/
|
| 108 |
+
βββ backend/
|
| 109 |
+
β βββ api/ # FastAPI routes
|
| 110 |
+
β βββ boinc/ # BOINC integration
|
| 111 |
+
β βββ gdc/ # GDC data fetcher
|
| 112 |
+
β βββ neo4j/ # Neo4j database layer
|
| 113 |
+
β βββ pipeline/ # Bioinformatics pipeline
|
| 114 |
+
β βββ graphql/ # GraphQL schema
|
| 115 |
+
βββ frontend/
|
| 116 |
+
β βββ public/
|
| 117 |
+
β βββ src/
|
| 118 |
+
β βββ components/ # React components
|
| 119 |
+
β βββ views/ # Page views
|
| 120 |
+
β βββ api/ # API client
|
| 121 |
+
βββ data/ # Downloaded datasets
|
| 122 |
+
βββ docker-compose.yml # Neo4j container
|
| 123 |
+
βββ requirements.txt # Python dependencies
|
| 124 |
+
βββ run.py # Main entry point
|
| 125 |
+
```
|
| 126 |
+
|
| 127 |
+
## 𧬠Data Flow
|
| 128 |
+
|
| 129 |
+
1. **Data Ingestion**: Download cancer genomics data from GDC Portal
|
| 130 |
+
2. **Processing**: Run FASTQ/BLAST analysis on distributed BOINC network
|
| 131 |
+
3. **Storage**: Store results in Neo4j graph database
|
| 132 |
+
4. **Visualization**: Query and visualize via web dashboard
|
| 133 |
+
|
| 134 |
+
## π§ Configuration
|
| 135 |
+
|
| 136 |
+
Edit `config.yml` to customize:
|
| 137 |
+
- Neo4j connection settings
|
| 138 |
+
- GDC API parameters
|
| 139 |
+
- BOINC project URL
|
| 140 |
+
- Analysis pipeline options
|
| 141 |
+
|
| 142 |
+
## π Usage Examples
|
| 143 |
+
|
| 144 |
+
### Query Mutations by Gene
|
| 145 |
+
```graphql
|
| 146 |
+
query {
|
| 147 |
+
mutations(gene: "TP53") {
|
| 148 |
+
id
|
| 149 |
+
position
|
| 150 |
+
consequence
|
| 151 |
+
patients {
|
| 152 |
+
cancerType
|
| 153 |
+
stage
|
| 154 |
+
}
|
| 155 |
+
}
|
| 156 |
+
}
|
| 157 |
+
```
|
| 158 |
+
|
| 159 |
+
### Submit Analysis Task
|
| 160 |
+
```python
|
| 161 |
+
from backend.boinc import BOINCClient
|
| 162 |
+
|
| 163 |
+
client = BOINCClient()
|
| 164 |
+
task_id = client.submit_task(
|
| 165 |
+
workunit_type="variant_calling",
|
| 166 |
+
input_file="sample.fastq"
|
| 167 |
+
)
|
| 168 |
+
```
|
| 169 |
+
|
| 170 |
+
## π€ Inspired By
|
| 171 |
+
|
| 172 |
+
- [Cancer@Home v1](https://www.herox.com/DCx/round/516/entry/23285) - Distributed cancer research
|
| 173 |
+
- [Neo4j Cancer Visualization](https://medium.com/neo4j/visualize-cancer-1c80a95f5bb4) - Graph-based cancer data modeling
|
| 174 |
+
|
| 175 |
+
## π License
|
| 176 |
+
|
| 177 |
+
MIT License
|
| 178 |
+
|
| 179 |
+
## π Support
|
| 180 |
+
|
| 181 |
+
For issues or questions, please open a Huggingface or GitHub issue.
|