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

Docs, CI build and CLI interface improvements #303

Closed
wants to merge 26 commits into from
Closed

Docs, CI build and CLI interface improvements #303

wants to merge 26 commits into from

Commits on Feb 7, 2023

  1. Code changes to fix build

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    cf607c6 View commit details
    Browse the repository at this point in the history

  2. Remove usage of config file for command line arguments 

    - Remove various command line arguments that should be configured in the json
  config file
    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    03fa8d2 View commit details
    Browse the repository at this point in the history

  3. Fix shutdown logic 

    - Fix name of file writer class to register shutdown callback with
- Erasing while iterating seems to cause seg faults in some cases
    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    2fdc20e View commit details
    Browse the repository at this point in the history

  4. Return success for help and version 

    - Tidy App main and make FR and FP consistent
    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    2848086 View commit details
    Browse the repository at this point in the history

  5. Simplify frameProcessor shutdown 

    - 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
    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    fbb4346 View commit details
    Browse the repository at this point in the history

  6. Update test configs 

    - 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
    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    1f00c49 View commit details
    Browse the repository at this point in the history

  7. Add zmq control python script

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    384879f View commit details
    Browse the repository at this point in the history

  8. Add dummy_example scripts

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    00948b1 View commit details
    Browse the repository at this point in the history

  9. Move doc string 

    - This was being parsed as a doc string for the FrameProcessor namespace
    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    53ee156 View commit details
    Browse the repository at this point in the history

  10. Fix macro substitution of installed config files

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    e4414f4 View commit details
    Browse the repository at this point in the history

  11. Add MetaMessage unit tests to build

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    b18cb84 View commit details
    Browse the repository at this point in the history

  12. Increase logging in GitHub actions unit tests

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    2fdd20b View commit details
    Browse the repository at this point in the history

  13. Extract FrameSimulatorPlugin REGISTER call into Lib.cpp

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    8254b18 View commit details
    Browse the repository at this point in the history

  14. Create Sphinx docs using MyST and Breathe 

    - Delete old doc directory
    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    8b8f561 View commit details
    Browse the repository at this point in the history

  15. Update README 

      - 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
    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    1336a07 View commit details
    Browse the repository at this point in the history

  16. Disable EXTRACT_ALL to see doxygen warnings

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    a359b21 View commit details
    Browse the repository at this point in the history

  17. Rename CI workflows

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    3e3cbdc View commit details
    Browse the repository at this point in the history

  18. Manually install odin-control from github for docs build

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    e936724 View commit details
    Browse the repository at this point in the history

  19. Fix CI integration test

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    4a8215b View commit details
    Browse the repository at this point in the history

  20. Install frameReceiverTest

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    7239721 View commit details
    Browse the repository at this point in the history

  21. Do parallel build in CI

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    a99cf5c View commit details
    Browse the repository at this point in the history

  22. TMP - Add docs-etc to docs deploy branch list

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    9e17ebd View commit details
    Browse the repository at this point in the history

  23. WIP - Update docs build

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    a5c41af View commit details
    Browse the repository at this point in the history

  24. WIP - Move docs to top

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    df9cc27 View commit details
    Browse the repository at this point in the history

  25. WIP - Update system test configs

    @GDYendell
    GDYendell committed Feb 7, 2023
    Configuration menu
    Copy the full SHA
    f80add6 View commit details
    Browse the repository at this point in the history

Commits on Apr 11, 2023

  1. Tidy setup.py

    @GDYendell
    GDYendell committed Apr 11, 2023
    Configuration menu
    Copy the full SHA
    af86483 View commit details
    Browse the repository at this point in the history