opentrons_larp_protocol_generator

This repository contains code to design and evaluate LARP synthesis protocol to be performed on OT-2 liquid handler robot. The code can be evaluated by the opentrons_simulate API to verify any inconsistencies, additionally a graphical interface is provided to verify the different stages of the LARP synthesis.

https://github.com/rogeriog/opentrons_larp_protocol_generator

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

This repository contains code to design and evaluate LARP synthesis protocol to be performed on OT-2 liquid handler robot. The code can be evaluated by the opentrons_simulate API to verify any inconsistencies, additionally a graphical interface is provided to verify the different stages of the LARP synthesis.

Basic Info
  • Host: GitHub
  • Owner: rogeriog
  • Language: HTML
  • Default Branch: main
  • Size: 2.45 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed 9 months ago
Metadata Files
Readme Citation

README.md

Opentrons LARP protocol generator and graphical prognostic

This repository contains code to design and evaluate LARP (Ligand-assisted reprecipitation) synthesis protocols to be performed using the OT-2 liquid handler robot. The code can be evaluated using the opentrons_simulate API to verify any inconsistencies. Additionally, a graphical interface is provided to visualize the different stages of the LARP synthesis.

Graphical Prognostic of LARP Protocol Example of graphical prognostic of the LARP protocol.

Installation

Clone the repository and install the required packages using the following command: bash pip install -r requirements.txt

Usage

There are two ways to use the code:

  1. Using the LARP Protocol Script:
    • Navigate to the protocol_scripts folder and copy the desired script to a new folder.
    • Edit the entries such as pipette tips, labware, and reagents according to your lab setup in the appropriate variables.
    • Ensure any custom labware files used by the protocol are in the same folder.
    • Run the script using Python: bash python3 larp_script_v001.py
    • If SIMULATE_MODE is set to True, the script will run in simulation mode, generating a graphical interface to visualize the different stages of the LARP synthesis. If SIMULATE_MODE is set to False, the script can be uploaded directly to the OT-2 robot.
    • Verify the run using the following command from the Opentrons API: bash opentrons_simulate larp_script_v001.py
    • Ensure the SIMULATE_MODE variable in the script is set to False and the labware JSON files are in the same folder.

If all goes well, you can upload the script to the OT-2 robot and run the LARP synthesis.

  1. Generating Protocol from Excel File:
    • In the protocol_setup folder, there is an Excel file named protocol_setup.xlsx which provides a user-friendly way to declare all necessary variables for the protocol generator.
    • Modify only the indicated cells in the Excel file to avoid errors during the generation of the final protocol script.
    • Use the xlsx_to_protocol.py script to create the final protocol script.
    • The final script can be used to generate the graphical prognostic of the LARP synthesis or be uploaded to the OT-2 robot, just as in the first method.

Conclusion

This repository provides a comprehensive solution for designing and evaluating LARP synthesis protocols using the OT-2 liquid handler robot. Whether you prefer scripting directly or using an Excel-based setup, the tools provided will help ensure accurate and efficient protocol execution.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Brazilian funding agency CNPq for the financial support throughout this project.
  • Opentrons for devoloping the OT-2 liquid handler robot and API.

Owner

  • Name: Rogerio Gouvêa
  • Login: rogeriog
  • Kind: user

I am a programmer and PhD candidate on materials science, looking forward to implement nice codes for materials research, machine learning and IT in general.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Opentrons LARP protocol generator and graphical prognostic
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Rogério
    family-names: Almeida Gouvêa
  - given-names: Marcos José
    family-names: Leite Santos
repository-code: >-
  https://github.com/rogeriog/opentrons_LARP_graphical_prognostic
abstract: >-
  This repository contains code to design and evaluate LARP
  (Ligand-assisted reprecipitation) synthesis protocol to be
  performed in OT-2 liquid handler robot. The code can be
  evaluated by the opentrons_simulate API to verify any
  inconsistencies, additionally a graphical interface is
  provided to verify the different stages of the LARP
  synthesis.
  Code was developed by the authors with the funding of 
  the Brazilian funding agency CNPq.
keywords:
  - opentrons
  - LARP
  - protocol generator
license: MIT
version: 0.0.1

GitHub Events

Total
  • Push event: 15
Last Year
  • Push event: 15