stelar_client

This is the documentation of stelar_client.

Contents

• 1. Overview
  • 1.1. Note
• 2. QuickStart
  • 2.1. Installation
  • 2.2. Configuration
  • 2.3. Creating a client
    • 2.3.1. Accessing the KLMS
    • 2.3.2. Working with data
• 3. User Guide
  • 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
      • 3.1.1.3. Datasets
      • 3.1.1.4. Resources
      • 3.1.1.5. Organizations and groups
      • 3.1.1.6. Packages
      • 3.1.1.7. Entities related to execution
    • 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
      • 3.1.3.3. Permissions in STELAR KLMS
      • 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
      • 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
• 4. Contributions & Help
  • 4.1. Issue Reports
  • 4.2. Documentation Improvements
  • 4.3. Code Contributions
    • 4.3.1. Submit an issue
    • 4.3.2. Create an environment
    • 4.3.3. Clone the repository
    • 4.3.4. Implement your changes
    • 4.3.5. Submit your contribution
    • 4.3.6. Troubleshooting
  • 4.4. Maintainer tasks
    • 4.4.1. Releases
• 5. License
• 6. Authors
• 7. Changelog
  • 7.1. Version 0.8.1
  • 7.2. Version 0.8.0
  • 7.3. Version 0.7.0
  • 7.4. Version 0.6.0
  • 7.5. Version 0.5.3
  • 7.6. Version 0.5.2
  • 7.7. Version 0.5.1
  • 7.8. Version 0.5.0
  • 7.9. Version 0.4.2
  • 7.10. Version 0.4.1
  • 7.11. Version 0.4.0
  • 7.12. Version 0.3.7
  • 7.13. Version 0.3.6
  • 7.14. Version 0.3.5
  • 7.15. Version 0.3.4
  • 7.16. Version 0.3.3
  • 7.17. Version 0.3.2
  • 7.18. Version 0.3.1
• 8. Module Reference
  • 8.1. stelar namespace
    • 8.1.1. Subpackages
      • 8.1.1.1. stelar.client package

Indices and tables

• Index

• Module Index

• Search Page