sinara-hw / Sayma_AMC

AMC FPGA carrier board with FMC, dual SFP and RTM
8 stars 6 forks source link

HT4 formal documentation #124

Open jbqubit opened 5 years ago

jbqubit commented 5 years ago

Formal hardware documentation for Sayma v2 is to be maintained in github.

jbqubit commented 4 years ago

@marmeladapk Who is working on the Sayma v2 documentation? This is an excellent deliverable for COVID-at-home. :)

Getting good documentation is now critical as Oxford @hartytp begins testing of the hardware. Right testing focuses on phase noise. @hartytp took some notes on the clock synchronization scheme while bootstrapping his test setup. Having authoritative documentation framework is key to get physicists up and running with minimal fuss -- eg DIP switch configuration on AMC -- and so that there's a structure to absorb refinements or extensions to documentation that come from testing in various labs.

marmeladapk commented 4 years ago

@jbqubit Right now mainly I am working on it. I ported existing AMC and RTM documentation to sphinx already, however it's still a lot of work to update it to v2.0. I'll post here once I'll have something usable.