biosimulations-query 2.1.0
A python package for querying the biosimulations database
License: MIT

.. figure:: https://raw.githubusercontent.com/reproducible-biomedical-modeling/CRBM-Viz/master/CRBM-Viz/src/assets/logo/logo-white.svg?sanitize=true
   :alt: Logo

   Logo

Biosimulations_Query
====================

A python package to query the Biosimulations database

|PyPI package| |PyPI Status| |Tests| |Docker image| |Documentation|

|codecov| |CodeFactor| |GitHub issues| |License| |FOSSA Status|

Current Release
---------------

https://pypi.org/project/biosimulations-query/

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

Prerequisites
^^^^^^^^^^^^^

Biosimulations_Query requires the following

-  Python >= 3.5
-  Pip

Configuration
^^^^^^^^^^^^^

The package assumes that you have an account with read and write access
on the Biosimulations database. It searches your home directory for the
“crbm.env” file containing your credentials.

At this time, the package cannot be used without database credentials.
In the future, the package should support authentication through the
your Biosimulations login.

Latest revision from GitHub
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Run the following command to install the latest version from GitHub:

::

   pip install git+https://github.com/reproducible-biomedical-modeling/biosimulations_query

Latest release From PyPI
^^^^^^^^^^^^^^^^^^^^^^^^

Run the following command to install the latest release from PyPI:

::

   pip install biosimulations_query[all]

Documentation
-------------

The latest documentation is avalable
`here <https://reproducible-biomedical-modeling.github.io/Biosimulations_Query/html/index.html>`__

License
-------

This package is released under the `MIT license <LICENSE>`__.

Dependencies
------------

This package uses dependencies distributed under various licences.
Please see the `dependencies
report <https://app.fossa.com/attribution/4c8d42d4-8132-4439-9e82-5552790f8b73>`__
for more information

Development team
----------------

This package was developed by the `Karr Lab <https://www.karrlab.org>`__
at the Icahn School of Medicine at Mount Sinai in New York as part of
the `Center for Reproducible Biomodeling
Modeling <https://reproduciblebiomodels.org>`__.

-  `Bilal Shaikh <https://www.bshaikh.com>`__

Funding
-------

This package was developed with support from the National Institute for
Bioimaging and Bioengineering (award P41EB023912).

Questions and comments
----------------------

Please contact `us <mailto:info@biosimulations.org>`__ or submit an
issue with any questions or comments.

.. |PyPI package| image:: https://img.shields.io/pypi/v/biosimulations_query.svg
   :target: https://pypi.python.org/pypi/biosimulations_query
.. |PyPI Status| image:: https://img.shields.io/pypi/status/biosimulations_query.svg
   :target: https://pypi.python.org/pypi/biosimulations_query
.. |Tests| image:: https://github.com/reproducible-biomedical-modeling/Biosimulations_Query/workflows/Unit%20Test/badge.svg
   :target: https://github.com/reproducible-biomedical-modeling/Biosimulations_Query/actions
.. |Docker image| image:: https://github.com/reproducible-biomedical-modeling/Biosimulations_Query/workflows/Format/badge.svg
   :target: https://github.com/reproducible-biomedical-modeling/Biosimulations_Query/actions
.. |Documentation| image:: https://github.com/reproducible-biomedical-modeling/Biosimulations_Query/workflows/Document/badge.svg
   :target: https://reproducible-biomedical-modeling.github.io/Biosimulations_Query/html/index.html
.. |codecov| image:: https://codecov.io/gh/reproducible-biomedical-modeling/Biosimulations_Query/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/reproducible-biomedical-modeling/Biosimulations_Query
.. |CodeFactor| image:: https://www.codefactor.io/repository/github/reproducible-biomedical-modeling/Biosimulations_Query/badge
   :target: https://www.codefactor.io/repository/github/reproducible-biomedical-modeling/Biosimulations_Query
.. |GitHub issues| image:: https://img.shields.io/github/issues/reproducible-biomedical-modeling/Biosimulations_Query?logo=GitHub
   :target: https://github.com/reproducible-biomedical-modeling/Biosimulations_Query/issues
.. |License| image:: https://img.shields.io/github/license/reproducible-biomedical-modeling/Biosimulations_Query.svg
   :target: LICENSE
.. |FOSSA Status| image:: https://app.fossa.com/api/projects/custom%2B12818%2Fgit%40github.com%3Areproducible-biomedical-modeling%2FBiosimulations-Query.git.svg?type=shield
   :target: https://app.fossa.com/projects/custom%2B12818%2Fgit%40github.com%3Areproducible-biomedical-modeling%2FBiosimulations-Query.git?ref=badge_shield