SPy Logo
189.18

Contents:

  • Introduction
  • Installation
  • User Guide
    • Tutorial
      • Getting Started
      • Importing the SPy Module
      • Logging in to Seeq
      • Searching for Signals
      • Refining the Results
      • Plotting the Results
      • Using Seeq’s Calculation Engine
      • Pushing a New Condition to Seeq
      • Pulling the Capsules
      • Plotting Conditions Alongside Signals
      • Calculating a New Signal using Python
      • Pushing Data Into Seeq
    • spy.login
      • Specifying Seeq Server URL and credentials
      • Authentication Directories
      • Access Keys
      • SSL Errors
      • Proxy Servers
      • Detailed Help
      • API Reference Links
    • spy.search
      • Query Syntax
      • Retrieving all properties
      • Estimating signal sample period
      • Workbook scoping
      • DataFrame as input
      • Workbench Analysis URL as input
      • Pickling
      • Detailed Help
      • API Reference Links
    • spy.push
      • Workbook scoping
      • Pushing signal data
      • Pushing metadata
      • Pushing condition and capsule data
      • Updating capsules
      • Deleting capsules
      • Detailed Help
      • API Reference Links
    • spy.pull
      • Time interval
      • Gridding
      • Column headers
      • Applying a Seeq Formula
      • Applying a Seeq Formula Across Assets
      • Conditions
        • Conditions as signals
        • Mixing conditions with signals
      • Scalars
      • Pickling
      • Performance Metrics
      • Detailed Help
      • API Reference Links
    • spy.swap
      • Example
      • Multi-asset Swaps
      • Multi-level Swaps
      • Detailed Help
    • Asset Trees 1 - Introduction
      • Defining an Asset Tree
        • 1. Creating an Empty Tree
        • 2. Creating a Tree using CSV Files
        • 3. Working with an Existing Asset Tree
      • Inserting Items into the Tree
        • 1. Inserting Assets
        • 2. Inserting Signals, Conditions, and Scalars from Seeq Server
        • 3. Inserting Calculations
      • Removing and Moving Items
      • Pushing a Tree
      • Detailed Help
      • Advanced Features
        • Inserting with Custom DataFrames
        • Inserting Metrics
        • Inserting Roll-up Calculations
        • Inserting with References
        • Pushing Large Trees
        • The spy.assets Submodule and Asset Tree Templates
      • API Reference Links
    • Asset Trees 2 - Templates
      • Simple Trees vs Templates
      • Concepts
      • How Python fits in
      • Getting Started
      • Preparing the Ingredients
      • Writing the Recipe
      • Calculated Signals, Conditions and Scalars
      • Components
      • Metrics
      • Troubleshooting / Debugging
        • Using an Integrated Development Environment (IDE)
      • Detailed Help
      • API Reference Links
    • Asset Trees 3 - Report and Dashboard Templates
      • Leveraging Purpose-Built Asset Trees
      • Defining Displays
      • Defining Organizer Topics
    • Asset Trees 4 - Accelerator Templates
      • “Requirements”
      • Analytics!
      • Input Tree
      • Build and Push
      • Brochures
      • API Reference Links
    • spy.acl
      • Modifying ACLs for Pushed Data
      • Modifying ACLs for Pushed Workbooks
      • Retrieving ACLs
      • Detailed Help
      • API Reference Links
    • spy.workbooks
      • The Export Format
      • Main Actions
        • Importing
        • Exporting
      • Inspecting Worksheets
      • Re-importing and Labels
      • Importing to a Different Seeq Server
      • Detailed Help
      • API Reference Links
    • Workbook Templates
      • Creating a Template
      • Loading a Template
      • Pushing with a Template Worksheet
      • Pushing with a Template Workbook
        • Using Pre-existing Signals/Conditions/Scalars etc
      • Pushing a Template Organizer Topic
        • A Single Topic Document with Multiple Assets
        • A Topic with a Document for each Asset
        • A Topic Document with an Image
    • Data Lab Visualizations
      • Creating a Template
      • Use the Template
      • Create a Visualization
      • Push to Organizer
      • Schedule it
    • spy.jobs
      • Warning!
        • Example
      • Detailed Help
      • API Reference Links
    • Advanced Scheduling
      • Parameterized Jobs
        • Assemble a DataFrame with the Parameters
        • Sort your Schedule DataFrame
        • Push the jobs to Seeq
        • Do something cool
        • Scheduling from a separate notebook
      • Email Notifier
        • Capsule Handlers
        • Email Builder
      • Email Notification Add-on Installer
        • Installation Folder
        • How to handle existing files
        • How to handle existing versions of Scheduler in Add-on Tools
        • Tool Configuration
          • ⚠️ Advanced Configuration and Automated Installation Beyond This Point
        • Check whether the required source files and target folder exist
        • Configuration update and tool installation
    • spy.widgets
      • SeeqItemSelect
      • Logging Widget and WidgetLogHandler
        • Setting up the widget and handler
      • API Reference Links
    • Timezones in SPy
      • Setting default timezone
      • Timezones in spy.pull()
      • Timezones in spy.push()
      • Timezones in spy.schedule()
      • Timezones in shared documents
    • Version Considerations
      • Packaging
        • Seeq R59 and Earlier
        • Seeq R60 and Later
      • Upgrading
      • Displaying Version Information
      • Checking for a Sufficient Version
      • Function Reference
  • API Reference
    • SPy Core
      • Constants
      • Classes
      • Global Attributes
      • Exception Types
      • The Core SPy Functions
    • SPy Submodules
      • SPy ACL
      • SPy Add-ons
      • SPy Assets
        • Simple Asset Trees
        • Asset Tree Templates: Classes
        • Asset Tree Templates: Functions
      • SPy Docs
      • SPy Jobs
      • SPy Notifications
      • SPy Utilities
      • SPy Widgets
      • SPY Workbooks
        • Constants
        • Classes
        • Functions
  • Change Log
  • License
SPy
  • »
  • API Reference »
  • SPy Submodules
  • View page source

SPy Submodules

Contents:

  • SPy ACL
  • SPy Add-ons
  • SPy Assets
    • Simple Asset Trees
    • Asset Tree Templates: Classes
    • Asset Tree Templates: Functions
  • SPy Docs
  • SPy Jobs
  • SPy Notifications
  • SPy Utilities
  • SPy Widgets
  • SPY Workbooks
    • Constants
    • Classes
    • Functions
Previous Next

© Copyright 2023, Seeq Corporation.

Built with Sphinx using a theme provided by Read the Docs.