FAAM-146 / spif

Data standard for Single Particle Image Format for Optical Array Probes
https://www.faam.ac.uk/sphinx/spif/
MIT License
0 stars 1 forks source link

docs? #1

Closed graemenott closed 5 months ago

graemenott commented 9 months ago

Not really sure why I thought a full-blown docs was required. Move example files from /docs/source/examples to /example?

graemenott commented 9 months ago

Suggestions then are;

davesproson commented 9 months ago

Suggestions then are;

  • [ ] Create a more generic version of an in-house standard definition (where should this go, in standard/v1/definitions or example/?)

Not quite sure what you mean by this... The standard is the standard - it becomes a 'FAAM' (is this what you mean by in-house?) spif file by validating against both spif and faam-data. The individual (FAAM) product specs should live in faam-data.

graemenott commented 9 months ago

This is to do with generalising the documentation. I'm suggesting an organisation agnostic definition (somewhat) equivalent to the FAAM one but which can be carried/cloned with the spif-std repo and used as an example by the hordes of adoring fans.

You're right though that I need to be careful with the language. It's a definition that reflects in-house file structure requirements(?).