Docs, CI build and CLI interface improvements #303
Conversation
|
@timcnicholls could you enable the docs build under |
@GDYendell Sure. Which mode do you want? Deploy from branch or Github Actions? |
|
I think just Deploy from branch and then gh-pages. It uses this action to deploy it. |
GDYendell
force-pushed
the
docs-etc
branch
2 times, most recently
from
d8f4e00
to
e5c2507
Compare
|
Check for more docs content: |
GDYendell
force-pushed
the
docs-etc
branch
3 times, most recently
from
a0db8bf
to
9775f1a
Compare
GDYendell
force-pushed
the
docs-etc
branch
3 times, most recently
from
eba913c
to
cec47a8
Compare
|
This PR fixes a few existing issues. Check through and link them here. |
|
Update references to SharedMemoryParser. Replaced with SharedMemoryManager in 9fc3b93 |
- Remove various command line arguments that should be configured in the json config file
- Fix name of file writer class to register shutdown callback with - Erasing while iterating seems to cause seg faults in some cases
- Tidy App main and make FR and FP consistent
- Remove single-shot FrameProcessor argument - passing frames on startup makes it clear we should shutdown automatically and matches the frameReceiver API - Rename datasetSize to shutdownFrameCount for clarity
- Add path and timeout period - udp_packets_per_frame doesn't seem to matter, but that is the right number according to the debug logging in the fp (as is 8000 for size) - Add frames config so fp and fr shut down - Add packet-gap to make the test run reliably
- This was being parsed as a doc string for the FrameProcessor namespace
- Delete old doc directory
- Add initial docs for configuration options - Split out README into separate files in doc - Add description for OdinData instead of just FrameReceiver - Add more detailed build example - Add initial FrameSimulator - Remove entries for old python scripts
|
Add note that setting N frames = 0 means run until explicit stop. |
|
Check whether odin-data compiles with std=cxx11 compile flag |
Waiting on #301
This change aims to make it easier for new developers to get started using odin-data. There are a few unrelated parts:
Note that this branch requires the changes in #301, so includes those commits for now.
The docs are still very much a work in progress, but this adds the foundation to start adding to them. The keys things are:
Using the Python Toolsis very out of date, but I have left because it is probably better to have it than not.