Skip to content

Latest commit

 

History

History
102 lines (84 loc) · 3.42 KB

index.rst

File metadata and controls

102 lines (84 loc) · 3.42 KB

Welcome to Nextstrain's documentation!

Nextstrain is a project to harness the scientific and public health potential of pathogen genome data. It's made up of many different parts that all work together. Through our website, nextstrain.org, we provide a continually-updated view of publicly available data with powerful analyses and visualizations showing pathogen evolution and epidemic spread. Through our open-source software tools, we aim to help you analyze and visualize your own data in the same way. Our goal is to aid epidemiological understanding and improve outbreak response.

Our intent for this documentation site is to cover all parts of Nextstrain, from viewing the website to producing your own analyses to contributing to Nextstrain's development.

Hint

If you're new to Nextstrain, start with :doc:`/learn/about`.

If you're interested in how to interpret what you see on nextstrain.org, start with :doc:`/learn/interpret/index`.

If you're ready to go beyond viewing the website (or just plain curious!), start with :doc:`/learn/parts`.

If you have questions, need help, or simply want to say hi, post to our discussion forum where the Nextstrain team and other Nextstrain users provide assistance. For private inquiries, email the Nextstrain team.

.. toctree::
    :maxdepth: 1
    :titlesonly:
    :caption: About
    :hidden:

    Introduction <self>
    learn/about
    learn/parts
    Augur → Auspice <learn/augur-to-auspice>
    learn/interpret/index
    Pathogens <learn/pathogens/index>
    learn/groups/index


.. toctree::
    :maxdepth: 1
    :titlesonly:
    :caption: Tutorials
    :hidden:

    Installing <install>
    tutorials/running-a-phylogenetic-workflow
    tutorials/creating-a-phylogenetic-workflow
    Exploring SARS-CoV-2 evolution <https://docs.nextstrain.org/projects/ncov/page/index.html>
    tutorials/creating-a-bacterial-phylogenetic-workflow
    tutorials/narratives-how-to-write
    Analyzing genomes with Nextclade <https://docs.nextstrain.org/projects/nextclade/page/user/nextclade-web/index.html>
    tutorials/using-a-pathogen-repo/index
    tutorials/creating-a-pathogen-repo/index

.. toctree::
    :maxdepth: 1
    :titlesonly:
    :caption: How-to Guides
    :hidden:

    Bioinformatics <guides/bioinformatics/index>
    Sharing analyses <guides/share/index>
    Communicating scientific insights <guides/communicate/index>
    Viewing previous analyses <guides/snapshots>
    Managing an installation <guides/manage-installation>
    Contributing <guides/contribute/index>

.. toctree::
    :maxdepth: 1
    :titlesonly:
    :caption: Components
    :hidden:

    Augur <https://docs.nextstrain.org/projects/augur/>
    Auspice <https://docs.nextstrain.org/projects/auspice/>
    Nextstrain CLI <https://docs.nextstrain.org/projects/cli/>
    Nextclade CLI <https://docs.nextstrain.org/projects/nextclade/page/user/nextclade-cli/index.html>
    nextstrain.org <https://docs.nextstrain.org/projects/nextstrain-dot-org/>

.. toctree::
    :maxdepth: 1
    :titlesonly:
    :caption: Reference
    :hidden:

    reference/glossary
    reference/data-formats
    reference/data-files
    FAQ <reference/faq>
    reference/ca-certificates
    reference/snakemake-style-guide
    reference/documentation-style-guide
    reference/governance