HERA-Team / hera_sim

Simple simulation code for HERA-like redundant interferometric arrays
Other
16 stars 8 forks source link

Generality vs Complexity #214

Open r-pascua opened 2 years ago

r-pascua commented 2 years ago

I'm creating this issue because of a short discussion in #212 regarding the current state of hera_sim perhaps being too complex. I know that for my current and planned uses, I like the amount of generality and extensibility afforded by the current implementation, but I don't know what the community thinks, and I'm well aware that the level of complexity makes for a steep learning curve to developing, and this is particularly true when it comes to the Simulator class. @steven-murray and I had discussed this quite a bit in the past, but I don't think we were able to figure out a resolution that maintains the level of generality and extensibility in a simpler implementation. If there is a desire to see changes to the current implementation, then we will revisit this and try to find a solution before the next major version release.

So, I would like people who use (or plan to use) hera_sim (and in particular the systematics simulation stuff) to leave their thoughts here. Is the current state of the code too hard to parse? Is it easy or difficult to use the features it provides? Are the (up-to-date) tutorials thorough enough for getting spun up on how to use the code, or do they need to be improved? Are there other concerns you'd like to discuss that aren't covered by the other prompts? Please let us know.

It looks like much of the previous discussion of this must have happened via Slack, since I can't find an issue or PR where we discussed this. That said, we did have some back-and-forth on an improved implementation of the defaults-switching feature in #135 that does touch on this to some extent.