FUSOR |version|
=========================

.. image:: https://img.shields.io/pypi/v/fusor.svg
   :alt: PyPI version
   :target: https://pypi.python.org/pypi/fusor

.. image:: https://img.shields.io/pypi/l/fusor.svg
   :alt: License
   :target: https://github.com/cancervariants/fusor/blob/main/LICENSE

.. image:: https://img.shields.io/pypi/pyversions/fusor?color=gr
   :alt: PyPI - supported Python versions

.. image:: https://github.com/cancervariants/fusor/actions/workflows/checks.yaml/badge.svg
   :alt: tests status
   :target: https://github.com/cancervariants/fusor/actions/workflows/checks.yaml

FUSOR (FUSion Object Representation) is a Python package that provides modeling and validation tools for representing gene fusions in a flexible, computable structure. It implements data models and nomenclature generation utilities in support of the `Gene Fusion Specification <https://fusions.cancervariants.org/en/latest/>`_ developed by the `Variant Interpretation in Cancer Consortium <https://cancervariants.org/>`_.

See the :ref:`Installation <install>` and :ref:`Usage <usage>` pages for information on getting started. Individual classes and functions are documented within the :ref:`API reference <api_reference>` pages.

FUSOR is developed primarily by the `Wagner Lab <https://www.nationwidechildrens.org/specialties/institute-for-genomic-medicine/research-labs/wagner-lab>`_ at `Nationwide Children's Hospital <https://www.nationwidechildrens.org/>`_. Full source code is available on `GitHub <https://github.com/cancervariants/fusor>`_.


.. toctree::
   :hidden:
   :maxdepth: 2

    Installation<install>
    Usage<usage>
    Data Model<data_model>
    API Reference<reference/index>
    Changelog<changelog>
    Contributing<contributing>
    License<license>