=================================================================
Welcome to FABRIC's Integrated Model-Based Traffic documentation!
=================================================================

.. danger:: Prototype

    The documentation is prepared for the prototype workflow created
    by the PI team. The methods and workflow is fragile. Please use
    caution in following the procedure to setup.

Overview
--------

Integration of traffic models on experimenter reservation topologies
is achieved through this integration project. The pages are organized
to provide the resources such as the source code and the Jupyter 
Lab Notebooks as well as sample use cases that span the complete
instantiation workflow for a typical client-server application
model to a FABRIC experimenter.

.. admonition:: Acknowledgment

    This project has been funded in part by the National Science
    Foundation (NSF) award OAC-CNS-2018472. The title of the project
    award is: CC\* Integration-Small: Integrating Application Agnostic
    Learning with FABRIC for Enabling Realistic High-Fidelity
    Traffic Generation and Modeling

    The FABRIC matrix slides of the project can be viewed `here
    <https://www.personal.kent.edu/~dgurkan/projects/trafficgeneration/matrix.pdf`.

Getting Started
---------------

1. Download installation material
2. Upload to Fabric Jupyter environment
3. Follow the sequence provided by the Jupyter notebook to setup and deploy

.. toctree::
   :maxdepth: 1
   :caption: Pages:

   Overview <workflow>
   Integration <jupyter>
   Package <package_bundle_tree>