Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added comments to each section and key #100

Merged
merged 1 commit into from
Jan 4, 2024
Merged

Added comments to each section and key #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion onair/config/default_config.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
# Required Section: DEFAULT section is the basic required elements for running OnAIR
[DEFAULT]
# Required Key: TelemetryDataFilePath is the path for TelemetryFile
TelemetryDataFilePath = onair/data/raw_telemetry_data/data_physics_generation/Errors
# Required Key: TelemetryDataFile is a file used by the selected parser
the-other-james marked this conversation as resolved.
Show resolved Hide resolved
# NOTE: TelemetryDataFile is required even when selected parser does not use it
TelemetryFile = 700_crash_to_earth_1.csv
# Required Key: TelemetryMetadataFilePath is the path for TelemetryMetadataFilePath
TelemetryMetadataFilePath = onair/data/telemetry_configs/
# Required Key: MetaFile describes frame composition of data
MetaFile = data_physics_generation_CONFIG.json
the-other-james marked this conversation as resolved.
Show resolved Hide resolved
# Required Key: ParserFileName is the name of the parser DataSource object to use
ParserFileName = onair/data_handling/csv_parser.py

# Plugins
# NOTE: even though keys are required, they may be set to empty dicts
# Required Key: KnowledgeRepPluginDict(s) are used by the VehicleRep
KnowledgeRepPluginDict = {'generic':'plugins/generic/__init__.py'}
# Required Key: LearnersPluginDict(s) are used by Agent for learning
LearnersPluginDict = {'generic':'plugins/generic/__init__.py'}
# Required Key: LearnersPluginDict(s) are used by Agent for planning
PlannersPluginDict = {'generic':'plugins/generic/__init__.py'}
# Required Key: ComplexPluginDict(s) are used by Agent for complex reasoning
ComplexPluginDict = {'generic':'plugins/generic/__init__.py'}

# Required Section: RUN_FLAGS are settable values to change running experience
[RUN_FLAGS]
IO_Flag = true
# Optional Key: IO_Flag denotes whether or not to provide console output
# IO_Flag defaults to false when not provided
IO_Flag = true