3. STELAR Client User Guide

The STELAR Client is a Python client that provides a programmatic interface to the STELAR Knowledge Layer Management System (KLMS). The client allows users to interact with the KLMS, including creating and updating entities, executing tasks and workflows, managing tools, and accessing the STELAR API.

In order to fully utilize the STELAR Client, users should be familiar with the concepts and terminology used in the STELAR KLMS. This document provides an overview of the STELAR KLMS and describes how to use the STELAR Client to interact with the KLMS.

• 3.1. An Overview of the STELAR KLMS
  • 3.1.1. The Main Concepts of the STELAR KLMS
    • 3.1.1.1. Concepts of the S3 Data Store
    • 3.1.1.2. STELAR entities
      • Entity fields
      • Entity stereotypes
      • Entities
    • 3.1.1.3. Datasets
    • 3.1.1.4. Resources
    • 3.1.1.5. Organizations and groups
      • MemberEntity: Members of organizations and groups
    • 3.1.1.6. Packages
    • 3.1.1.7. Entities related to execution
      • Tools and Tasks
      • Processes and Workflows
      • External tasks
      • Process termination
  • 3.1.2. Architecture of the STELAR KLMS
    • 3.1.2.1. Acessing the STELAR KLMS
  • 3.1.3. The STELAR KLMS authorization scheme
    • 3.1.3.1. Policy Management System Architecture
    • 3.1.3.2. YAML-based Policy Description Language
      • Actions and Alises
    • 3.1.3.3. Permissions in STELAR KLMS
      • Data Catalog/STELAR Permissions
      • Actions
      • Resource Specification
      • Attribute Resource Specification
      • Group Membership Resource Specification
      • Organization Membership Resource Specification
      • User Membership Resource Specification
      • Data Permissions
      • Actions
    • 3.1.3.4. Policy Reconciliation
• 3.2. Data catalog
  • 3.2.1. Overview of the Data Catalog
    • 3.2.1.1. Basic types of entities
    • 3.2.1.2. Organizations
  • 3.2.2. Entities and proxies
    • 3.2.2.1. Proxy and cursor types
    • 3.2.2.2. The state of a proxy
      • Syncing
      • Invalidation
      • Resetting
      • Type-safety operations
      • Pretty-printing proxies
    • 3.2.2.3. Proxy lists
  • 3.2.3. Creating entities
    • 3.2.3.1. Creating dependent entities: resources and tasks
  • 3.2.4. Updating entities
  • 3.2.5. Deleting entities
    • 3.2.5.1. Soft deletion
    • 3.2.5.2. Purging, a.k.a. hard deletion
  • 3.2.6. Custom fields
  • 3.2.7. Tags
    • 3.2.7.1. Tag Vocabularies
    • 3.2.7.2. Building a tag vocabulary
    • 3.2.7.3. Working with free tags
  • 3.2.8. Searching for entities
    • 3.2.8.1. Searching for resources
    • 3.2.8.2. Searching for datasets and other packages
    • 3.2.8.3. Basic search query
    • 3.2.8.4. Bounding box filter
    • 3.2.8.5. Filters
    • 3.2.8.6. Field list
    • 3.2.8.7. Solr schema
  • 3.2.9. Licenses
• 3.3. Authorization
  • 3.3.1. Managing Policies
    • 3.3.1.1. Creating policies
    • 3.3.1.2. Updating policies
    • 3.3.1.3. Deleting policies
• 3.4. User Management
  • 3.4.1. Managing Users
    • 3.4.1.1. Creating Users
    • 3.4.1.2. Updating Users
    • 3.4.1.3. Deleting Users
  • 3.4.2. Managing User Roles
    • 3.4.2.1. Assigning Roles to Users
    • 3.4.2.2. Removing Roles from Users
    • 3.4.2.3. Updating User Roles

3.5. Working with data in Storage

Contents:

• An overview of the STELAR KLMS

• Working with the Data Catalog - Overview of the Data Catalog - Creating entities - Updating entities - Custom fields - Tags - Searching for entities

• Working with data in minio

• Execution of tasks and workflows

• Managing tools

• Accessing the STELAR API

• User management

• Authorization policies

• Using the Knowledge Graph