Skip to content

2. Using Excel2SBOL in a Project

JMante1 edited this page Jun 11, 2021 · 1 revision

How to Use Excel2SBOL in a project

1) Choose an Excel Template

Choose an excel template from the templates folder. We suggest choosing the latest version (dates are given at the end of the file names in the form yyyymmdd). Fill out the template as the instructions indicate.

2) Install the Converter There are several ways to install the converter. The easiest is via pip: pip install excel2sbol but it can also be done by cloning the repository.

3) Run the Converter

Use the code below substituting {things in brackets} with the appropriate values.

import excel2sbol.converter_function as conf

conf.converter({template_name}, {file_path_in}, {file_path_out})

An example use is:

import excel2sbol.converter_function as conf

conf.converter("darpa_template_blank_v005_20220222.xlsx",
               "C:/Users/Test_User/Downloads/Filled_Template.xlsx",
               "C:/Users/Test_User/Downloads/Output_SBOL.xml")

The use of os.getcwd() and os.path.join is reccommended for the creation of the file paths.

4) Use the output file The SBOL file that is output can then be used by further SBOL tools or uploaded to an SBOL repository like SynBioHub.

Example use

An example spreadsheet that contains data was taken and converted to an SBOL file which was subsequently uploaded to SynBioHub.

Example Spreadsheet Example Spreadsheet

Example SBOL Example SBOL

Example SynBioHub Upload Example SynBioHub