SPy
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
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
add_display_columns() (seeq.spy.workbooks.AnalysisWorksheet static method)
add_image() (seeq.spy.workbooks.Annotation method)
all_assets() (seeq.spy.assets.Asset method)
Analysis (class in seeq.spy.workbooks)
AnalysisWorksheet (class in seeq.spy.workbooks)
Annotation (class in seeq.spy.workbooks)
Asset (class in seeq.spy.assets)
AssetSelection (class in seeq.spy.workbooks)
Attribute() (seeq.spy.assets.Asset class method)
B
brochure() (in module seeq.spy.assets)
build() (in module seeq.spy.assets)
build_component() (seeq.spy.assets.Asset method)
build_components() (seeq.spy.assets.Asset method)
C
clear() (seeq.spy.Session method)
client (in module seeq.spy)
(seeq.spy.Session property)
Component() (seeq.spy.assets.Asset class method)
Content (class in seeq.spy.workbooks)
copy() (in module seeq.spy.docs)
count() (seeq.spy.assets.Tree method)
D
DateRange (class in seeq.spy.workbooks)
df (seeq.spy.Status property)
display() (seeq.spy.Status method)
display_items (seeq.spy.workbooks.AnalysisWorksheet property)
display_range (seeq.spy.workbooks.AnalysisWorksheet property)
E
EmailRecipient (class in seeq.spy.notifications)
emit() (seeq.spy.widgets.WidgetLogHandler method)
F
fqn (seeq.spy.assets.Asset property)
(seeq.spy.workbooks.Item property)
(seeq.spy.workbooks.Worksheet property)
G
get_analysis_worksheet_from_url() (in module seeq.spy.utils)
get_data_lab_project_id() (in module seeq.spy.utils)
get_data_lab_project_id_from_url() (in module seeq.spy.utils)
get_data_lab_project_url() (in module seeq.spy.utils)
get_sdk_module_version_tuple() (in module seeq.spy.utils)
get_server_version_tuple() (in module seeq.spy.utils)
get_spy_module_version_tuple() (in module seeq.spy.utils)
get_user_timezone() (in module seeq.spy.utils)
get_widget_state() (seeq.spy.widgets.SeeqItemSelect method)
get_workbook_id_from_url() (in module seeq.spy.utils)
get_worksheet_id_from_url() (in module seeq.spy.utils)
get_workstep_id_from_url() (in module seeq.spy.utils)
H
height (seeq.spy.assets.Tree property)
html (seeq.spy.workbooks.AnalysisWorksheet property)
(seeq.spy.workbooks.TopicDocument property)
I
insert() (seeq.spy.assets.Tree method)
install() (in module seeq.spy.addons)
investigate_range (seeq.spy.workbooks.AnalysisWorksheet property)
is_ancestor_of() (seeq.spy.assets.Asset method)
is_child_of() (seeq.spy.assets.Asset method)
is_descendant_of() (seeq.spy.assets.Asset method)
is_guid() (in module seeq.spy.utils)
is_parent_of() (seeq.spy.assets.Asset method)
is_sdk_module_version_at_least() (in module seeq.spy.utils)
is_server_version_at_least() (in module seeq.spy.utils)
is_spy_module_version_at_least() (in module seeq.spy.utils)
is_valid_unit() (in module seeq.spy.utils)
Item (class in seeq.spy.workbooks)
ItemGroup (class in seeq.spy.assets)
J
Journal (class in seeq.spy.workbooks)
journal (seeq.spy.workbooks.AnalysisWorksheet property)
L
load() (in module seeq.spy.workbooks)
login() (in module seeq.spy)
logout() (in module seeq.spy)
LogWindowWidget (class in seeq.spy.widgets)
M
missing_items() (seeq.spy.assets.Tree method)
Mixin (class in seeq.spy.assets)
module
seeq.spy.acl
seeq.spy.addons
seeq.spy.docs
seeq.spy.errors
seeq.spy.jobs
seeq.spy.utils
seeq.spy.widgets
move() (seeq.spy.assets.Tree method)
O
options (in module seeq.spy)
(seeq.spy.Session property)
P
parent (seeq.spy.assets.Asset property)
parse_str_time() (in module seeq.spy.utils)
pick() (seeq.spy.assets.ItemGroup method)
plot() (in module seeq.spy)
prepare() (in module seeq.spy.assets)
pull() (in module seeq.spy)
(in module seeq.spy.acl)
(in module seeq.spy.jobs)
(in module seeq.spy.workbooks)
pull_current_workstep() (seeq.spy.workbooks.AnalysisWorksheet method)
push() (in module seeq.spy)
(in module seeq.spy.acl)
(in module seeq.spy.jobs)
(in module seeq.spy.workbooks)
(seeq.spy.assets.Tree method)
push_current_workstep() (seeq.spy.workbooks.AnalysisWorksheet method)
R
remove() (seeq.spy.assets.Tree method)
Report (class in seeq.spy.workbooks)
report (seeq.spy.workbooks.TopicDocument property)
request_origin_label (seeq.spy.Session property)
request_origin_url (seeq.spy.Session property)
roll_up() (seeq.spy.assets.ItemGroup method)
S
save() (in module seeq.spy.workbooks)
scatter_plot_series (seeq.spy.workbooks.AnalysisWorksheet property)
schedule (seeq.spy.workbooks.TopicDocument property)
schedule() (in module seeq.spy.jobs)
SchedulePostingError
search() (in module seeq.spy)
(in module seeq.spy.addons)
(in module seeq.spy.workbooks)
search_results (seeq.spy.widgets.SeeqItemSelect property)
search_terms (seeq.spy.widgets.SeeqItemSelect property)
seeq.spy.acl
module
seeq.spy.addons
module
seeq.spy.DEFAULT_WORKBOOK_PATH (in module seeq.spy)
seeq.spy.docs
module
seeq.spy.errors
module
seeq.spy.errors.ApiException
seeq.spy.GLOBALS_AND_ALL_WORKBOOKS (in module seeq.spy)
seeq.spy.GLOBALS_ONLY (in module seeq.spy)
seeq.spy.jobs
module
seeq.spy.utils
module
seeq.spy.widgets
module
seeq.spy.workbooks.ALL (in module seeq.spy.workbooks)
seeq.spy.workbooks.CORPORATE (in module seeq.spy.workbooks)
seeq.spy.workbooks.FORCE_ME_AS_OWNER (in module seeq.spy.workbooks)
seeq.spy.workbooks.MY_FOLDER (in module seeq.spy.workbooks)
seeq.spy.workbooks.ORIGINAL_OWNER (in module seeq.spy.workbooks)
seeq.spy.workbooks.PUBLIC (in module seeq.spy.workbooks)
seeq.spy.workbooks.SHARED (in module seeq.spy.workbooks)
seeq.spy.workbooks.USERS (in module seeq.spy.workbooks)
SeeqItemSelect (class in seeq.spy.widgets)
select() (seeq.spy.assets.Tree method)
selected_value (seeq.spy.widgets.SeeqItemSelect property)
send_email() (in module seeq.spy.notifications)
server_version (in module seeq.spy)
(seeq.spy.Session property)
Session (class in seeq.spy)
session (in module seeq.spy)
set_widget() (seeq.spy.widgets.WidgetLogHandler method)
size (seeq.spy.assets.Tree property)
SPyDependencyNotFound
SPyException
SPyKeyboardInterrupt
SPyRuntimeError
SPyTypeError
SPyValueError
Status (class in seeq.spy)
summarize() (seeq.spy.assets.Tree method)
T
table_date_display (seeq.spy.workbooks.AnalysisWorksheet property)
table_date_format (seeq.spy.workbooks.AnalysisWorksheet property)
table_mode (seeq.spy.workbooks.AnalysisWorksheet property)
time_abbreviation_to_ms_multiplier() (in module seeq.spy.utils)
timezone (seeq.spy.workbooks.Worksheet property)
Topic (class in seeq.spy.workbooks)
TopicDocument (class in seeq.spy.workbooks)
Tree (class in seeq.spy.assets)
U
uninstall() (in module seeq.spy.addons)
unschedule() (in module seeq.spy.jobs)
url (seeq.spy.workbooks.Worksheet property)
user (in module seeq.spy)
(seeq.spy.Session property)
V
view (seeq.spy.workbooks.AnalysisWorksheet property)
visualize() (seeq.spy.assets.Tree method)
W
WidgetLogHandler (class in seeq.spy.widgets)
Workbook (class in seeq.spy.workbooks)
workbook (seeq.spy.assets.Tree property)
Worksheet (class in seeq.spy.workbooks)