agencyenterprise / neural-data-simulator

Electrophysiology data simulator for developing brain-computer interfaces
https://agencyenterprise.github.io/neural-data-simulator/
Apache License 2.0
71 stars 7 forks source link

Make runners configurable from the command-line #44

Open charlesbmi opened 1 year ago

charlesbmi commented 1 year ago

Describe the new feature or enhancement

Please provide a clear and concise description of what you want to add or change.

Please describe how you would use this new feature.

Describe your proposed implementation

Describe how you think the feature or improvement should be implemented (e.g., as a new method on an existing class? as new capability added to an existing method?) If you're not sure, please delete this section and the next section.

The main goal is to make runners configurable from the command-line. To make the command-line arguments not too long/complex, we also will make configs modular using https://hydra.cc/docs/0.11/tutorial/composition/

Describe possible alternatives

If you've suggested an implementation above, list here any alternative implementations you can think of, and brief comments explaining why the chosen implementation is better.

Main alternative: keep as-is, with users needing to edit the configuration file.

Additional comments