BioBB REST API documentation tutorial¶

This tutorial explains how to execute the different endpoints of the BioBB REST API. Besides, it provides the users with several functions created to make easier the connection to the REST API through a Jupyter Notebook document.

Settings¶

Auxiliar libraries used¶

requests: Requests allows you to send organic, grass-fed HTTP/1.1 requests, without the need for manual labor.
nb_conda_kernels: Enables a Jupyter Notebook or JupyterLab application in one conda environment to access kernels for Python, R, and other languages found in other environments.
nglview: Jupyter/IPython widget to interactively view molecular structures and trajectories in notebooks.
ipywidgets: Interactive HTML widgets for Jupyter notebooks and the IPython kernel.
plotly: Python interactive graphing library integrated in Jupyter notebooks.

Conda Installation and Launch¶

git clone https://github.com/bioexcel/biobb_REST_API_documentation.git
cd biobb_REST_API_documentation
conda env create -f conda_env/environment.yml
conda activate biobb_REST_API_documentation
jupyter-nbextension enable --py --user widgetsnbextension
jupyter-nbextension enable --py --user nglview
jupyter-notebook biobb_REST_API_documentation/notebooks/biobb_REST_API_documentation.ipynb

Tutorial¶

Click here to view tutorial in Read the Docs

Click here to execute tutorial in Binder

Version¶

May 2020 Release

Copyright & Licensing¶

This software has been developed in the MMB group at the BSC & IRB for the European BioExcel, funded by the European Commission (EU H2020 823830, EU H2020 675728).

(c) 2015-2020 Barcelona Supercomputing Center
(c) 2015-2020 Institute for Research in Biomedicine

Licensed under the Apache License 2.0, see the file LICENSE for details.

Bioexcel