.. CRISPRzip documentation master file, created by
   sphinx-quickstart on Mon Dec  9 14:39:47 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

CRISPRzip documentation
=============================

.. toctree::
   :maxdepth: 2
   :caption: User documentation
   :hidden:

   userdocs/about.md
   userdocs/gettingstarted.md
   userdocs/tutorial.ipynb
   userdocs/code_structure.md

.. toctree::
   :maxdepth: 2
   :caption: Developing guidelines
   :hidden:

   devdocs/contributing.md
   devdocs/code_of_conduct.md
   devdocs/changelog.md

.. toctree::
   :maxdepth: 2
   :caption: API reference
   :hidden:

   apidocs/crisprzip.coarsegrain
   apidocs/crisprzip.kinetics
   apidocs/crisprzip.matrix_expon
   apidocs/crisprzip.nucleic_acid
   apidocs/crisprzip.plotting

Introduction
============
Welcome! This is the documentation for CRISPRzip.


User documentation
------------------
Planning to use the package? Need help? Check out our user documentation!

- :doc:`About <userdocs/about>` - Read more about this project.
- :doc:`Getting started <userdocs/gettingstarted>` - Instructions how to install and work with CRISPRzip.
- :doc:`Tutorial <userdocs/tutorial>` - More examples what you can do with the model.
- :doc:`Code structure <userdocs/code_structure>` - Learn about how the code is set up.

Developing guidelines
---------------------
Want to get help? Report a bug? Suggestions for improvement? Awesome!

- :doc:`Contributing <devdocs/contributing>` - How to contribute.
- :doc:`Code of Conduct <devdocs/code_of_conduct>` - Our standards for a welcoming environment for everyone.
- :doc:`Changelog <devdocs/changelog>` - What has changed between releases?

API reference
-------------

- :doc:`apidocs/crisprzip.coarsegrain`
- :doc:`apidocs/crisprzip.kinetics`
- :doc:`apidocs/crisprzip.matrix_expon`
- :doc:`apidocs/crisprzip.nucleic_acid`
- :doc:`apidocs/crisprzip.plotting`