Skip to main content

Integration guideSeal API and Scripts

Google Colab

Link analysis outputs, notebook versions and execution parameters to records.

Illustration of a seal beside a laptop showing a data table and an evidence binder linked by a red thread.

Google Colab to SealSeal API and Scripts

Seal reads
Exported .ipynb notebooks and their outputs
Writes back
If agreed
Source of truth
Agreed when scoped
Set up
Scoped with your team
Neil › Analysis record
draft

Keep this analysis together with its input records.

Neil

  • Once the connection is configured, I’ll use the records it provides and cite each one. Anything it doesn’t supply stays listed as missing.
Reads
Exported .ipynb notebooks and their outputs
Returns
  • Inputs, analysis outputs and reproducibility context
  • Missing or unmatched information
  • Next steps for your team to review
Illustrative work with Google Colab: a request to Neil, the source it reads and the draft it returns for your review.

1What’s connected.

Link Colab notebooks and their outputs to Seal records through exported .ipynb files or Seal’s API. Keep the notebook version, input records and parameters with each result so the analysis can be reproduced.

Connection setup and permissions

Use Seal’s APIs or scripting engine for a connection tailored to your process. Agree the data mapping, access and direction of transfer before implementation.

Related blueprints

2Export a Colab notebook with what it needs to run again.

Route

Colab is a hosted Jupyter Notebook service. Its notebooks are stored in Google Drive or loaded from GitHub, and download as .ipynb files from Drive or Colab’s File menu.⁠¹

What the file leaves out

A notebook setting can leave code cell output out of what is saved or shared.⁠¹ The runtime’s files and libraries are not saved with the notebook, and Colab advises cells that install and load what the notebook needs.⁠¹

When it fails

The exported notebook has no outputs
The setting to omit code cell output applies when the notebook is saved.⁠¹ Check the setting, run the notebook and export it again before attaching it.
A rerun cannot find its files
Code runs in a virtual machine that is deleted when idle and has a maximum lifetime.⁠¹ Read inputs from the Seal records or a store the notebook names, not from files left on the runtime.

Check one record

Open one notebook attached to a Seal record in a fresh Colab runtime and run every cell. It should install what it needs, read the same input records and reproduce the attached outputs.

3Start with the job.

Tell us what Neil needs to do and which records it needs. We’ll confirm the interface, permissions and implementation scope with your team.

Discuss this connection →

4Before it goes live.

Access and any write-back

Define which records are in scope and whose permissions apply. Whether the connection writes back at all is a separate decision, with its own mapping and approval.

Verification and release

Review the configured connection for its intended use. Keep the requirements, checks and evidence with the change, and approve the release through your team’s controls.

Read the assurance detail →

References

  1. 1Google Colab: frequently asked questions.