search

McDermott-Group / servers

Public repo that stores LabRAD servers and other non-measurement related code
0 stars 2 forks source link

[DataChest, Grapher] Imrpove Documentation #28

Open roboguy222 opened 8 years ago

roboguy222 commented 8 years ago

Explain Time Stamps in file names - How do they work, how do we turn them on/off, how can we manually set what they are (for changing backlogged data). side comment: i think the date is actually more important to be human readable than the time, but we can also sort the files by date created or w/e.

Special Parameters - What special parameters are available, like fit, or plot title, or w/e?

How do I set the path or cd to a directory? This includes cd, but also the environment variables, and __init__ input when instantiating a dataChest.

How to overright a parameter: addParameter(overwrite=True)

How to open a data chest for editing: d.openDataset(modify=True)

docs for dataChest.util?

amopremcak commented 8 years ago

Explain Time Stamps in file names needs to be done for sure. Special Parameters should also be explained for compatibility with grapher. Initial cd needs to be implemented.

As for How to overright a parameter, this is in the newest pdf in the repo along with how to open a dataset with modification privileges.

amopremcak commented 8 years ago

Add some notes on how to do slicing

amopremcak commented 7 years ago

Done ==> How to overright a parameter: 'addParameter(overwrite=True)' Done ==> How to open a data chest for editing: d.openDataset(modify=True) Done ==> Environment variables and navigation directories Done ==> Slicing notes

Todo:

1) Explain Time Stamps in file names - How do they work, how do we turn them on/off, how can we manually set what they are (for changing backlogged data).

As of now, dateStamps cannot be turned off, you either provide it with a stamp or one is automatically generated. This is to prevent naming conflicts and organize the data chronologically. Do you want to allow for the option to omit them entirely @roboguy222? It can be done easily, but then we have to generate something like an index, that increments, at the end or beginning of the name in the event of duplication. They are kind of two approaches towards the same goal.

2) Special Parameters - What special parameters are available, like fit, or plot title, or w/e?

We need to decide on a minimal set of special parameters @roboguy222 and @patzinak for indicating things like labels, plot titles, and how to designate things like fits.

3) docs for dataChest.util?

The only dataChest util type file is dateStamp.py @roboguy222. Do you think this deserves a brief description in the document?

roboguy222 commented 7 years ago

1) I don't really care if we can turn the datestamps on or off. 2) 3) Yes

amopremcak commented 7 years ago

dateStamps are now explained in the document, though briefly, in the createDataset section which is a natural place describe them because that is where they first appear. The dataChest.util file isn't being used for anything right now so I plan to remove it. We should talk about special parameters at some point when you are back @roboguy222.