OpenCADIrrigation Open the app

OpenCADIrrigation manual

How the app works, chapter by chapter. The README says what OpenCADIrrigation is; this manual is maintained in English, with a Portuguese translation in pt-BR/. Contributing, the editorial rule and the release checklist are in CONTRIBUTING.md.

  1. Five-minute start: open the app, the example gallery, the URL parameters
  2. Design workflow: from the area to the reports, step by step
  3. Interface: layout, menus, compact layout and keyboard shortcuts
  4. Drawing and editing: entities, snaps, selection, transformations, blocks, layers
  5. Hydraulic network: hydraulic items, connection rules, generators, automatic design
  6. Component catalogue: pipes, emitters, valves, pumps, prices and manufacturer packs
  7. Terrain: contours, spot heights, the terrain model, online elevation
  8. Calculation and sizing: parameters, calculation steps, design check and assistant, analyses
  9. Agronomy and irrigation scheduling: daily water balance, irrigation programme, runoff, fertigation by stage, field uniformity, user crops
  10. Power, water and machines: pump house electrics, solar pumping, water quality, two-wire, several pivots, travellers and furrows
  11. AI assistant: what the optional assistant does, what it sends and how it is controlled
  12. Reports, plotting and export: reports panel, PDF sheets, quote, exports
  13. Title block and technical documents: title block, datum, document packages, permit table, memorial, O&M plan, budget, life-cycle cost
  14. File formats: the project file and every import and export format
  15. Storage, privacy and network access: what stays in the browser, what goes out and to whom
  16. Languages and site: the 20 languages, the site, the offline start and the hosting
  17. Code architecture: the source tree and the design decisions
  18. Development and tests: commands, how to extend, what every test guarantees
  19. Known limitations and roadmap: what the app does not do yet
  20. References: standards, books and papers behind the engine
  21. Licence, third-party components and data: MIT licence, the components and the data sources

The technical study behind the engine is docs/TECHNICAL_STUDY.md; the engine API is docs/API.md.