On Mon, Aug 28, 2017 at 5:22 PM, Slichter, Daniel H. (Fed) via ARTIQ <[email protected]> wrote: >> What about publishing Raghu's code? It seemed pretty clean from the quick >> look I had at it during NACTI. > > For use as a general tutorial, the magtrap code that Raghu/NIST has written > is too complex and contains too many behaviors/design features that are > specific to our particular experiment. It would require substantial work to > retool it for use as a proper introduction for people who are new to ARTIQ, > and this sort of work has lower priority than our scientific projects at the > current time. This tutorial needs to stand on its own, without requiring the > authors of the tutorial to be available to answer questions; if we just post > existing code, there will be a million different questions about > minor/irrelevant details (we have had this experience a great deal already > when people have looked at our code), making it a huge time sink for us and > not very useful to new users. > > The reason we suggested a collaboration with a new group starting up with > ARTIQ is that they are best equipped to provide an accurate representation of > the sorts of questions/confusions/pitfalls that typical new users might have, > and so they will be able to comment their code and/or structure the tutorial > to address these most efficiently. We are willing to collaborate with such a > group to provide some general guidance on how we have solved relevant > problems, and offer advice on efficient code structure, which would provide a > benefit for the group getting started with ARTIQ, and then for other new > users as the tutorial takes shape.
Let me start by pointing out that specifically those new groups that you suggest should write the example code are actually the ones most interested in example code. They and potential ARTIQ adopters would also be the ones benefiting most. This has been a request since the beginning and was one when you guys were setting up the first experiments. Your analysis that the code writing should be fresh and still present in the creator's head is correct. That's the best phase for writing documentation and example code. It seems to me that everyone who has working code will likely claim that their code is too complex and too specific and that there are other priorities. We have to break out of that circle. -- Robert Jördens. _______________________________________________ ARTIQ mailing list https://ssl.serverraum.org/lists/listinfo/artiq
