SPy Logo
193.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
      • Pushing calculated items
      • 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
      • Manipulating Worksheets
      • Worksheet Display Configurations
      • Re-importing and Labels
      • Mapping Items
        • Tweaking the Datasource Map
      • Importing to a Different Seeq Server
      • Detailed Help
      • API Reference Links
    • Workbook Jobs
      • Establish the Job Folder
      • Let’s Make Something to Work With…
      • Pulling Workbooks
      • Pushing Workbooks
        • Datasource Maps
          • Datasource Mapping in Action
        • Dummy Items
      • Including Data
      • Redoing Specific Workbooks/Items
      • Zip/Unzip the Job Folder
      • Detailed Help
    • Workbook Templates
      • Creating a Template
        • Installing Template Requirements
      • Loading a Template
      • Pushing with a Template Worksheet
      • Pushing with a Template Workbook
        • Using Pre-existing Signals/Conditions/Scalars etc
      • Modifying the Display Items
      • Pushing a Template Organizer Topic
        • A Single Topic Document with Multiple Assets
        • A Topic with a Document for each Asset
          • Alternative Method: Using Asset Selections
        • A Topic Document with an Image
    • Data Lab Visualizations
      • Creating a Template
      • Use the Template
      • Create an Image Visualization
      • Create an HTML 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
        • Install Requirements
        • 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
        • seeq.spy.DEFAULT_WORKBOOK_PATH
        • seeq.spy.GLOBALS_AND_ALL_WORKBOOKS
        • seeq.spy.GLOBALS_ONLY
      • Classes
        • Session
          • Session.clear()
          • Session.client
          • Session.get_user_folder()
          • Session.options
          • Session.request_origin_label
          • Session.request_origin_url
          • Session.server_version
          • Session.user
        • Status
          • Status.Interrupt
          • Status.df
          • Status.display()
      • Global Attributes
        • client
        • options
        • server_version
        • session
        • user
      • Exception Types
        • SPyDependencyNotFound
        • SPyException
        • SPyKeyboardInterrupt
        • SPyRuntimeError
        • SPyTypeError
        • SPyValueError
        • SchedulePostingError
        • seeq.spy.errors.ApiException
      • The Core SPy Functions
        • login()
        • logout()
        • plot()
        • pull()
        • push()
        • search()
        • swap()
    • SPy Submodules
      • SPy ACL
        • pull()
        • push()
      • SPy Add-ons
        • install()
        • search()
        • uninstall()
      • SPy Assets
        • Simple Asset Trees
          • Tree
            • Tree.count()
            • Tree.height
            • Tree.insert()
            • Tree.items()
            • Tree.missing_items()
            • Tree.move()
            • Tree.name
            • Tree.push()
            • Tree.remove()
            • Tree.select()
            • Tree.size
            • Tree.summarize()
            • Tree.visualize()
            • Tree.workbook
        • Asset Tree Templates: Classes
          • Asset
            • Asset.Attribute()
            • Asset.Component()
            • Asset.all_assets()
            • Asset.build_component()
            • Asset.build_components()
            • Asset.fqn
            • Asset.is_ancestor_of()
            • Asset.is_child_of()
            • Asset.is_descendant_of()
            • Asset.is_parent_of()
            • Asset.parent
          • ItemGroup
            • ItemGroup.pick()
            • ItemGroup.roll_up()
          • Mixin
        • Asset Tree Templates: Functions
          • build()
          • brochure()
          • prepare()
      • SPy Docs
        • copy()
      • SPy Jobs
        • pull()
        • push()
        • schedule()
        • unschedule()
      • SPy Notifications
        • EmailRecipient
        • send_email()
      • SPy Utilities
        • get_data_lab_project_id()
        • get_data_lab_project_id_from_url()
        • get_data_lab_project_url()
        • get_open_port()
        • get_sdk_module_version_tuple()
        • get_server_version_tuple()
        • get_spy_module_version_tuple()
        • get_user_timezone()
        • get_workbook_id_from_url()
        • get_worksheet_id_from_url()
        • get_workstep_id_from_url()
        • is_guid()
        • is_sdk_module_version_at_least()
        • is_server_version_at_least()
        • is_spy_module_version_at_least()
        • is_valid_unit()
        • parse_str_time()
        • pull_worksheet_via_url()
        • time_abbreviation_to_ms_multiplier()
      • SPy Widgets
        • LogWindowWidget
        • SeeqItemSelect
          • SeeqItemSelect.get_widget_state()
          • SeeqItemSelect.search_results
          • SeeqItemSelect.search_terms
          • SeeqItemSelect.selected_value
        • WidgetLogHandler
          • WidgetLogHandler.emit()
          • WidgetLogHandler.set_widget()
      • SPy Workbooks
        • Constants
          • seeq.spy.workbooks.ALL
          • seeq.spy.workbooks.CORPORATE
          • seeq.spy.workbooks.FORCE_ME_AS_OWNER
          • seeq.spy.workbooks.MY_FOLDER
          • seeq.spy.workbooks.ORIGINAL_OWNER
          • seeq.spy.workbooks.PUBLIC
          • seeq.spy.workbooks.SHARED
          • seeq.spy.workbooks.USERS
        • Classes
          • Analysis
          • AnalysisWorksheet
            • AnalysisWorksheet.add_display_columns()
            • AnalysisWorksheet.display_items
            • AnalysisWorksheet.display_range
            • AnalysisWorksheet.html
            • AnalysisWorksheet.investigate_range
            • AnalysisWorksheet.journal
            • AnalysisWorksheet.pull_current_workstep()
            • AnalysisWorksheet.push_current_workstep()
            • AnalysisWorksheet.scatter_plot_series
            • AnalysisWorksheet.table_date_display
            • AnalysisWorksheet.table_date_format
            • AnalysisWorksheet.table_mode
            • AnalysisWorksheet.trend_toolbar
            • AnalysisWorksheet.view
          • Annotation
            • Annotation.add_image()
          • AssetSelection
          • Content
          • DateRange
          • Item
            • Item.fqn
          • Journal
          • Report
          • Topic
          • TopicDocument
            • TopicDocument.html
            • TopicDocument.report
            • TopicDocument.schedule
          • Workbook
            • Workbook.ItemInventoryProgress
          • Worksheet
            • Worksheet.fqn
            • Worksheet.timezone
            • Worksheet.url
        • Functions
          • load()
          • pull()
          • push()
          • save()
          • search()
  • Change Log
  • License
SPy
  • Search

© Copyright 2024, Seeq Corporation.

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

Download this documentation as Markdown.