search

python-microscope / microscope

Python library for control of microscope devices, supporting hardware triggers and distribution of devices over the network for performance and flexibility.
https://www.python-microscope.org
GNU General Public License v3.0
69 stars 41 forks source link

data with device specs / manuals #45

Closed carandraug closed 1 year ago

carandraug commented 6 years ago

We need something where we store the specs we use to implement the interface to the devices we have. We already have a directory shared between us in micronadmin. However, that won't work if there's people outside micron working on microscope. Also, I'd prefer that people can't accidentally remove files.

mickp commented 6 years ago

If you're talking about the vendor-supplied documents on micronadmin, we need to be very careful - much of that documentation is provided under licence, and the licence may not allow us to redistribute.

On Fri, 22 Jun 2018, 14:43 Carnë Draug, notifications@github.com wrote:

We need something where we store the specs we use to implement the interface to the devices we have. We already have a directory shared between us in micronadmin. However, that won't work if there's people outside micron working on microscope. Also, I'd prefer that people can't accidentally remove files.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/MicronOxford/microscope/issues/45, or mute the thread https://github.com/notifications/unsubscribe-auth/AE5pr3SRePfkO0jtQb3Pd6y0Ds_QzVteks5t_PSdgaJpZM4Uz0gZ .

carandraug commented 1 year ago

This is very annoying because getting the vendors to give us access to the documentation is difficult and access to a specific version is just impossible. And access to the documentation is fundamental to the development of this project. But Mick is right, we simply cannot redistribute the documentation, so I'm closing this issue.

If we could, I would have proposed we create a git repository and dump all the documentation there with the versions used for development. We need the different versions so we can reason why something was done in that way in the past. This would lead to a very large repository. Not only would it be a pain to clone, it would go over our traffic limit very quickly. So I'd suggest using git LFS (and not git annex before github does not support it) which enables downloading only certain files (although that's not the default). Documentation would be not only the manuals but also any header files.