search

sot / xija

Thermal modeling framework for Chandra X-ray Observatory
https://sot.github.io/xija
BSD 3-Clause "New" or "Revised" License
9 stars 5 forks source link

gui_fit.py SAVE - Give user ability to enter a description #12

Open Gregg140 opened 12 years ago

Gregg140 commented 12 years ago

If comments are allowed in JSON files, then when you hit SAVE in gui_fit.py, it would be helpful if we could get a pop up text window that allows us to write comments which would then be appended to the top of the resultant JSON file. This will help us identify what the salient feature(s) of this save is/are.

Relying on _numerals in the file name is helpful but not really enough.

jeanconn commented 12 years ago

I don't think text comments are allowed in JSON but I don't think anything would preclude a comment key in the structure.

Gregg140 commented 12 years ago

Jean,

When I emailed Tom about this, I got this reply:

This is possible and would be quite valuable. Please put it on github and not email, I won't implement any feature if it isn't on the issue tracker. Also, when you submit an issue if you put @taldcroft anywhere then I'll immediately get an email notifying me of the issue. Subsequent discussion will take place in the github issue tracker. Nance, if you want to be part of such discussions you'll need to get a github account.

Thanks, Tom

On Wed, May 9, 2012 at 1:04 PM, Gregg Germain gregg@head.cfa.harvard.edu wrote:

Hi Tom,

If comments are allowed in JSON files, then when you hit SAVE in gui_fit.py, it would be helpful if we could get a pop up text window that allows us to write comments which would then be appended to the top of the resultant JSON file. This will help us identify what the salient feature(s) of this save is/are.

Relying on _numerals in the file name is helpful but not really enough.

thanks,

Gregg

On 05/10/2012 02:21 PM, jeanconn wrote:

I don't think text comments are allowed in JSON but I don't think anything would preclude a comment key in the structure.

Reply to this email directly or view it on GitHub: https://github.com/sot/xija/issues/12#issuecomment-5632638

taldcroft commented 12 years ago

@Gregg140 - I was not bothering you with implementation details when I said that comments in the JSON file would be a fine idea. @jeanconn is correct that it would be done as part of the Python data structure that is serialized into JSON. There is other information that I want to store such as the parameters that were thawed for each fit and improvement in fit statistic, etc. Basically a path to more fully document the entire evolution of a model, I guess the model "provenance" if I'm using this trendy word properly.