Skip to main content

Ganymede SDK

The Ganymede SDK provides a methods for interacting with Ganymede from editor and analysis notebooks.

from ganymede_sdk import Ganymede
  • The Ganymede Class contains methods for listing and retrieving data stored in Ganymede
  • The Benchling Class contains convenience methods for accessing Benchling data
  • Allotrope Schemas contains DataFrame schemas for validating DataFrames against Allotrope schemas
  • GPT is a class found in Ganymede SDK that provides coding assistance for use in Editor notebooks. Usage requires configuring OpenAI API Key and Organization in your environment.
  • Analytical methods and more granular API documentation can be found under the SDK header on the left.
tip

Functions can be introspected by typing ? or ?? before the function name in a notebook cell. For example:

from ganymede_sdk import Ganymede

g = Ganymede()

# shows function signature and docstring 
?g.retrieve_sql
Explore documentation
# shows function signature and source code
??g.retrieve_sql
Function Signature and Source Code