search

NAU-CCL / SPHERE

MIT License
1 stars 0 forks source link

9 output object #13

Closed atiumcache closed 3 months ago

atiumcache commented 3 months ago

closes #12 closes #9

See docs/output_class-2024-06-16 for an example of the Output class implementation.

Currently, the Output object stores the state and defines a plotting method for displaying a basic plot. More functionality can be added when we have a better idea of what we want (export to csv, different types of plots, etc.)

Averydx commented 3 months ago

A couple things, I would indicate return types for all the functions in abstract.py, even the constructor just for consistency. I also think we should follow the convention of upper level directory name, "output", then followed by "abstract" and "implementations" with each class in its own file for readability. That way we don't have one expanding file. Just some ideas.

Averydx commented 3 months ago

Oh also, I do think the observation function or at least a field in the output object is necessary. Not always the case that observation information can be extracted directly from the state variables.

atiumcache commented 3 months ago

I agree with your comments, I'll make these changes.

atiumcache commented 3 months ago

updated with a new commit that addresses/fixes your comments @Averydx.