The Siamang user textbook
Designing, deploying and analyzing sociological surveys with research-as-code: a complete textbook for the engine and the hosted platform, from first installation to banner tables and report documents.
Free · revised with the beta
Worked examples, ready to run
Five Jupyter notebooks built with siamang 0.6.0, executed top to bottom with their outputs saved (tables, charts, printed results, a real local deployment with HTTP submissions). Every notebook is self-contained: codebook, questionnaire, options, theme and analysis all live in its cells: nothing to import besides the installed package.
Open the notebooks on GitHub →Questions
Is the textbook free?
Yes. The full textbook opens right from this page, free. Noncommercial use of the engine it teaches is also free; commercial use is what the plans and the commercial license cover.
Does it cover Siamang Cloud or just the engine?
Both. Parts I to IV teach the engine (authoring, deployment, data, analysis and reporting) because that is where the model is most visible. Part V (five chapters) is the user guide to the hosted platform: accounts, the web app, cloud deployment, connectors, scheduling, webhooks and plans.
Is it finished?
It is a complete manuscript, written against the current beta of the engine and revised with it. Where the underlying documentation is inconsistent the book flags the discrepancy in a note rather than silently picking a side, so what you read is what actually runs.
Do I need to know Python?
Basic familiarity with writing and running simple scripts is assumed. No prior experience with Siamang, survey software or web deployment is required; Part I takes you from installation to a working first survey.