Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
r2x-core
r2x-core
  • Installation
  • Tutorials
    • Getting Started with R2X Core
    • Working with Units in Power System Components
  • How-To Guides
    • … create JSON configurations
    • … load DataStore from configuration
    • … export existing configurations
    • … validate configurations
    • … manage environment-specific configurations
    • … read data files with DataReader
    • … configure data caching
    • … handle different file types
    • … work with optional files
    • Working with HDF5 Files
    • … read an HDF5 file with default settings
    • … read tabular HDF5 data with column names
    • … read HDF5 time series data
    • … read HDF5 files with metadata fields
    • … configure HDF5 reading in JSON
    • … create a DataStore with multiple HDF5 files
    • … process HDF5 data with datetime filtering
    • … create a basic DataFile
    • … map column names during loading
    • … filter data during loading
    • … work with different file types
    • … use custom reader functions
    • … create a DataStore
    • … add files to a DataStore
    • … read data from a DataStore
    • … manage DataStore contents
    • … save and load DataStore configurations
    • … perform column operations
    • … filter data during loading
    • … reshape data with pivot operations
    • … select specific columns
    • Unit Operations
    • … perform column operations
    • … filter data during loading
    • … reshape data with pivot operations
    • … select specific columns
    • … get all components as records
    • … filter components by type
    • … filter components by attributes
    • … select specific fields
    • … rename fields with key mapping
    • … combine filtering, field selection, and renaming
    • … use records for data analysis
    • … export components to CSV
    • … count components by type
    • … mark a file as time series
    • … configure time series files in DataStore
    • … validate time series file formats
    • … store multi-year time series in a single file
    • … filter time series files in a parser
    • … handle different time series file types
    • … export time series files
    • … add support for a new time series format
    • … create a basic exporter
    • … export components to CSV files
    • … export time series data
    • … handle multi-year time series export
    • … validate export configuration
    • … use custom export transformations
    • … export with progress logging
    • … handle optional time series files
    • … follow plugin standards
    • … use standard directory structure
    • … create configuration classes
    • … customize file and directory names
    • … load default constants
    • … create file mappings
    • … get file mapping path
    • … use custom mapping filename
    • … create DataStore from config
    • … get mapping path from PluginManager
    • … generate CLI schemas
    • … build CLI tools from schema
    • … understand CLI flag naming
    • … see complete plugin example
    • … follow best practices
    • … see also
    • … register a complete model plugin
    • … register a parser-only plugin
    • … register an exporter-only plugin
    • … register a system modifier
    • … register a system modifier with context
    • … register filter functions
    • … register a polymorphic filter
    • … create an external plugin package
    • … test plugin registration
    • … discover registered plugins
    • … load and use a parser
    • … load and use an exporter
    • … apply a system modifier
    • … apply multiple modifiers in sequence
    • … apply modifiers with context
    • … apply a filter to data
    • … chain multiple filters
    • … use filters in parser
    • … discover plugins from entry points
    • … build a translation application
    • … handle missing plugins gracefully
    • … validate translation path
  • Explanations
    • Plugin System Architecture
    • Unit System Design and Architecture
    • HDF5 Reader System
  • Reference
    • API Reference
    • System
    • Units Module
    • Parser Framework
    • Exporter Framework
    • Plugin System
    • Data Processors
    • Utilities
    • Exceptions
    • File Formats
    • File Types API Reference
    • Models
  • Contributing
  • Changelog
Back to top
View this page
Edit this page

Models¶

For complete API documentation of data models, see API Reference.

Quick Reference¶

  • DataFile - Data file configuration model

  • DataStore - Data store container

  • DataReader - Data reader utility

Next
Contributing
Previous
File Types API Reference
Copyright © 2024, Alliance for Sustainable Energy LLC, All rights reserved.
Made with Sphinx and @pradyunsg's Furo
On this page
  • Models
    • Quick Reference