openforma 0.4.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. openforma-0.4.0/LICENSE +373 -0
  2. openforma-0.4.0/PKG-INFO +247 -0
  3. openforma-0.4.0/README.md +169 -0
  4. openforma-0.4.0/forma_cli/__init__.py +5 -0
  5. openforma-0.4.0/forma_cli/app.py +1139 -0
  6. openforma-0.4.0/forma_cli/config.py +112 -0
  7. openforma-0.4.0/forma_cli/credentials.py +141 -0
  8. openforma-0.4.0/forma_cli/local.py +562 -0
  9. openforma-0.4.0/forma_cli/metadata_api.py +138 -0
  10. openforma-0.4.0/forma_cli/project_artifacts.py +182 -0
  11. openforma-0.4.0/forma_cli/sdk.py +571 -0
  12. openforma-0.4.0/forma_core/__init__.py +9 -0
  13. openforma-0.4.0/forma_core/__main__.py +4 -0
  14. openforma-0.4.0/forma_core/_version.py +3 -0
  15. openforma-0.4.0/forma_core/agents/__init__.py +50 -0
  16. openforma-0.4.0/forma_core/agents/clarification.py +194 -0
  17. openforma-0.4.0/forma_core/agents/component_reconciliation.py +99 -0
  18. openforma-0.4.0/forma_core/agents/context_gathering.py +115 -0
  19. openforma-0.4.0/forma_core/agents/continuous.py +537 -0
  20. openforma-0.4.0/forma_core/agents/contracts.py +247 -0
  21. openforma-0.4.0/forma_core/agents/firecrawl_mcp.py +484 -0
  22. openforma-0.4.0/forma_core/agents/lattice.py +239 -0
  23. openforma-0.4.0/forma_core/agents/orchestrator.py +3724 -0
  24. openforma-0.4.0/forma_core/agents/pipeline.py +843 -0
  25. openforma-0.4.0/forma_core/agents/project_correction.py +83 -0
  26. openforma-0.4.0/forma_core/agents/prompt_compaction.py +428 -0
  27. openforma-0.4.0/forma_core/agents/system_architecture.py +345 -0
  28. openforma-0.4.0/forma_core/agents/video_correction.py +119 -0
  29. openforma-0.4.0/forma_core/agents/web_research_workflow.py +1256 -0
  30. openforma-0.4.0/forma_core/agents/workflows.py +176 -0
  31. openforma-0.4.0/forma_core/assets/__init__.py +1 -0
  32. openforma-0.4.0/forma_core/assets/models.py +156 -0
  33. openforma-0.4.0/forma_core/assets/project.py +17 -0
  34. openforma-0.4.0/forma_core/assets/repository.py +48 -0
  35. openforma-0.4.0/forma_core/assets/service.py +142 -0
  36. openforma-0.4.0/forma_core/assets/validation.py +35 -0
  37. openforma-0.4.0/forma_core/benchmarks/__init__.py +5 -0
  38. openforma-0.4.0/forma_core/benchmarks/ir_triad_v1.py +477 -0
  39. openforma-0.4.0/forma_core/biology/__init__.py +28 -0
  40. openforma-0.4.0/forma_core/biology/benchmark.py +80 -0
  41. openforma-0.4.0/forma_core/biology/ewart_liverchip.py +279 -0
  42. openforma-0.4.0/forma_core/biology/ir.py +25 -0
  43. openforma-0.4.0/forma_core/biology/liverbench.py +416 -0
  44. openforma-0.4.0/forma_core/biology/liverbench_assay.py +251 -0
  45. openforma-0.4.0/forma_core/biology/liverbench_baselines.py +133 -0
  46. openforma-0.4.0/forma_core/biology/liverbench_independent.py +229 -0
  47. openforma-0.4.0/forma_core/biology/liverchip_demo.py +154 -0
  48. openforma-0.4.0/forma_core/biology/liverchip_evidence.py +149 -0
  49. openforma-0.4.0/forma_core/biology/models.py +247 -0
  50. openforma-0.4.0/forma_core/biology/validation.py +72 -0
  51. openforma-0.4.0/forma_core/cad_migrations/__init__.py +6 -0
  52. openforma-0.4.0/forma_core/cad_migrations/cli.py +101 -0
  53. openforma-0.4.0/forma_core/cad_migrations/emitters.py +227 -0
  54. openforma-0.4.0/forma_core/cad_migrations/models.py +121 -0
  55. openforma-0.4.0/forma_core/cad_migrations/planner.py +68 -0
  56. openforma-0.4.0/forma_core/chemistry/__init__.py +5 -0
  57. openforma-0.4.0/forma_core/chemistry/models.py +215 -0
  58. openforma-0.4.0/forma_core/chemistry/stoichiometry.py +272 -0
  59. openforma-0.4.0/forma_core/chemistry/validation.py +179 -0
  60. openforma-0.4.0/forma_core/cli/__init__.py +1 -0
  61. openforma-0.4.0/forma_core/cli/__main__.py +4 -0
  62. openforma-0.4.0/forma_core/cli/main.py +370 -0
  63. openforma-0.4.0/forma_core/config/__init__.py +28 -0
  64. openforma-0.4.0/forma_core/config/compatibility.py +282 -0
  65. openforma-0.4.0/forma_core/config/contract.py +184 -0
  66. openforma-0.4.0/forma_core/config/environment.py +129 -0
  67. openforma-0.4.0/forma_core/config/parti.py +34 -0
  68. openforma-0.4.0/forma_core/config/runtime.py +303 -0
  69. openforma-0.4.0/forma_core/control/__init__.py +10 -0
  70. openforma-0.4.0/forma_core/control/actions.py +136 -0
  71. openforma-0.4.0/forma_core/control/adapters.py +36 -0
  72. openforma-0.4.0/forma_core/control/cli.py +49 -0
  73. openforma-0.4.0/forma_core/control/client.py +124 -0
  74. openforma-0.4.0/forma_core/control/models.py +168 -0
  75. openforma-0.4.0/forma_core/control/opencode_worker.py +80 -0
  76. openforma-0.4.0/forma_core/control/package.py +318 -0
  77. openforma-0.4.0/forma_core/control/rover_scene/__init__.py +1 -0
  78. openforma-0.4.0/forma_core/control/rover_scene/__main__.py +34 -0
  79. openforma-0.4.0/forma_core/control/rover_scene/assets.py +65 -0
  80. openforma-0.4.0/forma_core/control/rover_scene/fleet.py +214 -0
  81. openforma-0.4.0/forma_core/control/rover_scene/host.py +258 -0
  82. openforma-0.4.0/forma_core/control/rover_scene/kinematics.py +35 -0
  83. openforma-0.4.0/forma_core/control/rover_scene/machine.py +347 -0
  84. openforma-0.4.0/forma_core/control/rover_scene/robot.py +166 -0
  85. openforma-0.4.0/forma_core/control/rover_scene/scene.py +206 -0
  86. openforma-0.4.0/forma_core/control/rover_scene/view.py +80 -0
  87. openforma-0.4.0/forma_core/control/rover_scene/web/index.html +25 -0
  88. openforma-0.4.0/forma_core/control/rover_scene/web/viewer.js +148 -0
  89. openforma-0.4.0/forma_core/control/runtime.py +356 -0
  90. openforma-0.4.0/forma_core/control/so101.py +235 -0
  91. openforma-0.4.0/forma_core/control/tasks.py +287 -0
  92. openforma-0.4.0/forma_core/database.py +2362 -0
  93. openforma-0.4.0/forma_core/debug.py +314 -0
  94. openforma-0.4.0/forma_core/domains/__init__.py +7 -0
  95. openforma-0.4.0/forma_core/domains/agents.py +85 -0
  96. openforma-0.4.0/forma_core/domains/base.py +69 -0
  97. openforma-0.4.0/forma_core/domains/benchmark.py +87 -0
  98. openforma-0.4.0/forma_core/domains/cli.py +48 -0
  99. openforma-0.4.0/forma_core/domains/compatibility.py +234 -0
  100. openforma-0.4.0/forma_core/domains/composition.py +372 -0
  101. openforma-0.4.0/forma_core/domains/diagnostics.py +15 -0
  102. openforma-0.4.0/forma_core/domains/generation.py +479 -0
  103. openforma-0.4.0/forma_core/domains/interaction.py +301 -0
  104. openforma-0.4.0/forma_core/domains/planning.py +140 -0
  105. openforma-0.4.0/forma_core/domains/providers.py +214 -0
  106. openforma-0.4.0/forma_core/domains/registry.py +267 -0
  107. openforma-0.4.0/forma_core/domains/selection.py +75 -0
  108. openforma-0.4.0/forma_core/domains/storage.py +60 -0
  109. openforma-0.4.0/forma_core/domains/tools.py +180 -0
  110. openforma-0.4.0/forma_core/electronics/__init__.py +1 -0
  111. openforma-0.4.0/forma_core/electronics/models.py +84 -0
  112. openforma-0.4.0/forma_core/electronics/primitives.py +43 -0
  113. openforma-0.4.0/forma_core/electronics/rules.py +340 -0
  114. openforma-0.4.0/forma_core/external_sources.py +497 -0
  115. openforma-0.4.0/forma_core/fabricator/__init__.py +33 -0
  116. openforma-0.4.0/forma_core/fabricator/__main__.py +7 -0
  117. openforma-0.4.0/forma_core/fabricator/main.py +578 -0
  118. openforma-0.4.0/forma_core/firmware/__init__.py +60 -0
  119. openforma-0.4.0/forma_core/firmware/drivers.py +140 -0
  120. openforma-0.4.0/forma_core/firmware/examples.py +503 -0
  121. openforma-0.4.0/forma_core/firmware/generate.py +520 -0
  122. openforma-0.4.0/forma_core/firmware/models.py +34 -0
  123. openforma-0.4.0/forma_core/firmware/sil/__init__.py +5 -0
  124. openforma-0.4.0/forma_core/firmware/sil/adapter.py +71 -0
  125. openforma-0.4.0/forma_core/firmware/sil/build.py +49 -0
  126. openforma-0.4.0/forma_core/firmware/sil/native/CMakeLists.txt +9 -0
  127. openforma-0.4.0/forma_core/firmware/sil/native/bridge.cpp +112 -0
  128. openforma-0.4.0/forma_core/firmware/sil/native/controller.cpp +123 -0
  129. openforma-0.4.0/forma_core/firmware/sil/native/controller.h +49 -0
  130. openforma-0.4.0/forma_core/firmware/sil/simulator.py +139 -0
  131. openforma-0.4.0/forma_core/firmware/targets.py +111 -0
  132. openforma-0.4.0/forma_core/firmware/validation.py +130 -0
  133. openforma-0.4.0/forma_core/fluidics/__init__.py +6 -0
  134. openforma-0.4.0/forma_core/fluidics/benchmark.py +217 -0
  135. openforma-0.4.0/forma_core/fluidics/calculations.py +79 -0
  136. openforma-0.4.0/forma_core/fluidics/examples.py +54 -0
  137. openforma-0.4.0/forma_core/fluidics/ir.py +25 -0
  138. openforma-0.4.0/forma_core/fluidics/models.py +132 -0
  139. openforma-0.4.0/forma_core/fluidics/topology.py +47 -0
  140. openforma-0.4.0/forma_core/fluidics/validation.py +134 -0
  141. openforma-0.4.0/forma_core/generation.py +32 -0
  142. openforma-0.4.0/forma_core/geometry_bindings/__init__.py +20 -0
  143. openforma-0.4.0/forma_core/geometry_bindings/cad_adapter.py +80 -0
  144. openforma-0.4.0/forma_core/geometry_bindings/models.py +163 -0
  145. openforma-0.4.0/forma_core/geometry_bindings/resolution.py +340 -0
  146. openforma-0.4.0/forma_core/geometry_bindings/tools.py +125 -0
  147. openforma-0.4.0/forma_core/image_providers.py +3049 -0
  148. openforma-0.4.0/forma_core/images.py +3 -0
  149. openforma-0.4.0/forma_core/integrations/__init__.py +1 -0
  150. openforma-0.4.0/forma_core/integrations/huggingface/__init__.py +29 -0
  151. openforma-0.4.0/forma_core/integrations/huggingface/huggingface_artifacts.py +272 -0
  152. openforma-0.4.0/forma_core/jobs/__init__.py +1 -0
  153. openforma-0.4.0/forma_core/jobs/context.py +277 -0
  154. openforma-0.4.0/forma_core/jobs/continuous.py +719 -0
  155. openforma-0.4.0/forma_core/jobs/metrics.py +124 -0
  156. openforma-0.4.0/forma_core/jobs/migrations.py +161 -0
  157. openforma-0.4.0/forma_core/jobs/persistence.py +28 -0
  158. openforma-0.4.0/forma_core/jobs/repositories.py +422 -0
  159. openforma-0.4.0/forma_core/jobs/schema.py +28 -0
  160. openforma-0.4.0/forma_core/jobs/source_usage.py +230 -0
  161. openforma-0.4.0/forma_core/jobs/store.py +476 -0
  162. openforma-0.4.0/forma_core/llm.py +3 -0
  163. openforma-0.4.0/forma_core/llm_providers.py +2682 -0
  164. openforma-0.4.0/forma_core/logs.py +107 -0
  165. openforma-0.4.0/forma_core/mechanics/__init__.py +1 -0
  166. openforma-0.4.0/forma_core/mechanics/gear_benchmark.py +85 -0
  167. openforma-0.4.0/forma_core/mechanics/mechanism_benchmarks.py +345 -0
  168. openforma-0.4.0/forma_core/mechanics/models.py +72 -0
  169. openforma-0.4.0/forma_core/mechanics/primitives.py +109 -0
  170. openforma-0.4.0/forma_core/mechanics/solid_cad.py +83 -0
  171. openforma-0.4.0/forma_core/observability.py +237 -0
  172. openforma-0.4.0/forma_core/openai_streams.py +780 -0
  173. openforma-0.4.0/forma_core/opencode/__init__.py +25 -0
  174. openforma-0.4.0/forma_core/opencode/architecture.py +82 -0
  175. openforma-0.4.0/forma_core/opencode/capabilities.py +130 -0
  176. openforma-0.4.0/forma_core/opencode/models.py +419 -0
  177. openforma-0.4.0/forma_core/opencode/persistence.py +62 -0
  178. openforma-0.4.0/forma_core/opencode/public_events.py +91 -0
  179. openforma-0.4.0/forma_core/opencode/schema.py +28 -0
  180. openforma-0.4.0/forma_core/opencode/store.py +874 -0
  181. openforma-0.4.0/forma_core/persistence/__init__.py +16 -0
  182. openforma-0.4.0/forma_core/persistence/base.py +38 -0
  183. openforma-0.4.0/forma_core/persistence/images.py +598 -0
  184. openforma-0.4.0/forma_core/persistence/migrations.py +200 -0
  185. openforma-0.4.0/forma_core/persistence/models.py +439 -0
  186. openforma-0.4.0/forma_core/persistence/project_artifacts.py +341 -0
  187. openforma-0.4.0/forma_core/persistence/project_reconciliation.py +1094 -0
  188. openforma-0.4.0/forma_core/persistence/providers/__init__.py +4 -0
  189. openforma-0.4.0/forma_core/persistence/providers/sqlite.py +114 -0
  190. openforma-0.4.0/forma_core/persistence/providers/supabase.py +31 -0
  191. openforma-0.4.0/forma_core/persistence/repositories/__init__.py +9 -0
  192. openforma-0.4.0/forma_core/persistence/repositories/base.py +335 -0
  193. openforma-0.4.0/forma_core/persistence/repositories/sqlite.py +1571 -0
  194. openforma-0.4.0/forma_core/persistence/repositories/supabase.py +1576 -0
  195. openforma-0.4.0/forma_core/persistence/schema.py +176 -0
  196. openforma-0.4.0/forma_core/processes/__init__.py +5 -0
  197. openforma-0.4.0/forma_core/processes/models.py +338 -0
  198. openforma-0.4.0/forma_core/processes/validation.py +141 -0
  199. openforma-0.4.0/forma_core/project_list_cache.py +316 -0
  200. openforma-0.4.0/forma_core/prompt_continuity.py +387 -0
  201. openforma-0.4.0/forma_core/providers/__init__.py +39 -0
  202. openforma-0.4.0/forma_core/providers/base.py +28 -0
  203. openforma-0.4.0/forma_core/providers/models.py +138 -0
  204. openforma-0.4.0/forma_core/providers/openai.py +92 -0
  205. openforma-0.4.0/forma_core/providers/openai_compatible.py +190 -0
  206. openforma-0.4.0/forma_core/providers/registry.py +68 -0
  207. openforma-0.4.0/forma_core/providers/registry_utils.py +46 -0
  208. openforma-0.4.0/forma_core/py.typed +1 -0
  209. openforma-0.4.0/forma_core/runtime.py +3 -0
  210. openforma-0.4.0/forma_core/selectors.py +36 -0
  211. openforma-0.4.0/forma_core/signups/__init__.py +5 -0
  212. openforma-0.4.0/forma_core/signups/models.py +49 -0
  213. openforma-0.4.0/forma_core/terminal/__init__.py +1 -0
  214. openforma-0.4.0/forma_core/terminal/dashboard.py +475 -0
  215. openforma-0.4.0/forma_core/terminal/images.py +156 -0
  216. openforma-0.4.0/forma_core/thermal/__init__.py +5 -0
  217. openforma-0.4.0/forma_core/thermal/models.py +361 -0
  218. openforma-0.4.0/forma_core/thermal/validation.py +175 -0
  219. openforma-0.4.0/forma_core/user_integrations.py +2069 -0
  220. openforma-0.4.0/forma_core/utils.py +291 -0
  221. openforma-0.4.0/forma_core/validation.py +83 -0
  222. openforma-0.4.0/forma_core/vertex_auth.py +92 -0
  223. openforma-0.4.0/forma_core/video_prompts.py +193 -0
  224. openforma-0.4.0/forma_core/video_review.py +1006 -0
  225. openforma-0.4.0/forma_core/wiring.py +356 -0
  226. openforma-0.4.0/forma_core/workers/__init__.py +120 -0
  227. openforma-0.4.0/forma_core/workers/contracts.py +183 -0
  228. openforma-0.4.0/forma_core/workers/generation.py +753 -0
  229. openforma-0.4.0/forma_core/workers/orchestration.py +805 -0
  230. openforma-0.4.0/forma_core/workers/registry.py +222 -0
  231. openforma-0.4.0/forma_core/workers/reverse_engineering.py +272 -0
  232. openforma-0.4.0/forma_core/workers/validation.py +291 -0
  233. openforma-0.4.0/forma_core/workspaces/__init__.py +5 -0
  234. openforma-0.4.0/forma_core/workspaces/chats/__init__.py +11 -0
  235. openforma-0.4.0/forma_core/workspaces/chats/models.py +48 -0
  236. openforma-0.4.0/forma_core/workspaces/context/__init__.py +15 -0
  237. openforma-0.4.0/forma_core/workspaces/context/agent.py +260 -0
  238. openforma-0.4.0/forma_core/workspaces/context/models.py +117 -0
  239. openforma-0.4.0/forma_core/workspaces/context/pdf.py +418 -0
  240. openforma-0.4.0/forma_core/workspaces/design_briefs/__init__.py +25 -0
  241. openforma-0.4.0/forma_core/workspaces/design_briefs/models.py +85 -0
  242. openforma-0.4.0/forma_core/workspaces/design_briefs/references.py +56 -0
  243. openforma-0.4.0/forma_core/workspaces/models.py +41 -0
  244. openforma-0.4.0/forma_core/workspaces/projects/__init__.py +88 -0
  245. openforma-0.4.0/forma_core/workspaces/projects/cad_generation.py +1016 -0
  246. openforma-0.4.0/forma_core/workspaces/projects/context_governance.py +365 -0
  247. openforma-0.4.0/forma_core/workspaces/projects/design_lifecycle.py +668 -0
  248. openforma-0.4.0/forma_core/workspaces/projects/fabrication/__init__.py +54 -0
  249. openforma-0.4.0/forma_core/workspaces/projects/fabrication/demo_printers.py +236 -0
  250. openforma-0.4.0/forma_core/workspaces/projects/fabrication/models.py +120 -0
  251. openforma-0.4.0/forma_core/workspaces/projects/fabrication/printer_config.py +205 -0
  252. openforma-0.4.0/forma_core/workspaces/projects/fabrication/slicers/__init__.py +7 -0
  253. openforma-0.4.0/forma_core/workspaces/projects/fabrication/slicers/base.py +25 -0
  254. openforma-0.4.0/forma_core/workspaces/projects/fabrication/slicers/cura.py +125 -0
  255. openforma-0.4.0/forma_core/workspaces/projects/fabrication/slicers/orca.py +208 -0
  256. openforma-0.4.0/forma_core/workspaces/projects/fabrication/slicing.py +202 -0
  257. openforma-0.4.0/forma_core/workspaces/projects/fabrication/validation.py +103 -0
  258. openforma-0.4.0/forma_core/workspaces/projects/gear_benchmark.py +6 -0
  259. openforma-0.4.0/forma_core/workspaces/projects/generation_mode.py +70 -0
  260. openforma-0.4.0/forma_core/workspaces/projects/identity.py +28 -0
  261. openforma-0.4.0/forma_core/workspaces/projects/iteration.py +680 -0
  262. openforma-0.4.0/forma_core/workspaces/projects/manifest.py +362 -0
  263. openforma-0.4.0/forma_core/workspaces/projects/mechanism_benchmarks.py +12 -0
  264. openforma-0.4.0/forma_core/workspaces/projects/models.py +913 -0
  265. openforma-0.4.0/forma_core/workspaces/projects/objects.py +731 -0
  266. openforma-0.4.0/forma_core/workspaces/projects/outcomes.py +47 -0
  267. openforma-0.4.0/forma_core/workspaces/projects/output.py +735 -0
  268. openforma-0.4.0/forma_core/workspaces/projects/resolver.py +397 -0
  269. openforma-0.4.0/forma_core/workspaces/projects/solid_cad.py +8 -0
  270. openforma-0.4.0/forma_core/workspaces/projects/state.py +622 -0
  271. openforma-0.4.0/forma_core/workspaces/readiness/__init__.py +28 -0
  272. openforma-0.4.0/forma_core/workspaces/readiness/evaluator.py +103 -0
  273. openforma-0.4.0/forma_core/workspaces/readiness/models.py +97 -0
  274. openforma-0.4.0/forma_core/workspaces/readiness/service.py +225 -0
  275. openforma-0.4.0/forma_core/workspaces/reverse_engineering/__init__.py +37 -0
  276. openforma-0.4.0/forma_core/workspaces/reverse_engineering/analyzer.py +246 -0
  277. openforma-0.4.0/forma_core/workspaces/reverse_engineering/models.py +128 -0
  278. openforma-0.4.0/forma_core/workspaces/validation/__init__.py +37 -0
  279. openforma-0.4.0/forma_core/workspaces/validation/evaluator.py +327 -0
  280. openforma-0.4.0/forma_core/workspaces/validation/models.py +146 -0
  281. openforma-0.4.0/forma_core/workspaces/validation/service.py +212 -0
  282. openforma-0.4.0/forma_core/workspaces/workflow/__init__.py +29 -0
  283. openforma-0.4.0/forma_core/workspaces/workflow/guard.py +33 -0
  284. openforma-0.4.0/forma_core/workspaces/workflow/models.py +77 -0
  285. openforma-0.4.0/forma_core/workspaces/workflow/service.py +287 -0
  286. openforma-0.4.0/openforma.egg-info/PKG-INFO +247 -0
  287. openforma-0.4.0/openforma.egg-info/SOURCES.txt +291 -0
  288. openforma-0.4.0/openforma.egg-info/dependency_links.txt +1 -0
  289. openforma-0.4.0/openforma.egg-info/entry_points.txt +4 -0
  290. openforma-0.4.0/openforma.egg-info/requires.txt +69 -0
  291. openforma-0.4.0/openforma.egg-info/top_level.txt +2 -0
  292. openforma-0.4.0/pyproject.toml +108 -0
  293. openforma-0.4.0/setup.cfg +4 -0
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
@@ -0,0 +1,247 @@
1
+ Metadata-Version: 2.4
2
+ Name: openforma
3
+ Version: 0.4.0
4
+ Summary: Reusable generation, validation, provider, and project-object core for Forma OSS.
5
+ Author-email: "CAID TECHNOLOGIES, INC." <team@caid-technologies.com>
6
+ Maintainer-email: "CAID TECHNOLOGIES, INC." <team@caid-technologies.com>
7
+ Project-URL: Homepage, https://github.com/Mapped-Assembly/OpenForma
8
+ Project-URL: Repository, https://github.com/Mapped-Assembly/OpenForma
9
+ Project-URL: Documentation, https://github.com/Mapped-Assembly/OpenForma#readme
10
+ Keywords: hardware,eda,llm,agents,pydantic
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
17
+ Classifier: Typing :: Typed
18
+ Requires-Python: >=3.11
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: google-auth>=2.29.0
22
+ Requires-Dist: json-repair>=0.30.0
23
+ Requires-Dist: keyring>=25.0.0
24
+ Requires-Dist: pydantic>=2.12.0
25
+ Requires-Dist: python-dotenv>=1.0.1
26
+ Requires-Dist: pypdf>=5.0.0
27
+ Requires-Dist: pypdfium2>=4.30.0
28
+ Requires-Dist: sqlalchemy==2.0.31
29
+ Provides-Extra: gemini
30
+ Requires-Dist: google-genai>=1.0.0; extra == "gemini"
31
+ Provides-Extra: vertex
32
+ Requires-Dist: google-auth>=2.29.0; extra == "vertex"
33
+ Requires-Dist: google-genai>=1.0.0; extra == "vertex"
34
+ Provides-Extra: huggingface
35
+ Requires-Dist: huggingface-hub>=0.34.0; extra == "huggingface"
36
+ Provides-Extra: observability
37
+ Requires-Dist: langfuse>=4.0.0; extra == "observability"
38
+ Provides-Extra: supabase
39
+ Requires-Dist: supabase==2.31.0; extra == "supabase"
40
+ Provides-Extra: tavily
41
+ Requires-Dist: tavily-python>=0.5.0; extra == "tavily"
42
+ Provides-Extra: terminal
43
+ Requires-Dist: Pillow>=10.0.0; extra == "terminal"
44
+ Provides-Extra: control
45
+ Requires-Dist: fastapi>=0.124.1; extra == "control"
46
+ Requires-Dist: uvicorn; extra == "control"
47
+ Requires-Dist: websockets>=12.0; extra == "control"
48
+ Provides-Extra: robot-sim
49
+ Requires-Dist: mujoco==3.3.7; extra == "robot-sim"
50
+ Provides-Extra: backend
51
+ Requires-Dist: fastapi>=0.124.1; extra == "backend"
52
+ Requires-Dist: cryptography>=42.0.0; extra == "backend"
53
+ Requires-Dist: Pillow>=10.0.0; extra == "backend"
54
+ Requires-Dist: pypdf>=5.0.0; extra == "backend"
55
+ Requires-Dist: redis>=5.0.0; extra == "backend"
56
+ Requires-Dist: uvicorn; extra == "backend"
57
+ Requires-Dist: websockets>=12.0; extra == "backend"
58
+ Requires-Dist: supabase==2.31.0; extra == "backend"
59
+ Provides-Extra: s3
60
+ Requires-Dist: boto3==1.35.99; extra == "s3"
61
+ Provides-Extra: all
62
+ Requires-Dist: google-genai>=1.0.0; extra == "all"
63
+ Requires-Dist: boto3==1.35.99; extra == "all"
64
+ Requires-Dist: cryptography>=42.0.0; extra == "all"
65
+ Requires-Dist: fastapi>=0.124.1; extra == "all"
66
+ Requires-Dist: huggingface-hub>=0.34.0; extra == "all"
67
+ Requires-Dist: langfuse>=4.0.0; extra == "all"
68
+ Requires-Dist: Pillow>=10.0.0; extra == "all"
69
+ Requires-Dist: pypdf>=5.0.0; extra == "all"
70
+ Requires-Dist: redis>=5.0.0; extra == "all"
71
+ Requires-Dist: supabase==2.31.0; extra == "all"
72
+ Requires-Dist: tavily-python>=0.5.0; extra == "all"
73
+ Requires-Dist: uvicorn; extra == "all"
74
+ Requires-Dist: websockets>=12.0; extra == "all"
75
+ Provides-Extra: dev
76
+ Requires-Dist: build>=1.2.0; extra == "dev"
77
+ Dynamic: license-file
78
+
79
+ # OpenForma
80
+
81
+ **Describe a physical system; generate its engineering domains.**
82
+
83
+ OpenForma selects independently owned MechanicalIR, ElectricalIR, BiologicalIR,
84
+ FluidicIR, ChemicalIR, ProcessIR and ThermalIR artifacts according to requested
85
+ scope. The standard generation entry point returns portable artifacts, typed
86
+ relationships, supported checks, assumptions and unresolved information. Existing
87
+ HardwareIR projects keep their compatibility workflows.
88
+
89
+ See [unified generation and the architecture audit](docs/unified-generation.md)
90
+ for usage, the chemistry-first benchmark and explicit validation limits.
91
+
92
+ [![License: MPL 2.0](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](LICENSE)
93
+ [![PyPI](https://img.shields.io/pypi/v/openforma.svg)](https://pypi.org/project/openforma/)
94
+ [![GitHub stars](https://img.shields.io/github/stars/caid-technologies/Forma-OSS?style=social)](https://github.com/caid-technologies/Forma-OSS)
95
+
96
+ **[Try Form](https://caid-technologies.us/)** · [Browse projects](https://caid-technologies.us/projects) · [Run locally](#quick-start) · [Documentation](docs/README.md)
97
+
98
+ ## See it in action
99
+
100
+ Mechanical design and motion previews:
101
+
102
+ | Hexapod walking | Screw-driven arm | Robotic 3D printer |
103
+ | --- | --- | --- |
104
+ | ![Top view of a six-legged hexapod walking](docs/assets/hexapod-walk-top.gif) | ![Screw-driven robotic arm approaching a part](docs/assets/screw-arm-drive.gif) | ![Robotic printer arm moving over a print bed](docs/assets/print-arm-print.gif) |
105
+
106
+ [Watch the full walkthrough: designing a security camera →](https://www.youtube.com/watch?v=XaIIJT7OX4M)
107
+
108
+ <details>
109
+ <summary>Preview the security camera workflow</summary>
110
+
111
+ [![Form workflow creating a security camera](docs/assets/forma-security-camera-demo.gif)](https://www.youtube.com/watch?v=XaIIJT7OX4M)
112
+
113
+ </details>
114
+
115
+ ## What you can build
116
+
117
+ - **CAD you can take with you.** Preview mechanical designs in 3D and export STEP, STL, 3MF, and OBJ from supported native CAD builds.
118
+ - **Electronics with the details attached.** Generate a bill of materials, interactive wiring diagrams, and assembly instructions. Rule-based checks flag shorts, voltage mismatches, pin conflicts, and other electrical issues.
119
+ - **Designs you can keep refining.** Use follow-up instructions to change geometry, dimensions, placement, and requirements within an existing project.
120
+ - **Mechanisms you can inspect.** Play, pause, and scrub supported joint-driven motion previews, including the [two meshing gears example](docs/gear-motion-preview.md).
121
+ - **Machines you can control.** Try the [local Control Studio](examples/control_studio/README.md): keyboard/joystick inputs, an agent API, and a reusable multi-axis runtime demonstrated by a servo gate and two-axis XY stage.
122
+ - **Hardware workflows for your agents.** Use Forma through the web app, Python package, CLI, or MCP. The shared skill works with OpenCode, Claude Code, Codex, OpenClaw, and NemoClaw.
123
+
124
+ Forma is an **alpha research prototype** for makers and developers. Electrical validation focuses on 3.3–5 V educational projects; CAD and motion previews still need engineering review before fabrication. See [scope and validation](docs/validation.md).
125
+
126
+ ## Quick start
127
+
128
+ Use [Form in your browser](https://caid-technologies.us/), or run it locally with OpenCode. Local authoring, validation, rendering, and project status do not require a Forma account.
129
+
130
+ ### Run locally with OpenCode
131
+
132
+ You need **Python 3.11+**, **Node.js and npm** (Node.js 22+ recommended), **Git**, and **OpenCode** with a working model connection. Your model provider's usage charges still apply.
133
+
134
+ **macOS / Linux**
135
+
136
+ ```bash
137
+ curl --proto '=https' --tlsv1.2 -fsSL https://raw.githubusercontent.com/caid-technologies/Forma-OSS/main/scripts/development/install-opencode.sh | bash
138
+ ```
139
+
140
+ **Windows PowerShell**
141
+
142
+ ```powershell
143
+ irm https://raw.githubusercontent.com/caid-technologies/Forma-OSS/main/scripts/development/install-opencode.ps1 | iex
144
+ ```
145
+
146
+ The installer creates `~/forma-workspace`, adds the Forma skill and MCP connection, installs missing app dependencies, and starts the backend and frontend. Keep that terminal open, then open a second terminal:
147
+
148
+ ```sh
149
+ cd ~/forma-workspace
150
+ opencode mcp list
151
+ opencode
152
+ ```
153
+
154
+ Try a first prompt:
155
+
156
+ > Design a 3.3 V temperature monitor with an OLED display. Include a bill of materials, wiring, and an enclosure.
157
+
158
+ Open the local UI at [localhost:3000](http://localhost:3000). CAD generation and exports also require the [native OpenCAD setup](docs/agent-clients.md#cad-skill-dependency). For installation details and troubleshooting, see the [setup guide](docs/setup.md).
159
+
160
+ <details>
161
+ <summary>Develop from source, use Docker, or install the Python core</summary>
162
+
163
+ Clone the repository and start the app:
164
+
165
+ ```bash
166
+ git clone https://github.com/caid-technologies/Forma-OSS.git
167
+ cd Forma-OSS
168
+ ./scripts/development/dev.sh
169
+ ```
170
+
171
+ On Windows, replace the last command with `.\scripts\development\dev.ps1`.
172
+
173
+ The launcher starts the API and UI with local authentication and SQLite. Configure an [agent connection](docs/agent-clients.md) or a [model provider](docs/runtime-reference.md#shared-llm-configuration) for live generation.
174
+
175
+ For Docker, run `docker compose up --build` from the repository root. See [Docker setup](docs/setup.md#docker-setup) for configuration and persistence.
176
+
177
+ For the reusable Python core and CLIs:
178
+
179
+ ```bash
180
+ pip install openforma
181
+ forma-core --help
182
+ forma-oss --help
183
+ ```
184
+
185
+ See the [CLI and runtime reference](docs/runtime-reference.md) for generation, iteration, local credentials, and cloud sync.
186
+
187
+ </details>
188
+
189
+ ### Publishing packages
190
+
191
+ This repository publishes its existing package identities from a GitHub Release:
192
+
193
+ - `openforma` is built from the root `pyproject.toml` and published to PyPI.
194
+ - `@isayahc/forma-gui` is built from `packages/forma-gui` and published to npm.
195
+
196
+ The `Publish packages` workflow validates both distributions before publishing. Configure the repository `NPM_TOKEN` secret and the PyPI trusted publisher for the `pypi` environment before creating a release. Update the package version in its own metadata, then publish a matching GitHub Release.
197
+
198
+ ## Install Forma for Cursor / Grok Bot
199
+
200
+ Install the [Cursor plugin](docs/cursor-plugin.md) to discover the shared
201
+ `forma-hardware` skill and local Streamable HTTP MCP connection. The guide covers
202
+ local installation, protected cloud authentication, CLI-only use, and compatible
203
+ Grok Bot deployments. Marketplace publication requires a separate maintainer
204
+ submission and review; the repository includes the packaging and checklist.
205
+
206
+ ## How it works
207
+
208
+ 1. **Describe the project.** Start with requirements and optional reference images; refine the design through conversation.
209
+ 2. **Author a structured design.** An agent produces [Hardware Intermediate Representation](docs/hardware-ir.md), Forma's typed, versioned representation of components, connections, geometry, and project history.
210
+ 3. **Compile and inspect.** Forma validates the design and produces schematics, previews, and supported CAD artifacts. Iterate on the saved project as your requirements change.
211
+
212
+ With the local agent workflow, your host agent supplies the model and Forma performs deterministic compilation. The reusable `forma_core` package also supports server-side generation. See [architecture](docs/architecture.md) and [agent integrations](docs/agent-clients.md).
213
+
214
+ ## Go deeper
215
+
216
+ | I want to… | Start here |
217
+ | --- | --- |
218
+ | Install or self-host Form | [Setup](docs/setup.md) · [CLI and runtime reference](docs/runtime-reference.md) |
219
+ | Connect my own agent | [Agent integrations](docs/agent-clients.md) · [Model and image configuration](docs/opencode-models-and-images.md) |
220
+ | Understand the project format | [Hardware Intermediate Representation](docs/hardware-ir.md) · [Architecture](docs/architecture.md) |
221
+ | Explore examples and motion | [Examples](docs/examples.md) · [Gear motion preview](docs/gear-motion-preview.md) |
222
+ | Reconstruct CAD history in Onshape, NX, or Fusion | [AI-assisted CAD migrations](docs/ai-cad-migrations.md) |
223
+ | Contribute or evaluate results | [Contributing](CONTRIBUTING.md) · [Development](docs/development.md) · [Evaluations](evals/README.md) |
224
+
225
+ [All documentation](docs/README.md) · [Roadmap](docs/roadmap.md) · [Report a bug](https://github.com/caid-technologies/Forma-OSS/issues/new/choose)
226
+
227
+ ## Build with us
228
+
229
+ Try a design, share what worked, or help improve CAD generation, validation, examples, and the interface. Read [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution workflow.
230
+
231
+ **If you want open-source hardware design to be easier, star Forma to follow its progress and help other builders find it.**
232
+
233
+ Built by [Caid Technologies](https://caid-technologies.us/). Licensed under the [Mozilla Public License 2.0](LICENSE).
234
+
235
+ ## Citation
236
+
237
+ If you use Forma-OSS in research, publications, or other academic work, please cite the project:
238
+
239
+ ```bibtex
240
+ @software{mapped_assembly_forma_oss_2026,
241
+ author = {{Mapped Assembly}},
242
+ title = {Forma-OSS: Open-source AI hardware design workspace},
243
+ year = {2026},
244
+ url = {https://github.com/Mapped-Assembly/forma-oss},
245
+ note = {Open-source software}
246
+ }
247
+ ```