Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.96 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.96 KB

Transcriptic Python Library

The Transcriptic Python Library (TxPy) provides a Python interface for managing Transcriptic organizations, projects, runs, datasets and more. One can either interface with our library through the bundled command line interface (CLI) or through a Jupyter notebook.

We recommend using the Jupyter interface as it provides a nice rendering and presentation of the objects, as well as provide additional analysis and properties functions specific to the Transcriptic objects.

Transcriptic is the robotic cloud laboratory for the life sciences. https://www.transcriptic.com

Setup

$ pip install transcriptic

or

$ git clone https://github.com/transcriptic/transcriptic.git
$ cd transcriptic
$ pip install .

to upgrade to the latest version using pip or check whether you're already up to date:

$ pip install transcriptic --upgrade

Then, login to your Transcriptic account:

$ transcriptic login
Email: me@example.com
Password:
Logged in as me@example.com (example-lab)

To enable auto tab-completion for the Transcriptic CLI, enter source transcriptic_complete.sh into your terminal. To enable this for every single session automatically, add . path/to/transcriptic_complete.sh to your .bashrc/.zshrc file.

Documentation

See the Transcriptic Developer Documentation for detailed information about how to use this package, including learning about how to package protocols and build releases.

View Developer Specific Documentation

Permissions

Note that direct analysis and submission of Autoprotocol is currently restricted. Please contact sales@transcriptic.com if you would like to do so.

Contributing

Read CONTRIBUTING.md for more information on contributing to TxPy