AetherModel / aetherpy

Python package that supports Aether analysis
GNU General Public License v3.0
0 stars 5 forks source link

[FEAT] Make more robust python code for plotting #1

Open aaronjridley opened 3 years ago

aaronjridley commented 3 years ago

Is your feature request related to a problem? Please describe. There is a very simple plotting code available right now which is not very well written for python and is not very robust. This code should be upgraded so that it follows better coding standards for python and is a bit more robust and able to handle more types of plots.

Describe the solution you'd like The plotting code should:

Describe alternatives you've considered Add functionality slowly over time. This issue never closes, since plotting tools are always evolving and are extremely personal.

Additional context So many examples of plots that we could create. So. Many.

aburrell commented 3 years ago

Suggestion: move python code to a separate repository in the AetherModel project. That way people who want Aether but don't use python don't have extra code lying around. And people who just have files don't need to download the entire model to get the visualization tools.

aaronjridley commented 3 years ago

I would tend to not want to do this, since I would rather get the whole package at once. This is really only one "extra" directory, right? And would people use this for anything else beside the support of Aether? I guess it would be much more compelling if this plotting package supported all sorts of different things, like the Chameleon stuff that CCMC puts out. (This makes me think that by default we should support the output of Chameleon files for CCMC software....?) I guess I am always willing to talk about things, though!

Oh - Ben was just talking to us about the idea of linking repositories, so that when you clone one, you automatically get a certain version of another repository as a sub directory. Maybe we could do this? If it is transparent to most users, I would be happy to support this.

aburrell commented 3 years ago

I am not sure how pip support would work with this in an inclusive repository. I don't know how to link repositories (apart from including something as a dependency), but I like the idea. I can see future instances where people wouldn't need to get the model, but want to create plots. Especially once we have a public database of runs.

Apart from the "extra" directory, there will need to be at least installation and testing support.

qalshidi commented 3 years ago

@aburrell I think it would be wise to move to a new repository for pip support as that is how the python inclined would most-likely interface.