.. HyperImmunISE documentation master file, created by
   sphinx-quickstart on Thu May 23 08:14:48 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to HyperImmunISE's documentation!
=========================================

**HyperImmunISE** is a Python package for generating hyperglycosylated immunogens. 

.. note::

   This project is under development.

Contents
========

.. toctree::
   :maxdepth: 2
  
   usage
   optimization
   functions
   troubleshooting