Introduction

To see an example of deploying an app to BioLib, see this repository.

When creating an application you are asked to give it a unique name. The name of an application can be changed later by clicking the Settings button in the top left-hand corner of the application page.

By default, the visibility of a new application is set to "draft", meaning that only you can find, view, and run the application. The visibility of the application can be changed under Settings.

Getting started

To create a new application click here.

Go to your local directory that contains the code that you want to publish as an application and follow the instructions you see on your application page. The steps are also listed below:

To push a new version of the application ensure you have the latest version of the BioLib Python CLI.

pip3 install -U pybiolib

Configure your application's inputs using the .biolib/config.yml file. If you do not have this configuration file already, run the following command to generate one automatically.

biolib init

If you get biolib: command not found, ensure that biolib is in your $PATH. For example if your Python installation saves packages to $HOME/.local/lib/python3.12/site-packages/ try adding it to the $PATH with below:

export PATH="$PATH:$HOME/.local/lib/python3.12/site-packages/"

Edit the README.md file to update the description of your application shown on this page. Then, to push a new version of your application run the below command in the directory of your code project.

biolib push myGroup/appName

To push with specific tags or versions, see Advanced: Using Tags and Versions.

Source Files

• README: The README file is where you provide the description and documentation for the user. The file is rendered as Markdown, so you can add headings, code snippets, and images.

• .biolib/config.yml file: see config file documentation. In the config.yml file you can add the arguments that will be passed to the GUI.