Start here
==========

Nornir takes overlapping microscope images and produces aligned 2D mosaics and 3D volumes. Pick the path that matches what you are doing.

New users
---------

* :doc:`host_requirements` — whether this machine can run Pyre, a pipeline, or Docker.
* :doc:`overview` — what Nornir is, and where Viking and SBFSEM-tools fit.
* :doc:`overview_alignment_theory` — how a volume is built, with figures.
* :doc:`packages/pyre_install` — Windows installer for the interactive tool.
* :doc:`guides/pyre_use` — mouse, keyboard, and registration controls.
* :doc:`guides/build_volume` — import through ``CreateVikingXML``, then Viking and SBFSEM-tools.

Agents and contributors
-----------------------

* :doc:`agents` — monorepo layout, installs, tests, and logging.
* :doc:`development/logging` — session log files and worker processes.
* :doc:`docker/cursor_dev` — Dev Container shell.

Performance
-----------

* :doc:`performance/index` — production hardware, pools, GPU, and profiling.

Reference
---------

* :doc:`packages/index` — package overviews.
* :doc:`pipelines` — ``nornir-build`` stages grouped by job.
* :doc:`api/index` — generated API pages.
* :doc:`development/index` — release, publishing, and audits.