Mandatory fields need refining

[dandavies99]

Problem: Many models can be saved without some info that seems as though it should be mandatory. E.g. "name". There may be a good reason that some models don't fundamentally have to have certain fields as mandatory, but it might be a good idea to review this.

Proposed solution:

• [x] Review the key models in BattDB and dfndb and make sure that if fields are not mandatory it makes sense.
• [x] If we decide to leave some fields as null=True, review whether this should be enforced in the front end in some cases. E.g. should a user be able to upload an Experiment with no "name" via the webapp form? This can be enforced at the form level if needed.
• [x] Also review unique-ness of important fields e.g. experiment names, batch names etc.

Aha! Link: https://imperial-college-ict.aha.io/requirements/RSE-132-22

[AdrianDAlessandro]

Starting by reviewing what is visible in the forms. Some issues with saving forms with blank values in mandatory fields might be solved by the valid formset issue identified in https://github.com/ImperialCollegeLondon/Faraday-liionsden/pull/209#issuecomment-1320097556

Models and fields that should be mandatory (uncertain marked with "?"):

• Experiment:
  • [ ] Name - also should be unique and is not
  • [ ] Thermal management - Currently mandatory, but includes a None option
  • [ ] Device-Batch - Currently mandatory but can include Null option
  • [ ] Experiment type and Thermal management? - both have an "Other" option - but detail to be included in the optional notes. Should the detail be made mandatory is other is selected?
  • [ ] Config? - mentions "all devices must be the same config" but allows Null option
  • [ ] Temperature? - should this not be in the data files?
• ExperimentDataFile:
  • [ ] Name - if left blank is given a name based on the file. I think this is good behaviour, but a note should be added to the form to say this.
  • [ ] Machine?
• Batch
  • [ ] Specification - Currently mandatory but includes a None option
  • [ ] SerialNo - also should be unique and is not
• Device specification
  • [ ] Name - also should be unique and is not
  • [ ] Type?
  • [ ] Parameter - Currently mandatory but allows a Null option
  • [ ] Component - Currently mandatory but allows a Null option
• Equipment
  • [ ] Name - also should be unique and is not
  • [ ] SerialNo - also should be unique and is not
  • [ ] Institution is mandatory, should it be?
• Component
  • [ ] Name - also should be unique and is not
  • [ ] Composition-Compound - Currently mandatory but allows a Null option
  • [ ] Composition-Amount - Currently mandatory but allows a Null option
• Compound
  • [ ] Name are Formula are unique together, but not individually. Name should definitely be unique, should Formula also?

[dandavies99]

This is great - looks like a really thorough sweep. Some of these might benefit an IRL discussion so let's do that then make some changes.

[dandavies99]

For the models with mandatory name, we can inherit from HasMandatoryName instead of HasName.

• Experiment:
  • [x] Name - Mandatory and unique together with something? e.g. unique name+institution. Give useful error message if condition not met in frontend form.
  • [x] Thermal management - Not mandatory
  • [x] ~Device Formset: Fields show as mandatory even though the formset itself is optional. E.g. you can add no devices to an experiment, but if you do add any devices then all three fields (Batch, Batch Sequence, Device Position) are mandatory.~ Moved to #249.
  • [x] Experiment type and Thermal management? - both have an "Other" option - but detail to be included in the optional notes. This is fine but change thermal management "None" to "No thermal management"
  • [x] Specify in Summary not Notes if "other" selected.
  • [x] Config? - We should include a data migration for single cell and make this field mandatory for experiments.
  • [x] Temperature? - have as non-mandatory.
• ExperimentDataFile:
  • [x] Name - if left blank is given a name based on the file. I think this is good behaviour, but a note should be added to the form to say this in the help text. Leave as non-mandatory.
  • [x] Machine - leave as non-mandatory.
• Batch
  • [x] Specification - Leave as is - it is and should be mandatory but null should be an option.
  • [x] SerialNo - also should be unique and is not
• Device specification
  • [x] Name - also should be unique and is not
  • [x] Type?
  • [x] ~Parameter - Currently mandatory but allows a Null option~ Moved to #249
  • [x] ~Component - Currently mandatory but allows a Null option~ Moved to #249
• Equipment
  • [x] Name - also should be unique and mandatory
  • [x] SerialNo - Leave as is for now as batches well-defined by manufac-date-device combo.
  • [x] Manufacturer (Organisation) - is mandatory and should be, but should be limited to "is mfg cells"
• Component
  • [x] Name - also should be unique and mandatory
  • [x] ~Composition-Compound - Currently mandatory but allows a Null option~ Moved to #249
  • [x] ~Composition-Amount - Currently mandatory but allows a Null option~ Moved to #249
• Compound
  • [x] Name are Formula are unique together, but not individually and they should be. Then there is no need for them to be unique together.
• DeviceParameter
  • [x] Value should be mandatory, can currently be blank / null.