22bIOINFORMATICS @WUST
33
44# Installation
5- git clone https://github.com/Karo555/needleman-wunsch.git
6- cd needleman-wunsch-aligner
5+ git clone https://github.com/Karo555/needleman-wunsch.git < br >
6+ cd needleman-wunsch-aligner < br >
77pip install -e .[ html,pdf]
88
99# Usage
10- 1 . Basic DNA alignment (manual input)
10+ 1 . Basic DNA alignment (manual input) < br >
1111needleman-wunsch --manual
1212
1313You’ll be prompted to enter:
@@ -16,41 +16,41 @@ You’ll be prompted to enter:
1616- Sequence 1
1717- Sequence 2
1818
19- 2 . FASTA file input
20- needleman-wunsch --input data/seq1.fasta data/seq2.fasta --output reports/alignment.txt
19+ 2 . FASTA file input < br >
20+ needleman-wunsch --input data/seq1.fasta data/seq2.fasta --output reports/alignment.txt < br >
2121
22- data/seq1.fasta and data/seq2.fasta each contain exactly one record.
23- The text report is saved to reports/alignment.txt
22+ data/seq1.fasta and data/seq2.fasta each contain exactly one record. < br >
23+ The text report is saved to reports/alignment.txt < br >
2424
25- 3 . Custom scoring: override match, mismatch, and gap scores
25+ 3 . Custom scoring. Override match, mismatch, and gap scores. < br >
2626needleman-wunsch --input data/seq1.fasta data/seq2.fasta --match 2 --mismatch -1 --gap -2
2727
28- 4 . Enumerate all optimal alignments
28+ 4 . Enumerate all optimal alignments < br >
2929needleman-wunsch --input data/seq1.fasta data/seq2.fasta --all-paths --output reports/all_paths.txt
3030
3131Lists every equally optimal alignment and writes them to reports/all_paths.txt.
3232
33- 5 . Export raw DP matrix as CSV
33+ 5 . Export raw DP matrix as CSV < br >
3434needleman-wunsch --input data/seq1.fasta data/seq2.fasta --matrix-out reports/matrix.csv
3535
3636The full (N+1)×(M+1) score matrix is saved in comma‐separated format for downstream analysis
3737
38- 6 . Structured JSON output
38+ 6 . Structured JSON output < br >
3939needleman-wunsch --input data/seq1.fasta data/seq2.fasta --json reports/alignment.json
4040
41- Produces a JSON file containing:
41+ Produces a JSON file containing: < br >
4242
4343Original sequences and IDs
4444Scoring parameters
4545Full DP matrix
4646All alignments with per-path statistics
4747
48- 7 . Heatmap visualization
48+ 7 . Heatmap visualization < br >
4949needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png
5050
5151Renders the DP matrix as a heatmap PNG saved to plots/heatmap.png.
5252
53- 8 . HTML summary report
53+ 8 . HTML summary report < br >
5454needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png --html reports/alignment.html
5555
5656Generates a standalone HTML page embedding:
@@ -65,19 +65,19 @@ python3 -m http.server 8000
6565
6666then visit http://localhost:8000/reports/alignment.html
6767
68- 9 . PDF summary report
68+ 9 . PDF summary report < br >
6969needleman-wunsch --input data/seq1.fasta data/seq2.fasta --plot plots/heatmap.png --pdf reports/alignment.pdf
7070
71- 10 . one shot
71+ 10 . one shot < br >
7272needleman-wunsch --input data/seq1.fasta data/seq2.fasta --all-paths --match 2 --mismatch -1 --gap -2 --output reports/alignment.txt --matrix-out reports/matrix.csv --json reports/alignment.json --plot plots/heatmap.png --html reports/alignment.html --pdf reports/alignment.pdf
7373
74- reports/alignment.txt (text report)
75- reports/matrix.csv (raw DP matrix)
76- reports/alignment.json (structured JSON)
77- plots/heatmap.png (heatmap image)
78- reports/alignment.html (HTML summary)
79- reports/alignment.pdf (PDF summary)
74+ reports/alignment.txt (text report)< br >
75+ reports/matrix.csv (raw DP matrix)< br >
76+ reports/alignment.json (structured JSON)< br >
77+ plots/heatmap.png (heatmap image)< br >
78+ reports/alignment.html (HTML summary)< br >
79+ reports/alignment.pdf (PDF summary)< br >
8080
8181
82- ## 📄 License
83- This project is licensed under the MIT License. See [ LICENSE] ( LICENSE ) for details.
82+ ## 📄 License< br >
83+ This project is licensed under the MIT License. See [ LICENSE] ( LICENSE ) for details.< br >
0 commit comments