ISISComputingGroup / lewis-ess

Let's write intricate simulators!
GNU General Public License v3.0
21 stars 19 forks source link

Documentation for Setups #226

Closed OwenArnold closed 3 years ago

OwenArnold commented 7 years ago

With the versioning introduced in release1.0.3, we anticipate devices/interfaces living in a separate package. To make this even more generic, we want people using setups to add any edge-case behaviour over the vanilla devices. Devices should be written to be as close as possible to the real thing. We therefore need to improve our documentation for setups. I've discussed with @MichaelWedel putting something into the developer documentation to fully explain what you can do with setups with some nice examples. i.e how to add your own custom States and Transitions

MikeHart85 commented 7 years ago

This is a good idea, we currently neglect setups a bit.

It might also be a good opportunity to take another look at whether setups are capable of doing everything that device developers expect / need from them, or whether we need to revisit how they work and what they can do.

MichaelWedel commented 7 years ago

Yes, we should definitely update the documentation. Whether setups do everything they need to do is a separate (and potentially more difficult) question that probably should get its own issue.