You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update documentation for dependency checking and pre-flight validation
Add check-deps command to installation guides, new dependency management
section to README, missing dependencies troubleshooting entries, changelog
entries for unreleased features, and update test counts to 902/40.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
-**Generic**: Customizable adapter for arbitrary pipeline requirements
393
394
395
+
## Dependency Management
396
+
397
+
NanoRunner's core functionality (replay mode, built-in read generation) has no external dependencies beyond the Python standard library. Optional tools extend its capabilities:
Use `nanorunner check-deps` to see the status of all dependencies and install instructions for missing ones. Pre-flight validation catches missing dependencies before long-running operations begin, providing actionable error messages.
408
+
394
409
## Technical Requirements
395
410
396
411
-**Python**: Version 3.9 or higher
397
412
-**Core dependencies**: Standard library only for basic functionality (including built-in read generation)
398
413
-**Enhanced features**: Optional psutil dependency for resource monitoring
399
414
-**Optional read generators**: badread and/or NanoSim for higher-fidelity read simulation
400
415
-**Platform compatibility**: POSIX-compliant operating systems (Linux, macOS, Unix)
401
-
-**Testing**: 730 tests across 37 test files
416
+
-**Testing**: 902 tests across 40 test files
402
417
403
418
## Development and Contribution
404
419
@@ -457,7 +472,8 @@ Common issues and solutions:
457
472
-**Python version errors**: Ensure Python 3.9+ is installed
458
473
-**Permission denied**: Use `--user` flag or check target directory permissions
459
474
-**Import errors**: Verify installation with `pip show nanorunner`
460
-
-**Enhanced monitoring unavailable**: Install with `pip install "nanorunner[enhanced] @ git+..."`
475
+
-**Missing dependencies**: Run `nanorunner check-deps` to identify missing tools and install instructions
Before investigating specific issues, run the dependency checker:
79
+
80
+
```bash
81
+
nanorunner check-deps
82
+
```
83
+
84
+
This shows the status of all required and optional dependencies with install instructions.
85
+
86
+
### Badread Not Working
87
+
88
+
**Symptom**: `badread exited with status 1` or `ModuleNotFoundError: No module named 'edlib'`
89
+
90
+
**Explanation**: Badread may be installed but missing a Python dependency (e.g., edlib). NanoRunner verifies that backends can actually start, not just that their binary exists on PATH.
91
+
92
+
**Solution**:
93
+
```bash
94
+
# Check dependency status
95
+
nanorunner check-deps
96
+
97
+
# Reinstall badread (includes all dependencies)
98
+
conda install -c conda-forge -c bioconda badread
99
+
```
100
+
101
+
### NCBI Datasets CLI Not Found
102
+
103
+
**Symptom**: `datasets CLI is required` when using `--species`, `--mock`, or `--taxid`
104
+
105
+
**Solution**:
106
+
```bash
107
+
# Install NCBI datasets CLI
108
+
conda install -c conda-forge ncbi-datasets-cli
109
+
110
+
# Verify
111
+
datasets --version
112
+
```
113
+
114
+
### NanoSim Not Working
115
+
116
+
**Symptom**: `nanosim exited with status 1` or backend unavailable
117
+
118
+
**Solution**:
119
+
```bash
120
+
# Install NanoSim
121
+
conda install -c conda-forge -c bioconda nanosim
122
+
123
+
# Verify
124
+
nanorunner check-deps
125
+
```
126
+
127
+
### NumPy Not Installed
128
+
129
+
**Symptom**: Slower read generation performance (falls back to pure Python)
0 commit comments