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.

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

Index documentation by arena modules #24

Open
glopesdev opened this issue Sep 25, 2024 · 0 comments
Open

Index documentation by arena modules #24

glopesdev opened this issue Sep 25, 2024 · 0 comments
Labels
proposal Request for a new feature

Comments

@glopesdev
Copy link
Collaborator

glopesdev commented Sep 25, 2024

The Aeon infrastructure is complex and multi-dimensional, spanning hardware, acquisition software, standard data formats, and a low-level API for data analysis. Each of these different components is built using different languages, spanning CAD programs, C# and Python.

This poses a significant challenge for documenting the modular components of the arena for researchers interested in piecing together their own tasks and environments using Aeon.

One complementary approach to documenting functionality by repository (aeon_arena, aeon_acquisition, aeon_mecha, etc) would be to also index documentation by modular building blocks in the arena. This would be a visually-guided index, where we could have a list or table of each reusable module and reference in each entry the corresponding CAD, acquisition operators, data format and low-level API schema.

Mockup below:

Arena Feeder Nest
arena feeder nest
  • CAD
  • Acquisition
  • Data Schema
  • Examples
  • CAD
  • Acquisition
  • Data Schema
  • Examples
  • CAD
  • Acquisition
  • Data Schema
  • Examples
@glopesdev glopesdev added the proposal Request for a new feature label Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal Request for a new feature
Projects
None yet
Development

No branches or pull requests

1 participant