├── .github └── ISSUE_TEMPLATE │ ├── bug-or-error-report.md │ └── question-or-feature-request-.md ├── .gitignore ├── .readthedocs.yaml ├── LICENSE ├── Makefile ├── README.md ├── VERSION ├── doc ├── FAQ.rst ├── OPTION.rst ├── QSTART.rst ├── TEST1.rst ├── TEST2.pdf ├── TEST2.rst ├── TEST3.pdf ├── TEST3.rst ├── TEST4.pdf ├── TEST4.rst ├── TEST5.rst ├── UTILITY.rst ├── conf.py ├── index.rst ├── requirements.txt └── run.cfg ├── lib ├── Makefile ├── align.c ├── align.h ├── bseq.c ├── bseq.h ├── bsort.c ├── bsort.h ├── config_parser.py ├── ctg_cns.c ├── ctg_cns.h ├── ctg_cns.py ├── dag.c ├── htslib │ ├── INSTALL │ ├── LICENSE │ ├── Makefile │ ├── NEWS │ ├── README │ ├── bcf_sr_sort.c │ ├── bcf_sr_sort.h │ ├── bgzf.c │ ├── bgzip.1 │ ├── bgzip.c │ ├── config.h.in │ ├── config.mk.in │ ├── configure │ ├── configure.ac │ ├── cram │ │ ├── cram.h │ │ ├── cram_codecs.c │ │ ├── cram_codecs.h │ │ ├── cram_decode.c │ │ ├── cram_decode.h │ │ ├── cram_encode.c │ │ ├── cram_encode.h │ │ ├── cram_external.c │ │ ├── cram_index.c │ │ ├── cram_index.h │ │ ├── cram_io.c │ │ ├── cram_io.h │ │ ├── cram_samtools.c │ │ ├── cram_samtools.h │ │ ├── cram_stats.c │ │ ├── cram_stats.h │ │ ├── cram_structs.h │ │ ├── files.c │ │ ├── mFILE.c │ │ ├── mFILE.h │ │ ├── misc.h │ │ ├── open_trace_file.c │ │ ├── open_trace_file.h │ │ ├── os.h │ │ ├── pooled_alloc.c │ │ ├── pooled_alloc.h │ │ ├── rANS_byte.h │ │ ├── rANS_static.c │ │ ├── rANS_static.h │ │ ├── sam_header.c │ │ ├── sam_header.h │ │ ├── string_alloc.c │ │ └── string_alloc.h │ ├── errmod.c │ ├── faidx.5 │ ├── faidx.c │ ├── hfile.c │ ├── hfile_gcs.c │ ├── hfile_internal.h │ ├── hfile_libcurl.c │ ├── hfile_net.c │ ├── hfile_s3.c │ ├── hts.c │ ├── hts_internal.h │ ├── hts_os.c │ ├── htsfile.1 │ ├── htsfile.c │ ├── htslib.mk │ ├── htslib.pc.in │ ├── htslib │ │ ├── bgzf.h │ │ ├── cram.h │ │ ├── faidx.h │ │ ├── hfile.h │ │ ├── hts.h │ │ ├── hts_defs.h │ │ ├── hts_endian.h │ │ ├── hts_log.h │ │ ├── hts_os.h │ │ ├── kbitset.h │ │ ├── kfunc.h │ │ ├── khash.h │ │ ├── khash_str2int.h │ │ ├── klist.h │ │ ├── knetfile.h │ │ ├── kseq.h │ │ ├── ksort.h │ │ ├── kstring.h │ │ ├── regidx.h │ │ ├── sam.h │ │ ├── synced_bcf_reader.h │ │ ├── tbx.h │ │ ├── thread_pool.h │ │ ├── vcf.h │ │ ├── vcf_sweep.h │ │ └── vcfutils.h │ ├── htslib_vars.mk │ ├── kfunc.c │ ├── knetfile.c │ ├── kstring.c │ ├── m4 │ │ └── hts_prog_cc_warnings.m4 │ ├── md5.c │ ├── multipart.c │ ├── os │ │ ├── lzma_stub.h │ │ └── rand.c │ ├── plugin.c │ ├── probaln.c │ ├── realn.c │ ├── regidx.c │ ├── sam.5 │ ├── sam.c │ ├── synced_bcf_reader.c │ ├── tabix.1 │ ├── tabix.c │ ├── tbx.c │ ├── test │ │ ├── auxf#values.sam │ │ ├── auxf#values_java.cram │ │ ├── auxf.fa │ │ ├── auxf.fa.fai │ │ ├── bgziptest.txt │ │ ├── bgziptest.txt.gz │ │ ├── bgziptest.txt.gz.gzi │ │ ├── c1#bounds.sam │ │ ├── c1#clip.sam │ │ ├── c1#noseq.sam │ │ ├── c1#pad1.sam │ │ ├── c1#pad2.sam │ │ ├── c1#pad3.sam │ │ ├── c1#unknown.sam │ │ ├── c1.fa │ │ ├── c1.fa.fai │ │ ├── c2#pad.sam │ │ ├── c2.fa │ │ ├── c2.fa.fai │ │ ├── ce#1.sam │ │ ├── ce#1000.sam │ │ ├── ce#2.sam │ │ ├── ce#5.sam │ │ ├── ce#5b.sam │ │ ├── ce#5b_java.cram │ │ ├── ce#large_seq.sam │ │ ├── ce#supp.sam │ │ ├── ce#tag_depadded.sam │ │ ├── ce#tag_padded.sam │ │ ├── ce#unmap.sam │ │ ├── ce#unmap1.sam │ │ ├── ce#unmap2.sam │ │ ├── ce.fa │ │ ├── ce.fa.fai │ │ ├── compare_sam.pl │ │ ├── cross_validate.sh │ │ ├── faidx.fa │ │ ├── fastqs.fq │ │ ├── fastqs_README.txt │ │ ├── fieldarith.c │ │ ├── fieldarith.sam │ │ ├── formatcols.vcf │ │ ├── formatmissing-out.vcf │ │ ├── formatmissing.vcf │ │ ├── hfile.c │ │ ├── hts_endian.c │ │ ├── md#1.sam │ │ ├── md.fa │ │ ├── md.fa.fai │ │ ├── noroundtrip-out.vcf │ │ ├── noroundtrip.vcf │ │ ├── range.bam │ │ ├── range.bam.bai │ │ ├── range.cram │ │ ├── range.cram.crai │ │ ├── realn01.fa │ │ ├── realn01.fa.fai │ │ ├── realn01.sam │ │ ├── realn01_exp-a.sam │ │ ├── realn01_exp-e.sam │ │ ├── realn01_exp.sam │ │ ├── realn02-r.sam │ │ ├── realn02.fa │ │ ├── realn02.fa.fai │ │ ├── realn02.sam │ │ ├── realn02_exp-a.sam │ │ ├── realn02_exp-e.sam │ │ ├── realn02_exp.sam │ │ ├── sam.c │ │ ├── tabix │ │ │ ├── bed_file.bed │ │ │ ├── gff_file.gff │ │ │ ├── large_chr.vcf │ │ │ ├── tabix.tst │ │ │ ├── test-tabix.sh │ │ │ └── vcf_file.vcf │ │ ├── test-bcf-sr.c │ │ ├── test-bcf-sr.pl │ │ ├── test-bcf-translate.c │ │ ├── test-logging.pl │ │ ├── test-regidx.c │ │ ├── test-vcf-api.c │ │ ├── test-vcf-hdr-in.vcf │ │ ├── test-vcf-sweep.c │ │ ├── test.pl │ │ ├── test_bgzf.c │ │ ├── test_realn.c │ │ ├── test_view.c │ │ ├── thrash_threads1.c │ │ ├── thrash_threads2.c │ │ ├── thrash_threads3.c │ │ ├── thrash_threads4.c │ │ ├── thrash_threads5.c │ │ ├── thrash_threads6.c │ │ ├── thread_pool.md │ │ ├── xx#blank.sam │ │ ├── xx#large_aux.sam │ │ ├── xx#large_aux2.sam │ │ ├── xx#large_aux_java.cram │ │ ├── xx#minimal.sam │ │ ├── xx#pair.sam │ │ ├── xx#repeated.sam │ │ ├── xx#rg.sam │ │ ├── xx#tlen.sam │ │ ├── xx#tlen2.sam │ │ ├── xx#triplet.sam │ │ ├── xx#unsorted.sam │ │ ├── xx.fa │ │ └── xx.fa.fai │ ├── textutils.c │ ├── textutils_internal.h │ ├── thread_pool.c │ ├── thread_pool_internal.h │ ├── vcf.5 │ ├── vcf.c │ ├── vcf_sweep.c │ ├── vcfutils.c │ └── version.sh ├── index.c ├── index.h ├── kit.c ├── kit.py ├── mseq.h ├── nextcorrect.c ├── nextcorrect.h ├── nextcorrect.py ├── ovl.c ├── ovl.h ├── ovlseq.c └── split_cns.py ├── minimap2 ├── LICENSE.txt ├── MANIFEST.in ├── Makefile ├── NEWS.md ├── README.md ├── align.c ├── bseq.c ├── bseq.h ├── chain.c ├── cookbook.md ├── esterr.c ├── example.c ├── format.c ├── hit.c ├── index.c ├── kalloc.c ├── kalloc.h ├── kdq.h ├── ketopt.h ├── khash.h ├── kseq.h ├── ksort.h ├── ksw2.h ├── ksw2_dispatch.c ├── ksw2_extd2_sse.c ├── ksw2_exts2_sse.c ├── ksw2_extz2_sse.c ├── ksw2_ll_sse.c ├── kthread.c ├── kthread.h ├── kvec.h ├── main.c ├── map.c ├── minimap.h ├── minimap2.1 ├── misc.c ├── misc │ ├── README.md │ └── paftools.js ├── mmpriv.h ├── options.c ├── pe.c ├── python │ ├── README.rst │ ├── cmappy.h │ ├── cmappy.pxd │ ├── mappy.pyx │ └── minimap2.py ├── sdust.c ├── sdust.h ├── setup.py ├── sketch.c ├── splitidx.c ├── sse2neon │ └── emmintrin.h └── test │ ├── MT-human.fa │ ├── MT-orang.fa │ ├── q-inv.fa │ ├── q2.fa │ ├── t-inv.fa │ └── t2.fa ├── nextDenovo ├── test_data ├── input.fofn ├── reads_test.fa.gz └── run.cfg └── util ├── Makefile ├── bam_sort.c ├── khash.h ├── kseq.h ├── ng ├── Makefile ├── asg.c ├── asg.h ├── common.h ├── ctg.c ├── ctg.h ├── edge.c ├── edge.h ├── kit.c ├── kit.h ├── main.c ├── node.c ├── node.h ├── opt.c ├── opt.h ├── out.c └── out.h ├── ovl_cvt.c ├── ovl_sort.c ├── ovl_sort.h ├── seq_bit.c ├── seq_dump.c ├── seq_stat.c ├── thpool.c └── thpool.h /.github/ISSUE_TEMPLATE/bug-or-error-report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug or Error report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug or error is. 12 | 13 | **Error message** 14 | Paste the complete log message, include the main task log and failed subtask log. 15 | The main task log is usually located in your working directory and is named `pidXXX.log.info` and the main task log will tell you the failed subtask log in the last few lines, such as: 16 |
17 | [ERROR] 2020-07-01 11:06:57,184 cns_align failed: please check the following logs:
18 | [ERROR] 2020-07-01 11:06:57,185 ~/NextDenovo/test_data/01_rundir/02.cns_align/02.cns_align.sh.work/cns_align0/nextDenovo.sh.e
19 | 
20 | 21 | **Genome characteristics** 22 | `genome size, heterozygous rate, repeat content...` 23 | 24 | **Input data** 25 | `Total base count, sequencing depth, average/N50 read length...` 26 | 27 | **Config file** 28 | Please paste the complete content of the Config file (`run.cfg`) to here. 29 | 30 | **Operating system** 31 | Which operating system and version are you using? 32 | You can use the command `lsb_release -a` to get it. 33 | 34 | **GCC** 35 | What version of GCC are you using? 36 | You can use the command `gcc -v` to get it. 37 | 38 | **Python** 39 | What version of Python are you using? 40 | You can use the command `python --version` to get it. 41 | 42 | **NextDenovo** 43 | What version of NextDenovo are you using? 44 | You can use the command `nextDenovo -v` to get it. 45 | 46 | **To Reproduce** (Optional) 47 | Steps to reproduce the behavior. Providing a minimal test dataset on which we can reproduce the behavior will generally lead to quicker turnaround time! 48 | 49 | **Additional context** (Optional) 50 | Add any other context about the problem here. 51 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question-or-feature-request-.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 'Question or Feature request ' 3 | about: Ask a question or suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Question or Expected behavior** 11 | A clear and concise description of your question or what you expected to happen. 12 | 13 | **Operating system** 14 | Which operating system and version are you using? 15 | You can use the command `lsb_release -a` to get it. 16 | 17 | **GCC** 18 | What version of GCC are you using? 19 | You can use the command `gcc -v` to get it. 20 | 21 | **Python** 22 | What version of Python are you using? 23 | You can use the command `python --version` to get it. 24 | 25 | **NextDenovo** 26 | What version of NextDenovo are you using? 27 | You can use the command `nextDenovo -v` to get it. 28 | 29 | **Additional context** (Optional) 30 | Add any other context about the problem here. 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | wheels/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | MANIFEST 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *.cover 46 | .hypothesis/ 47 | .pytest_cache/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | db.sqlite3 57 | 58 | # Flask stuff: 59 | instance/ 60 | .webassets-cache 61 | 62 | # Scrapy stuff: 63 | .scrapy 64 | 65 | # Sphinx documentation 66 | docs/_build/ 67 | 68 | # PyBuilder 69 | target/ 70 | 71 | # Jupyter Notebook 72 | .ipynb_checkpoints 73 | 74 | # pyenv 75 | .python-version 76 | 77 | # celery beat schedule file 78 | celerybeat-schedule 79 | 80 | # SageMath parsed files 81 | *.sage.py 82 | 83 | # Environments 84 | .env 85 | .venv 86 | env/ 87 | venv/ 88 | ENV/ 89 | env.bak/ 90 | venv.bak/ 91 | 92 | # Spyder project settings 93 | .spyderproject 94 | .spyproject 95 | 96 | # Rope project settings 97 | .ropeproject 98 | 99 | # mkdocs documentation 100 | /site 101 | 102 | # mypy 103 | .mypy_cache/ 104 | 105 | -------------------------------------------------------------------------------- /.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | # .readthedocs.yaml 2 | # Read the Docs configuration file 3 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details 4 | 5 | # Required 6 | version: 2 7 | 8 | # Set the version of Python and other tools you might need 9 | build: 10 | os: ubuntu-22.04 11 | tools: 12 | python: "3.11" 13 | 14 | # Build documentation in the docs/ directory with Sphinx 15 | sphinx: 16 | configuration: doc/conf.py 17 | 18 | # We recommend specifying your dependencies to enable reproducible builds: 19 | # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html 20 | python: 21 | install: 22 | - requirements: doc/requirements.txt -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | TOP_DIR=$(PWD) 2 | BIN_DIR=$(TOP_DIR)/bin 3 | SUB_DIR=minimap2 util lib 4 | 5 | TARGET_MINIMAP=minimap2-nd 6 | TARGER_UTIL=seq_dump ovl_sort seq_stat ovl_cvt seq_bit bam_sort nextgraph 7 | 8 | all:make_bin_dir 9 | $(foreach N, $(SUB_DIR), make -C $(N);) 10 | cp $(TOP_DIR)/minimap2/$(TARGET_MINIMAP) $(TOP_DIR)/bin/ 11 | $(foreach N, $(TARGER_UTIL), cp $(TOP_DIR)/util/$(N) $(TOP_DIR)/bin/;) 12 | 13 | make_bin_dir: 14 | @if test ! -d $(BIN_DIR) ; \ 15 | then \ 16 | mkdir $(BIN_DIR) ; \ 17 | fi 18 | 19 | clean: 20 | rm -rf $(BIN_DIR) 21 | $(foreach N, $(SUB_DIR), make -C $(N) clean;) 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Downloads](https://img.shields.io/github/downloads/Nextomics/NextDenovo/total?logo=github)](https://github.com/Nextomics/NextDenovo/releases/latest/download/NextDenovo.tgz) 2 | [![Release](https://img.shields.io/github/release/Nextomics/NextDenovo.svg)](https://github.com/Nextomics/NextDenovo/releases) 3 | [![Documentation Status](https://readthedocs.org/projects/nextdenovo/badge/?version=latest)](https://nextdenovo.readthedocs.io/en/latest/?badge=latest) 4 | [![DOI](https://img.shields.io/badge/DOI-10.1186%2Fs13059--024--03252--4-blue)](https://doi.org/10.1186/s13059-024-03252-4) 5 | 6 | # NextDenovo 7 | NextDenovo is a string graph-based *de novo* assembler for long reads (CLR, ~~HiFi~~ and ONT). It uses a "correct-then-assemble" strategy similar to canu (no correction step for PacBio HiFi reads), but requires significantly less computing resources and storages. After assembly, the per-base accuracy is about 98-99.8%, to further improve single base accuracy, try [NextPolish](https://github.com/Nextomics/NextPolish). 8 | 9 | We benchmarked NextDenovo against other assemblers using Oxford Nanopore long reads from [human](https://nextdenovo.readthedocs.io/en/latest/TEST2.html) and [Drosophila melanogaster](https://nextdenovo.readthedocs.io/en/latest/TEST4.html), and PacBio continuous long reads (CLR) from [Arabidopsis thaliana](https://nextdenovo.readthedocs.io/en/latest/TEST3.html). NextDenovo produces more contiguous assemblies with fewer contigs compared to the other tools. NextDenovo also shows a high assembly accurate level in terms of assembly consistency and single-base accuracy. 10 | 11 | ## Installation 12 | 13 | * **REQUIREMENT** 14 | * [Python](https://www.python.org/download/releases/) (Support python 2 and 3): 15 | * [Paralleltask](https://github.com/moold/ParallelTask) `pip install paralleltask` 16 | 17 | * **INSTALL** 18 | 19 | click [here](https://github.com/Nextomics/NextDenovo/releases/latest/download/NextDenovo.tgz) or use the following command: 20 | ```sh 21 | wget https://github.com/Nextomics/NextDenovo/releases/latest/download/NextDenovo.tgz 22 | tar -vxzf NextDenovo.tgz && cd NextDenovo 23 | ``` 24 | 25 | If you want to compile from the source, run: 26 | 27 | ```sh 28 | git clone git@github.com:Nextomics/NextDenovo.git 29 | cd NextDenovo && make 30 | ``` 31 | 32 | * **TEST** 33 | `nextDenovo test_data/run.cfg` 34 | 35 | ## Learn 36 | 37 | * [Quick Start](https://nextdenovo.readthedocs.io/en/latest/QSTART.html#quick-start) - no experience required, download and assemble now 38 | * [Tutorial](https://nextdenovo.readthedocs.io/en/latest/TEST1.html) - step by step introduction to assemble the HG002 genome 39 | * [FAQ](https://nextdenovo.readthedocs.io/en/latest/FAQ.html) - frequently asked questions 40 | * [Parameter Reference](https://nextdenovo.readthedocs.io/en/latest/OPTION.html) - a detailed introduction about all the parameters 41 | * [Cite](https://nextdenovo.readthedocs.io/en/latest/QSTART.html#cite) - if you get a good assembly with NextDenovo, please cite it 42 | 43 | ## Star 44 | 45 | You can track updates by tab the `Star` button on the upper-right corner at this page. 46 | 47 | ## More 48 | 49 | The complete user documentation is available [here](https://nextdenovo.readthedocs.io/en/latest/). 50 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 2.5.2 2 | -------------------------------------------------------------------------------- /doc/TEST1.rst: -------------------------------------------------------------------------------- 1 | .. title:: Tutorial 2 | 3 | Assemble the genome of HG002_NA24385_son using NextDenovo 4 | ----------------------------------------------------------- 5 | 6 | 1. **Download reads** 7 | 8 | .. code-block:: shell 9 | 10 | wget ftp://ftp-trace.ncbi.nlm.nih.gov/giab/ftp/data/AshkenazimTrio/HG002_NA24385_son/Ultralong_OxfordNanopore/guppy-V2.3.4_2019-06-26/ultra-long-ont.fastq.gz 11 | 12 | 2. **Prepare input file (input.fofn)** 13 | 14 | .. code-block:: shell 15 | 16 | ls ultra-long-ont.fastq.gz > input.fofn 17 | 18 | 3. **Prepare config file (run.cfg)** 19 | 20 | .. code-block:: shell 21 | 22 | [General] 23 | job_type = sge # here we use SGE to manage jobs 24 | job_prefix = nextDenovo 25 | task = all 26 | rewrite = yes 27 | deltmp = yes 28 | parallel_jobs = 22 29 | input_type = raw 30 | read_type = ont # clr, ont, hifi 31 | input_fofn = input.fofn 32 | workdir = HG002_NA24385_son_assemble 33 | 34 | [correct_option] 35 | read_cutoff = 1k 36 | genome_size = 3g # estimated genome size 37 | sort_options = -m 50g -t 30 38 | minimap2_options_raw = -t 8 39 | pa_correction = 5 40 | correction_options = -p 30 41 | 42 | [assemble_option] 43 | minimap2_options_cns = -t 8 44 | nextgraph_options = -a 1 45 | 46 | 4. **Run** 47 | 48 | .. code-block:: shell 49 | 50 | nohup nextDenovo run.cfg & 51 | 52 | 5. **Get result** 53 | 54 | - Final corrected reads file (use the ``-b`` parameter to get more corrected reads):: 55 | 56 | HG002_NA24385_son_assemble/02.cns_align/01.seed_cns.sh.work/seed_cns*/cns.fasta 57 | 58 | - Final assembly result:: 59 | 60 | HG002_NA24385_son_assemble/03.ctg_graph/nd.asm.fasta 61 | 62 | you can get some basic statistical information from file ``HG002_NA24385_son_assemble/03.ctg_graph/nd.asm.fasta.stat``, the folowing is the assembly statistics with default parameters:: 63 | 64 | Type Length (bp) Count (#) 65 | N10 168924870 2 66 | N20 127260938 4 67 | N30 94622851 7 68 | N40 85456034 10 69 | N50 79737202 13 70 | N60 69943198 17 71 | N70 58504138 21 72 | N80 40548231 27 73 | N90 19732879 36 74 | 75 | Min. 82439 - 76 | Max. 220056807 - 77 | Ave. 24389616 - 78 | Total 2877974703 118 79 | 80 | .. note:: This result will have some minor changes with the version upgrade. -------------------------------------------------------------------------------- /doc/TEST2.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Nextomics/NextDenovo/0e5fa5dae1d0afa33846ff8ad87287ccbe5a1146/doc/TEST2.pdf -------------------------------------------------------------------------------- /doc/TEST3.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Nextomics/NextDenovo/0e5fa5dae1d0afa33846ff8ad87287ccbe5a1146/doc/TEST3.pdf -------------------------------------------------------------------------------- /doc/TEST4.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Nextomics/NextDenovo/0e5fa5dae1d0afa33846ff8ad87287ccbe5a1146/doc/TEST4.pdf -------------------------------------------------------------------------------- /doc/conf.py: -------------------------------------------------------------------------------- 1 | # Configuration file for the Sphinx documentation builder. 2 | # 3 | # This file only contains a selection of the most common options. For a full 4 | # list see the documentation: 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 6 | 7 | # -- Path setup -------------------------------------------------------------- 8 | 9 | # If extensions (or modules to document with autodoc) are in another directory, 10 | # add these directories to sys.path here. If the directory is relative to the 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. 12 | # 13 | # import os 14 | # import sys 15 | # sys.path.insert(0, os.path.abspath('.')) 16 | 17 | 18 | # -- Project information ----------------------------------------------------- 19 | 20 | project = 'nextdenovo' 21 | copyright = '2020, jiang' 22 | author = 'jiang' 23 | 24 | 25 | # -- General configuration --------------------------------------------------- 26 | 27 | # Add any Sphinx extension module names here, as strings. They can be 28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 29 | # ones. 30 | extensions = [ 31 | 'sphinx_copybutton', 32 | 'sphinx_rtd_theme', 33 | ] 34 | 35 | # Add any paths that contain templates here, relative to this directory. 36 | templates_path = ['_templates'] 37 | 38 | # List of patterns, relative to source directory, that match files and 39 | # directories to ignore when looking for source files. 40 | # This pattern also affects html_static_path and html_extra_path. 41 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 42 | 43 | 44 | # -- Options for HTML output ------------------------------------------------- 45 | 46 | # The theme to use for HTML and HTML Help pages. See the documentation for 47 | # a list of builtin themes. 48 | # 49 | html_theme = 'sphinx_rtd_theme' 50 | 51 | # Add any paths that contain custom static files (such as style sheets) here, 52 | # relative to this directory. They are copied after the builtin static files, 53 | # so a file named "default.css" will overwrite the builtin "default.css". 54 | html_static_path = ['_static'] 55 | -------------------------------------------------------------------------------- /doc/index.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | :caption: Getting started 3 | :maxdepth: 2 4 | :hidden: 5 | 6 | Usuage 7 | Tutorial 8 | Parameter Reference