Overview

ScopeFoundry is a framework with two types of plugins:

  1. HardwareComponents - interfaces with hardware devices.
  2. Measurements - contains the logic to set the state of devices and read and store data.

The framework provides an app, defines interfaces between plug-ins, and handles threading to run plugins concurrently.

Users of ScopeFoundry are required to develop these plugins (unless they already exist) and add them to the app.

Plugin development

This website provides tutorials for creating (and sharing) ScopeFoundry App, HardwareComponents, and Measurements. Depending on your familiarity with ScopeFoundry, we recommend:

  1. Getting Started: Install ScopeFoundry

  2. Basic Tutorial: Your first app, basics on HardwareComponent and Measurement Plugin, and first Measurement.

  3. Tips and Tricks: Elevate your plugin development.

  4. Built-in Measurements: Scanning, parameter sweeping, PID feedback control, Sequencer … are amongst common measurement tasks that ScopeFoundry solves generically.

  5. Check HardwareComponents Library for existing plugins.

  6. To share and contribute to plugins here.

ScopeFoundry.DataBrowser

Somewhat independent of the above is the ScopeFoundry.DataBrowser - an app that can be used for quick data inspection. Learn to write Plugins using this tutorial.

ScopeFoundry core development

To contribute to the framework, go to core development.

Create an issue

Documentation is a work in progress. Create an issue here if information is missing.


Getting Started

Installing ScopeFoundry and its dependencies.

Basic Tutorial

Learn how to write your own custom ScopeFoundry hardware and measurement plugins.

Built-in Measurements

Measurements that come with ScopeFoundry

Tips and Tricks

Accelerate your development and use advanced features

Recommended Development Environment

Recommended IDE and version history control with Git

DataBrowser Tutorial

Low-level reference docs for your project.

Sharing Hardware Components

Publish your shiny new plugin as a ScopeFoundryHW plug-in on GitHub.

Key Concepts

Slides demonstrating ScopeFoundry Concepts

Demopico Workshop

Core Development

Contribute to the ScopeFoundry framework and become a core developer.

HardwareComponents Library

Hardware Components shared by the community