.. MIMIK documentation master file, created by
   sphinx-quickstart on Mon Jun  2 09:23:30 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MIMIK documentation
===================

Mission Illustration and Metric Interface for Killwebs (MIMIK) is a tool that allows a user to construct, visualize, and simulate a custom killweb. This 
guide will review how to utilize these features using the minimal example included in the repository.

`Source Code <https://github.com/vtnsi/mimik>`_

.. toctree::
   :maxdepth: 1
   :caption: Getting Started
   :hidden:

   installation
   quickstart

.. toctree::
   :maxdepth: 1
   :caption: MIMIK Introduction
   :hidden:

   building_basic_killweb
   tutorials/Tutorial 1 - Loading and Visualizing Killwebs
   tutorials/Tutorial 2 - Adding and Removing Components
   tutorials/Tutorial 3 - Paths
   tutorials/Tutorial 4 - Tasks and Simulation

.. toctree::
   :maxdepth: 5
   :caption: MIMIK API
   :hidden:

   modules/modules