.. SPIREpy documentation master file, created by
   sphinx-quickstart on Mon Jun 23 13:09:22 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SPIREpy
=======

Welcome
-------


SPIREpy is a Python package and command-line tool that allows users to interact
with the SPIRE_ database in a more convinient way.

.. _SPIRE: https://spire.embl.de/

Contents
--------

.. toctree::
   :maxdepth: 1

   Quickstart <quickstart>


Installation
------------

SPIREpy is available on PyPI and can be installed via

.. code-block:: bash

   pip install spirepy

Credits
-------

These tools have been developed by the `Big Data Biology Lab`_ at the `Centre for Microbiome Research`_ at the
`Queensland University of Technology`_ (Brisbane, Australia). It
is part of the `SPIRE: a Searchable, Planetary-scale mIcrobiome REsource`_ project.

.. _`Big Data Biology Lab`: https://www.big-data-biology.org/
.. _`Centre for Microbiome Research`: https://research.qut.edu.au/cmr/
.. _`Queensland University of Technology`: https://www.qut.edu.au/
.. _`SPIRE: a Searchable, Planetary-scale mIcrobiome REsource`: https://spire.embl.de/

SPIRE is published in

::

      Thomas S B Schmidt, Anthony Fullam, Pamela Ferretti, Askarbek Orakov, Oleksandr
      M Maistrenko, Hans-Joachim Ruscheweyh, Ivica Letunic, Yiqian Duan, Thea Van
      Rossum, Shinichi Sunagawa, Daniel R Mende, Robert D Finn, Michael Kuhn, Luis
      Pedro Coelho, Peer Bork, SPIRE: a Searchable, Planetary-scale mIcrobiome
      REsource, Nucleic Acids Research, Volume 52, Issue D1, 5 January 2024, Pages
      D777–D783
      https://doi.org/10.1093/nar/gkad943

Please cite this publication when referencing SPIREpy.