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 using a Python client.
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
TxPy is separated into three main components:
- Core. The core modules provide a barebones client for making calls to
the Transcriptic webapp to create and obtain data. This can be done via the
apiobject or via the command-line using the CLI.
- Jupyter. This module provides a Jupyter-centric means for interacting with objects returned from the Transcriptic webapp such as Run, Project and Dataset.
- Analysis. This module provides some basic analysis wrappers around datasets returned from the webapp using standard Python scientific libraries.
For a barebones CLI install, you'll do:
$ pip install transcriptic
We recommend installing the
jupyter module for Jupyter-centric navigation:
$ pip install transcriptic[jupyter]
Lastly, we recommend installing the
analysis module for a full-fledged experience:
$ pip install transcriptic[analysis]
Alternatively, if you're interested in contributing or living at the edge:
$ git clone https://github.com/transcriptic/transcriptic.git $ cd transcriptic $ pip install .[jupyter,analysis]
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: firstname.lastname@example.org Password: Logged in as email@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
See the Transcriptic Developer Documentation for detailed information about how to use this package, including learning about how to package protocols and build releases.
Note that direct analysis and submission of Autoprotocol is currently restricted. Please contact firstname.lastname@example.org if you would like to do so.
CONTRIBUTING.md for more information on contributing to TxPy