ImperialCollegeLondon / Faraday-liionsden

BSD 3-Clause "New" or "Revised" License
2 stars 1 forks source link

Protocol handling #38

Closed dandavies99 closed 1 year ago

dandavies99 commented 2 years ago

Problem: The protocols for the cycling experiments are a specific recipe of the steps taken by the cycler and (often? always? depends on the cycler machine?) listed in the metadata at the top of the output file. It would be useful be able to parse these so they can be exported and shared.

Proposed solution: Initially, we should parse that section of the file "as-is" and save as an array(?) that is associated with the ExperimentDataFile and can be exported and shared.

dandavies99 commented 2 years ago

The metadata in the header of the raw data files is parsed already in parse_data_file() but for some reason the resulting ExperimentDataFile objects have no attribute parsed_metadata despite this line being in the clean() method. At least, when using the biologic_example.csv and a simple Parser that includes time, voltage and current.

dandavies99 commented 2 years ago

Speaking to Niall, it was clear that this part of the data file rarely needs to be accessed in isolation or manipulated. It is therefore probably fine to leave this data existing in the raw data file, which can be downloaded in its entirety already. The above parsed_metadata aspects - i.e. the actual metadata above the cycler "recipe" - are being addressed in #64.

Instead, protocol probably refers more closely to Manufacturing Protocol, which is to do with how the devices are made. I will clarify what we should do with this model with the researchers and update this issue.

dandavies99 commented 2 years ago

Talking to Niall and Jacqueline again, it is clear that the general idea is to be able to share "common protocols" for experiments between institutions/researchers, but exactly what form they will take needs some thought. This is not a priority for now, so we can leave the protocol model there to be adapted as needed in the future.

dandavies99 commented 1 year ago

This is being covered by #179