enviPath-python
===============

**enviPath-python** is an open-source package that enables users to connect with the REST API endpoint of
`enviPath <https://envipath.org/>`_. This documentation is intended to help you learn how to use enviPath-python and
encourage you to upload your data on the system. For more in-depth knowledge of the theory and development of enviPath,
please refer to the `Wiki <https://wiki.envipath.com/>`_ and its corresponding  publication
`enviPath - The environmental contaminant biotransformation pathway resource <https://academic.oup.com/nar/article/44/D1/D502/2502710>`_.

If you want to learn how to install and use this package, please feel free to check our :ref:`installation <Installation>` and
:ref:`Getting Started <Getting Started>` tutorials.

What to do if you find issues
=============================
We welcome bug reports, patches, feature requests, and other comments via the
`GitHub issue tracker <https://github.com/enviPath/enviPath-python/issues>`_, but you should check our
`community forum <https://community.envipath.org/>`_ first. We will come back to you with an answer as
soon as possible.


License & Attribution
=====================

MIT License. Copyright 2023 enviPath UG & Co. KG.

If you make use of enviPath-python in your work, please cite our `paper <https://academic.oup.com/nar/article/44/D1/D502/2502710>`_.

.. toctree::
   :caption: Getting Started
   :hidden:

   installation
   getting_started
   objects

.. toctree::
   :caption: User Guide
   :hidden:

   tutorials/accessing_packages
   tutorials/create_package
   tutorials/transformation_product_prediction
   tutorials/download_additional_information_data
   tutorials/download_pathway_SBML

.. toctree::
   :caption: Developers Guide
   :hidden:

   enviPath_python

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

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