schematicpy
  • Installation
    • Installation Requirements
    • Installation Guide For: Users
      • 1. Verify your python version
      • 2. Set up your virtual environment
        • 2a. Set up your virtual environment with venv
        • 2b. Set up your virtual environment with conda
      • 3. Install schematic dependencies
      • 4. Get your data model as a JSON-LD schema file
      • 5. Obtain Google credential files
      • 6. Set up configuration files
    • Installation Guide For: Developers
      • 1. Clone the schematic package repository
      • 2. Install poetry
      • 3. Start the virtual environment
      • 4. Install schematic dependencies
      • 5. Set up configuration files
      • 6. Obtain Google credential files
      • 7. Verify your setup
  • Setting up your asset store
    • Option 1: Distributed Synapse Projects
      • Access & Project Setup - Multiple Contributing Projects
    • Option 2: Single Synapse Project
      • Access & Project Setup - Single Contributing Project
    • Synapse External Cloud Buckets Setup
  • Configure Schematic
    • Asset Store
      • Synapse
    • Manifest
    • Model
    • Google Sheets
  • Validation Rules
    • Overview
    • Validation Types
    • Rule Implementation
    • Rule Types and Details
      • List Validation Type
        • list
      • Regex Validation Type
        • regex
      • Type Validation Type
        • float
        • int
        • num
        • str
      • URL Validation Type
        • url
      • Required Validation Type
        • required
      • Cross-manifest Validation Type
        • Value Scope
        • Set scope
      • Content Validation Type
        • recommended
        • protectAges
        • unique
        • inRange
        • date
      • Filename Validation
        • filenameExists
      • Rule Combinations
      • Component-Based Rule Setting
  • Generate a manifest
    • Prerequisites
    • Run help command
    • Generate an empty manifest
      • Option 1: Use the CLI
      • Option 2: Use the API
    • Generate a manifest using a dataset on synapse
      • Option 1: Use the CLI
      • Option 2: Use the API
    • Generate a manifest using a dataset on synapse and pull annotations
      • Option 1: Use the CLI
      • Option 2: Use the API
  • Validating a Metadata Manifest
    • Prerequisites
    • Requirements
      • Authentication
      • File Format
      • Required Column Headers
      • Restricted Column Headers
    • Manifest Validation
      • Overview
      • With the CLI
        • Authentication
        • Parameters
      • With the API
        • Authentication
        • Parameters
        • Request Body
        • Response
      • With the Library
  • Submit a manifest to Synapse
    • Prerequisites
    • Run help command
    • Submit a Manifest File to Synapse
      • Option 1: Use the CLI
      • Option 2: Use the API
    • Submit a Manifest file and Add Annotations
      • Option 1: Use the CLI
      • Option 2: Use the API
    • Expedite submission process (Optional)
      • Option 1: Use the CLI
      • Option 2: Use the API
    • Enable upsert for manifest submission
      • Pre-requisite
      • Option 1: Use the CLI
      • Option 2: Use the API
  • Tutorials
    • Contributing your manifest with the CLI
      • Prerequisites
      • Steps to Contribute a Manifest
      • Step 1: Generate a Manifest
      • Step 2: Validate the Manifest (Optional)
      • Step 3: Submit the Manifest to Synapse
  • Troubleshooting
    • Debugging
    • Manifest Submit: RuntimeError: failed with SynapseHTTPError(‘400 Client Error: nan is not a valid Synapse ID.’)
    • Manifest Submit: TypeError: boolean value of NA is ambiguous
    • Manifest Submit: AssertionError: input_df lacks Id column.
    • Manifest validation: The submitted metadata does not contain all required column(s)
    • Manifest validation: The submitted metadata contains << ‘string’ >> in the Component column, but requested validation for << expected string >>
    • Manifest Generate: KeyError: entityId
    • Manifest Generate: ValueError: cannot insert eTag, already exists
  • CLI Reference
    • Generate a new manifest as a Google Sheet
    • Generate an existing manifest from Synapse
    • Validate a manifest
    • Submit a manifest as a file
    • In depth guide
      • schematic
        • manifest
        • model
        • schema
        • viz
  • LinkML
    • Background
    • Links
  • Generate JSON Schema from Data Models
    • JSONSchema Components and How to Set from Data Model
      • Property Keys
      • Description
      • Type
        • Explicit Type Setting
        • Implicit Type Inference
        • Implicit Format Inference
      • Validation Checks
        • Type Checks
        • Valid Values
        • Required Attributes
        • Validation Rules
      • Conditional Dependencies
schematicpy
  • Search

© Copyright 2024, Sage Bionetworks.

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