Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
ts-ids-core documentation
ts-ids-core documentation

Introduction

  • Welcome
  • What IDS Is (and Is Not)

Get started

  • Tutorial
  • Background Reading
  • Defining a programmatic IDS
  • Working with programmatic IDS instances

Creating an IDS artifact

  • What is an IDS artifact?
    • Platform Requirements
    • schema.json
    • elasticsearch.json
    • athena.json
    • manifest.json
    • README.md
    • IDS versioning rules
  • High-Level Design Principles
  • Top-level data blocks
  • Design Guidelines
    • Fields and Types
    • Data Integrity
    • Date and Time
    • Units
    • Samples fields: batch, set
    • IDS Metadata and Identifiers
    • Describing relationships in IDSs
    • Field Naming
    • Highly Unstructured Data
    • Large Numerical Data
    • Datacubes and Results
  • Components
  • Artifact and repository naming

Task script conventions

  • Task script conventions
  • Design pattern
    • Task script repo structure
    • Context API usage
    • Designing a primary model
    • Parsing to the primary model
    • Mapping the primary model to the IDS
  • Coding standards
    • General coding standards
    • Versioning
    • Testing
    • Logging
    • Datetime parsing
    • Units
    • UUIDs
    • Writing Parquet files
  • File types
    • CSV-like files
    • Excel files
    • JSON files
    • XML files
    • PDF files
    • Text based files

Protocol conventions

  • Protocol conventions
  • Syntax and expressions
    • protocol.yml field reference
    • Expressions
  • Conventions
    • Config and constants
    • Steps and chaining
    • Repo structure
    • README conventions
    • Versioning
    • Testing

CLI

  • ts-ids group
    • Launch documentation
    • Export schema
    • Import schema
    • Mapping table
    • Schema diff

API

  • Annotations
  • Errors
  • Base
    • meta
    • ids_element
    • ids_field
    • ids_undefined_type
  • Schema
    • ids_schema
    • project
    • run
    • system
    • user
    • datacube
    • dimension
    • measure
    • sample
    • modifier
    • parameter
    • time
    • related_file
    • value_unit
    • semantic
      • ts_ids_core.schema.semantic.concept module

Reference

  • Release notes
  • License
Back to top

ts_ids_core.mapping_table package¶

Submodules¶

  • ts_ids_core.mapping_table.constants module
  • ts_ids_core.mapping_table.convert module
  • ts_ids_core.mapping_table.locate module
  • ts_ids_core.mapping_table.mapping_table module
  • ts_ids_core.mapping_table.schema_path_models module
  • ts_ids_core.mapping_table.sync module

Module contents¶

Copyright © 2026, TetraScience
Made with Sphinx and @pradyunsg's Furo
On this page
  • ts_ids_core.mapping_table package
    • Submodules
    • Module contents