103 change readme composition and add more information about running #164
Conversation
asgibson
force-pushed
the
103-change-readme-composition-and-add-more-information-about-running
branch
from
3c50838
to
2794fc4
Compare
README Removed options from enviroment set up, now only provide local pip install directions. Edited some text for clarity. Made default_config.ini link the permalink. Completely reworked the next steps section. Architecture Updated and expanded initial paragraph at top. Added Data source sections. Added flow to pipeline. Made file outlines into tables. CSV parser section filled out. Unfinished sections marked as such. Provided example for the pipeline data. Changed low and high level data definitions. Fixed render_reasoning output text (a dict is not required to be returned). Added flow diagram. Added more output for the reporter plugin example.
asgibson
force-pushed
the
103-change-readme-composition-and-add-more-information-about-running
branch
from
fd829f3
to
7bdf5bb
Compare
doc/architecture.md
Outdated
| >Pathing and file name information | ||
| >|Key|Required?|Expected Type|Description| | ||
| >|-|-|-|-| | ||
| >|TelemetryFilePath|Yes|str|location of the telemetry file on the local system| |
There was a problem hiding this comment.
Should TelemetryFilePath and TelemetryFile not be required for live data sources? Related issue: #107
There was a problem hiding this comment.
It should not, but currently is
There was a problem hiding this comment.
To clairfy: this documentation is stating what is the case at present. Both TelemetryFilePath and TelemetryFile are required keywords. You can leave them blank when your "adapter" source does not use it. Making them blank in the Redis example .ini (they are not currently blank, fyi) works fine because the adapter even states at start:
$ python driver.py onair/config/redis_example.ini
Redis Adapter ignoring file
However, you cannot remove the keywords from the .ini file:
KeyError: "Config file: 'onair/config/redis_example.ini', missing key: TelemetryFilePath"
Therefore, they are still required. It would be best to change this, but that is best put into another issue.
doc/architecture.md
Outdated
|
|
||
| It consists of the following sections: | ||
| ## The OnAirDataSource | ||
| This is the adapter that attaches OnAIR to a telemetry source. It provides the basic data that is used by the cognitive components to render reasoning about the system. |
There was a problem hiding this comment.
I've started to use the language of "parsers" <- a static data source (i.e. csv_parser.py) and "adapters" <- connects to a live data source (i.e. redis_adapter.py). Both parsers and adapters are data sources.
There was a problem hiding this comment.
Does that mean you want this sentence changed somehow? Mention both?
doc/architecture.md
Outdated
| - Acceptable values, all will become floats | ||
| - Integer | ||
| - Float | ||
| - Timestamp str |
There was a problem hiding this comment.
Maybe just refer to convert_str_to_timestamp in parser_util.py to show the expected formats
Moved images directory into doc directory Landing page README Added supported python versions badge Added black code style badge Moved logo to doc/images Separate lines for sentences in same paragraph Moved optional for step 3 (unit test run) to top of step Fixed links Removed unnecessary Contact section Architecture Separate lines for each sentence in paragraph Changed and made consistent 'Telemetry Definintion File' Fixed links Expanded and clarified high_level_data definition Flow section redone for clarity and ease of use Doc section README Fixed logo image location
Updates. Not yet complete, requesting comments.