Learn Siamang.
Build your first study.
A complete guide to the siamang engine and Siamang Cloud.
24 chapters, from your first questionnaire to deployment, analysis and reporting.
Free to read · Revised with the beta
Your pocket cookbook,
ready to run.
Five self-contained Jupyter notebooks built with siamang 0.6.0. Each includes the codebook, questionnaire, options, theme and analysis, with outputs saved from a complete run.
Open the notebooks on GitHubAbout the textbook.
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 Siamang Cloud, the hosted platform: accounts, the web app, cloud deployment, connectors, scheduling, webhooks and plans.
Does it cover Siamang Studio?
Not yet. The textbook teaches the engine and Siamang Cloud. Studio's own user guide is not published on this site yet.
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.
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.