odin-detector / odin-data

DAQ software libraries for capturing and storing data from parallel detector systems
https://odin-detector.github.io/odin-data/
Apache License 2.0
8 stars 11 forks source link

Docs, CI build and CLI interface improvements #303

Closed GDYendell closed 1 year ago

GDYendell commented 1 year ago

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:

GDYendell commented 1 year ago

@timcnicholls could you enable the docs build under Settings > Pages > Build and Deployment? Hopefully then it will run the build step. I am not sure if it will actually publish them until they are built on master.

timcnicholls commented 1 year ago

@timcnicholls could you enable the docs build under Settings > Pages > Build and Deployment? Hopefully then it will run the build step. I am not sure if it will actually publish them until they are built on master.

@GDYendell Sure. Which mode do you want? Deploy from branch or Github Actions?

GDYendell commented 1 year ago

I think just Deploy from branch and then gh-pages. It uses this action to deploy it.

GDYendell commented 1 year ago

Check for more docs content:

GDYendell commented 1 year ago

This PR fixes a few existing issues. Check through and link them here.

GDYendell commented 1 year ago

Update references to SharedMemoryParser. Replaced with SharedMemoryManager in 9fc3b93c754ca2e24e274bd94bd9d3b889b1a2c4

GDYendell commented 1 year ago

Add note that setting N frames = 0 means run until explicit stop.

GDYendell commented 1 year ago

Check whether odin-data compiles with std=cxx11 compile flag

GDYendell commented 1 year ago

Superceded by #317, #318, #314