How-To Guides¶
These guides show you how to solve specific problems with R2X Core.
Configuration Management¶
Reading Data Files¶
- … 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
Working with DataFiles¶
Managing Data with DataStore¶
File Operations and Transformations¶
Working with Units¶
Building Systems with Parsers¶
Working with System Components¶
Working with Time Series Files¶
- … 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
Exporting Systems¶
Plugin System¶
- … 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