.. PPI.bio documentation master file, created by
   sphinx-quickstart on Thu Feb  8 11:50:47 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Home
====
Welcome, to the documentation for self-hosting a PPI.bio server. This is the code that runs
`PPI.bio <https://ppi.bio>`_.

What is this?
-------------
PPI.bio is a web interface for RAPPPID and INTREPPPID, a deep-learning models for predicting
`protein-protein interactions <https://en.wikipedia.org/wiki/Protein%E2%80%93protein_interaction>`_ (PPIs). This online
interface allows you to use RAPPPID and INTREPPPID through your browser. This is the documentation about how you can run it on your own
server. You can try out the live version on `PPI.bio <https://ppi.bio>`_ You can learn more on the `about <about.html>`_ page.

New here?
---------
Check-out the `getting started <getting_started.html>`_ page.

Are you using INTREPPID/RAPPPID?
--------------------------------
If you are using INTREPPPID or RAPPPID, feel free to drop me a line at ``hello〔АТ〕jszym.com``.

If you are using RAPPPID as part of a manuscript, kindly cite
`our paper <https://doi.org/10.1093/bioinformatics/btac429>`_ in OUP Bioinformatics:

    Joseph Szymborski , Amin Emad, RAPPPID: towards generalizable protein interaction prediction with AWD-LSTM twin networks, *Bioinformatics*, Volume 38, Issue 16, August 2022, Pages 3958–3967, `https://doi.org/10.1093/bioinformatics/btac429 <https://doi.org/10.1093/bioinformatics/btac429>`_

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

   about
   getting_started
   configuration


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

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