.. pop2net documentation master file, created by
   sphinx-quickstart on Wed Nov 30 12:19:20 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Pop2net's documentation!
===================================

**Pop2net** is a new software package for Python that simplifies the creation of network structures for agent-based models.
Using a simple syntax, Pop2net makes it easy to determine how links between certain (groups of) agents are formed by defining contact layers.
Due to its full integration into `AgentPy <https://agentpy.readthedocs.io/en/latest/>`_ , networks built with Pop2net can be directly used to run simulations.
Pop2net also offers tools to create populations of agents based on empirical micro-data and to validate network properties.

.. note::
      This project is under very active development and still in it's early stages.


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   about
   section_introduction
   installation
   api/index
   section_examples
   developers


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`