urika 0.1.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 (161) hide show
  1. urika-0.1.0/.github/workflows/workflow.yml +51 -0
  2. urika-0.1.0/.gitignore +34 -0
  3. urika-0.1.0/CHANGELOG.md +30 -0
  4. urika-0.1.0/LICENSE +190 -0
  5. urika-0.1.0/PKG-INFO +257 -0
  6. urika-0.1.0/README.md +182 -0
  7. urika-0.1.0/docs/01-getting-started.md +220 -0
  8. urika-0.1.0/docs/02-core-concepts.md +220 -0
  9. urika-0.1.0/docs/03-creating-projects.md +277 -0
  10. urika-0.1.0/docs/04-prompts-and-context.md +271 -0
  11. urika-0.1.0/docs/05-running-experiments.md +404 -0
  12. urika-0.1.0/docs/06-advisor-and-instructions.md +356 -0
  13. urika-0.1.0/docs/07-viewing-results.md +199 -0
  14. urika-0.1.0/docs/08-finalizing-projects.md +147 -0
  15. urika-0.1.0/docs/09-agent-system.md +323 -0
  16. urika-0.1.0/docs/10-built-in-tools.md +433 -0
  17. urika-0.1.0/docs/11-knowledge-pipeline.md +168 -0
  18. urika-0.1.0/docs/12-models-and-privacy.md +460 -0
  19. urika-0.1.0/docs/13-configuration.md +302 -0
  20. urika-0.1.0/docs/14-project-structure.md +231 -0
  21. urika-0.1.0/docs/15-cli-reference.md +757 -0
  22. urika-0.1.0/docs/16-interactive-repl.md +187 -0
  23. urika-0.1.0/docs/17-notifications.md +378 -0
  24. urika-0.1.0/docs/README.md +21 -0
  25. urika-0.1.0/docs/assets/header.png +0 -0
  26. urika-0.1.0/docs/assets/header.svg +13 -0
  27. urika-0.1.0/pyproject.toml +82 -0
  28. urika-0.1.0/src/urika/README.md +20 -0
  29. urika-0.1.0/src/urika/__init__.py +8 -0
  30. urika-0.1.0/src/urika/__main__.py +5 -0
  31. urika-0.1.0/src/urika/agents/__init__.py +27 -0
  32. urika-0.1.0/src/urika/agents/adapters/__init__.py +0 -0
  33. urika-0.1.0/src/urika/agents/adapters/claude_sdk.py +148 -0
  34. urika-0.1.0/src/urika/agents/config.py +254 -0
  35. urika-0.1.0/src/urika/agents/prompt.py +35 -0
  36. urika-0.1.0/src/urika/agents/registry.py +36 -0
  37. urika-0.1.0/src/urika/agents/roles/__init__.py +0 -0
  38. urika-0.1.0/src/urika/agents/roles/advisor_agent.py +55 -0
  39. urika-0.1.0/src/urika/agents/roles/data_agent.py +62 -0
  40. urika-0.1.0/src/urika/agents/roles/echo.py +37 -0
  41. urika-0.1.0/src/urika/agents/roles/evaluator.py +55 -0
  42. urika-0.1.0/src/urika/agents/roles/finalizer.py +56 -0
  43. urika-0.1.0/src/urika/agents/roles/literature_agent.py +99 -0
  44. urika-0.1.0/src/urika/agents/roles/planning_agent.py +55 -0
  45. urika-0.1.0/src/urika/agents/roles/presentation_agent.py +57 -0
  46. urika-0.1.0/src/urika/agents/roles/project_builder.py +52 -0
  47. urika-0.1.0/src/urika/agents/roles/prompts/.gitkeep +0 -0
  48. urika-0.1.0/src/urika/agents/roles/prompts/advisor_agent_system.md +95 -0
  49. urika-0.1.0/src/urika/agents/roles/prompts/data_agent_system.md +38 -0
  50. urika-0.1.0/src/urika/agents/roles/prompts/echo_system.md +13 -0
  51. urika-0.1.0/src/urika/agents/roles/prompts/evaluator_system.md +121 -0
  52. urika-0.1.0/src/urika/agents/roles/prompts/finalizer_system.md +132 -0
  53. urika-0.1.0/src/urika/agents/roles/prompts/literature_agent_system.md +57 -0
  54. urika-0.1.0/src/urika/agents/roles/prompts/planning_agent_system.md +81 -0
  55. urika-0.1.0/src/urika/agents/roles/prompts/presentation_agent_system.md +95 -0
  56. urika-0.1.0/src/urika/agents/roles/prompts/project_builder_system.md +69 -0
  57. urika-0.1.0/src/urika/agents/roles/prompts/report_agent_system.md +75 -0
  58. urika-0.1.0/src/urika/agents/roles/prompts/task_agent_system.md +98 -0
  59. urika-0.1.0/src/urika/agents/roles/prompts/tool_builder_system.md +124 -0
  60. urika-0.1.0/src/urika/agents/roles/report_agent.py +55 -0
  61. urika-0.1.0/src/urika/agents/roles/task_agent.py +57 -0
  62. urika-0.1.0/src/urika/agents/roles/tool_builder.py +54 -0
  63. urika-0.1.0/src/urika/agents/runner.py +57 -0
  64. urika-0.1.0/src/urika/cli.py +5143 -0
  65. urika-0.1.0/src/urika/cli_display.py +967 -0
  66. urika-0.1.0/src/urika/cli_helpers.py +155 -0
  67. urika-0.1.0/src/urika/core/__init__.py +0 -0
  68. urika-0.1.0/src/urika/core/builder_prompts.py +150 -0
  69. urika-0.1.0/src/urika/core/criteria.py +112 -0
  70. urika-0.1.0/src/urika/core/experiment.py +133 -0
  71. urika-0.1.0/src/urika/core/filelock.py +47 -0
  72. urika-0.1.0/src/urika/core/hardware.py +139 -0
  73. urika-0.1.0/src/urika/core/labbook.py +383 -0
  74. urika-0.1.0/src/urika/core/method_registry.py +108 -0
  75. urika-0.1.0/src/urika/core/models.py +184 -0
  76. urika-0.1.0/src/urika/core/presentation.py +249 -0
  77. urika-0.1.0/src/urika/core/progress.py +85 -0
  78. urika-0.1.0/src/urika/core/project_builder.py +260 -0
  79. urika-0.1.0/src/urika/core/readme_generator.py +209 -0
  80. urika-0.1.0/src/urika/core/registry.py +52 -0
  81. urika-0.1.0/src/urika/core/report_writer.py +29 -0
  82. urika-0.1.0/src/urika/core/revisions.py +104 -0
  83. urika-0.1.0/src/urika/core/secrets.py +99 -0
  84. urika-0.1.0/src/urika/core/session.py +229 -0
  85. urika-0.1.0/src/urika/core/settings.py +89 -0
  86. urika-0.1.0/src/urika/core/source_scanner.py +187 -0
  87. urika-0.1.0/src/urika/core/updates.py +152 -0
  88. urika-0.1.0/src/urika/core/usage.py +162 -0
  89. urika-0.1.0/src/urika/core/venv.py +72 -0
  90. urika-0.1.0/src/urika/core/workspace.py +109 -0
  91. urika-0.1.0/src/urika/data/__init__.py +18 -0
  92. urika-0.1.0/src/urika/data/loader.py +84 -0
  93. urika-0.1.0/src/urika/data/models.py +40 -0
  94. urika-0.1.0/src/urika/data/profiler.py +158 -0
  95. urika-0.1.0/src/urika/data/readers/__init__.py +0 -0
  96. urika-0.1.0/src/urika/data/readers/base.py +27 -0
  97. urika-0.1.0/src/urika/data/readers/csv_reader.py +29 -0
  98. urika-0.1.0/src/urika/data/readers/registry.py +44 -0
  99. urika-0.1.0/src/urika/evaluation/__init__.py +12 -0
  100. urika-0.1.0/src/urika/evaluation/criteria.py +30 -0
  101. urika-0.1.0/src/urika/evaluation/leaderboard.py +101 -0
  102. urika-0.1.0/src/urika/evaluation/metrics/__init__.py +0 -0
  103. urika-0.1.0/src/urika/evaluation/metrics/base.py +41 -0
  104. urika-0.1.0/src/urika/evaluation/metrics/classification.py +100 -0
  105. urika-0.1.0/src/urika/evaluation/metrics/effect_size.py +38 -0
  106. urika-0.1.0/src/urika/evaluation/metrics/registry.py +41 -0
  107. urika-0.1.0/src/urika/evaluation/metrics/regression.py +56 -0
  108. urika-0.1.0/src/urika/knowledge/__init__.py +13 -0
  109. urika-0.1.0/src/urika/knowledge/extractors.py +83 -0
  110. urika-0.1.0/src/urika/knowledge/models.py +42 -0
  111. urika-0.1.0/src/urika/knowledge/store.py +120 -0
  112. urika-0.1.0/src/urika/methods/__init__.py +6 -0
  113. urika-0.1.0/src/urika/methods/base.py +55 -0
  114. urika-0.1.0/src/urika/methods/registry.py +52 -0
  115. urika-0.1.0/src/urika/notifications/__init__.py +173 -0
  116. urika-0.1.0/src/urika/notifications/base.py +31 -0
  117. urika-0.1.0/src/urika/notifications/bus.py +750 -0
  118. urika-0.1.0/src/urika/notifications/email_channel.py +178 -0
  119. urika-0.1.0/src/urika/notifications/events.py +22 -0
  120. urika-0.1.0/src/urika/notifications/queries.py +194 -0
  121. urika-0.1.0/src/urika/notifications/slack_channel.py +360 -0
  122. urika-0.1.0/src/urika/notifications/telegram_channel.py +349 -0
  123. urika-0.1.0/src/urika/orchestrator/__init__.py +23 -0
  124. urika-0.1.0/src/urika/orchestrator/context.py +36 -0
  125. urika-0.1.0/src/urika/orchestrator/finalize.py +167 -0
  126. urika-0.1.0/src/urika/orchestrator/knowledge.py +30 -0
  127. urika-0.1.0/src/urika/orchestrator/loop.py +1021 -0
  128. urika-0.1.0/src/urika/orchestrator/meta.py +279 -0
  129. urika-0.1.0/src/urika/orchestrator/parsing.py +72 -0
  130. urika-0.1.0/src/urika/orchestrator/pause.py +176 -0
  131. urika-0.1.0/src/urika/repl.py +384 -0
  132. urika-0.1.0/src/urika/repl_commands.py +1430 -0
  133. urika-0.1.0/src/urika/repl_session.py +219 -0
  134. urika-0.1.0/src/urika/templates/__init__.py +0 -0
  135. urika-0.1.0/src/urika/templates/presentation/__init__.py +0 -0
  136. urika-0.1.0/src/urika/templates/presentation/reveal.css +8 -0
  137. urika-0.1.0/src/urika/templates/presentation/reveal.min.js +15 -0
  138. urika-0.1.0/src/urika/templates/presentation/template.html +389 -0
  139. urika-0.1.0/src/urika/templates/presentation/theme-dark.css +37 -0
  140. urika-0.1.0/src/urika/templates/presentation/theme-light.css +19 -0
  141. urika-0.1.0/src/urika/tools/__init__.py +6 -0
  142. urika-0.1.0/src/urika/tools/base.py +50 -0
  143. urika-0.1.0/src/urika/tools/correlation.py +71 -0
  144. urika-0.1.0/src/urika/tools/cross_validation.py +109 -0
  145. urika-0.1.0/src/urika/tools/data_profiler.py +45 -0
  146. urika-0.1.0/src/urika/tools/descriptive_stats.py +89 -0
  147. urika-0.1.0/src/urika/tools/feature_scaler.py +109 -0
  148. urika-0.1.0/src/urika/tools/group_split.py +147 -0
  149. urika-0.1.0/src/urika/tools/hypothesis_tests.py +166 -0
  150. urika-0.1.0/src/urika/tools/linear_regression.py +104 -0
  151. urika-0.1.0/src/urika/tools/logistic_regression.py +113 -0
  152. urika-0.1.0/src/urika/tools/mann_whitney_u.py +64 -0
  153. urika-0.1.0/src/urika/tools/one_way_anova.py +77 -0
  154. urika-0.1.0/src/urika/tools/outlier_detection.py +113 -0
  155. urika-0.1.0/src/urika/tools/paired_t_test.py +64 -0
  156. urika-0.1.0/src/urika/tools/random_forest.py +119 -0
  157. urika-0.1.0/src/urika/tools/random_forest_classifier.py +128 -0
  158. urika-0.1.0/src/urika/tools/registry.py +74 -0
  159. urika-0.1.0/src/urika/tools/train_val_test_split.py +118 -0
  160. urika-0.1.0/src/urika/tools/visualization.py +135 -0
  161. urika-0.1.0/src/urika/tools/xgboost_regression.py +121 -0
@@ -0,0 +1,51 @@
1
+ name: Publish to PyPI
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ permissions:
8
+ id-token: write
9
+
10
+ jobs:
11
+ build:
12
+ name: Build distribution
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+
17
+ - name: Set up Python
18
+ uses: actions/setup-python@v5
19
+ with:
20
+ python-version: "3.12"
21
+
22
+ - name: Install build tools
23
+ run: pip install build
24
+
25
+ - name: Build package
26
+ run: python -m build
27
+
28
+ - name: Upload artifacts
29
+ uses: actions/upload-artifact@v4
30
+ with:
31
+ name: dist
32
+ path: dist/
33
+
34
+ publish:
35
+ name: Publish to PyPI
36
+ needs: build
37
+ runs-on: ubuntu-latest
38
+ environment:
39
+ name: pypi
40
+ url: https://pypi.org/p/urika
41
+ permissions:
42
+ id-token: write
43
+ steps:
44
+ - name: Download artifacts
45
+ uses: actions/download-artifact@v4
46
+ with:
47
+ name: dist
48
+ path: dist/
49
+
50
+ - name: Publish to PyPI
51
+ uses: pypa/gh-action-pypi-publish@release/v1
urika-0.1.0/.gitignore ADDED
@@ -0,0 +1,34 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ *$py.class
4
+ *.egg-info/
5
+ dist/
6
+ build/
7
+ .eggs/
8
+ *.egg
9
+ .pytest_cache/
10
+ .ruff_cache/
11
+ *.so
12
+ .venv/
13
+ venv/
14
+ env/
15
+ .env
16
+ *.db
17
+ .worktrees/
18
+
19
+ # IDE
20
+ .vscode/
21
+ .idea/
22
+ *.swp
23
+ *.swo
24
+ *~
25
+
26
+ # OS
27
+ .DS_Store
28
+ Thumbs.db
29
+
30
+ # Urika project data (not part of the repo)
31
+ urika-projects/
32
+
33
+ # Test dataset downloads (configs and knowledge ARE tracked)
34
+ dev/test-datasets/*/data/
@@ -0,0 +1,30 @@
1
+ # Changelog
2
+
3
+ All notable changes to Urika will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [0.1.0] - 2026-03-30
9
+
10
+ Initial pre-release.
11
+
12
+ ### Added
13
+
14
+ - Multi-agent orchestration system with 11 specialized agent roles
15
+ - Experiment lifecycle: planning, task execution, evaluation, advisory loop
16
+ - Meta-orchestrator for autonomous multi-experiment campaigns
17
+ - Finalization sequence: standalone methods, findings, reports, presentations
18
+ - 18 built-in statistical and ML tools
19
+ - Knowledge pipeline with PDF, text, and URL extractors
20
+ - Interactive REPL with 25+ slash commands
21
+ - CLI with 20+ commands
22
+ - Notification system (Email, Slack, Telegram) with remote control
23
+ - Pause/stop/resume for experiments and multi-experiment runs
24
+ - Reveal.js presentation generation
25
+ - Project builder with data profiling and multi-format support
26
+ - Versioned criteria system with advisor-driven evolution
27
+ - Method registry tracking all approaches across experiments
28
+ - Auto-generated labbooks, reports, and README files
29
+ - Privacy-aware hybrid endpoint model (public/private)
30
+ - 1072 tests
urika-0.1.0/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Urika Contributors
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
urika-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,257 @@
1
+ Metadata-Version: 2.4
2
+ Name: urika
3
+ Version: 0.1.0
4
+ Summary: Multi-agent scientific analysis platform
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Classifier: Development Status :: 3 - Alpha
8
+ Classifier: Intended Audience :: Science/Research
9
+ Classifier: License :: OSI Approved :: Apache Software License
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3.11
12
+ Classifier: Programming Language :: Python :: 3.12
13
+ Classifier: Topic :: Scientific/Engineering
14
+ Requires-Python: >=3.11
15
+ Requires-Dist: claude-agent-sdk>=0.1
16
+ Requires-Dist: click>=8.0
17
+ Requires-Dist: matplotlib>=3.7
18
+ Requires-Dist: numpy>=1.24
19
+ Requires-Dist: pandas>=2.0
20
+ Requires-Dist: pingouin>=0.5
21
+ Requires-Dist: prompt-toolkit>=3.0
22
+ Requires-Dist: pypdf>=4.0
23
+ Requires-Dist: scikit-learn>=1.3
24
+ Requires-Dist: scipy>=1.11
25
+ Requires-Dist: seaborn>=0.13
26
+ Requires-Dist: statsmodels>=0.14
27
+ Provides-Extra: all
28
+ Requires-Dist: imbalanced-learn>=0.11; extra == 'all'
29
+ Requires-Dist: lightgbm>=4.0; extra == 'all'
30
+ Requires-Dist: optuna>=3.0; extra == 'all'
31
+ Requires-Dist: python-telegram-bot>=20.0; extra == 'all'
32
+ Requires-Dist: sentence-transformers>=2.2; extra == 'all'
33
+ Requires-Dist: shap>=0.42; extra == 'all'
34
+ Requires-Dist: slack-sdk>=3.0; extra == 'all'
35
+ Requires-Dist: timm>=0.9; extra == 'all'
36
+ Requires-Dist: torch>=2.0; extra == 'all'
37
+ Requires-Dist: torchaudio>=2.0; extra == 'all'
38
+ Requires-Dist: torchvision>=0.15; extra == 'all'
39
+ Requires-Dist: transformers>=4.30; extra == 'all'
40
+ Requires-Dist: xgboost>=2.0; extra == 'all'
41
+ Provides-Extra: dev
42
+ Requires-Dist: imbalanced-learn>=0.11; extra == 'dev'
43
+ Requires-Dist: lightgbm>=4.0; extra == 'dev'
44
+ Requires-Dist: optuna>=3.0; extra == 'dev'
45
+ Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
46
+ Requires-Dist: pytest>=7.0; extra == 'dev'
47
+ Requires-Dist: python-telegram-bot>=20.0; extra == 'dev'
48
+ Requires-Dist: ruff>=0.1; extra == 'dev'
49
+ Requires-Dist: sentence-transformers>=2.2; extra == 'dev'
50
+ Requires-Dist: shap>=0.42; extra == 'dev'
51
+ Requires-Dist: slack-sdk>=3.0; extra == 'dev'
52
+ Requires-Dist: timm>=0.9; extra == 'dev'
53
+ Requires-Dist: torch>=2.0; extra == 'dev'
54
+ Requires-Dist: torchaudio>=2.0; extra == 'dev'
55
+ Requires-Dist: torchvision>=0.15; extra == 'dev'
56
+ Requires-Dist: transformers>=4.30; extra == 'dev'
57
+ Requires-Dist: xgboost>=2.0; extra == 'dev'
58
+ Provides-Extra: dl
59
+ Requires-Dist: sentence-transformers>=2.2; extra == 'dl'
60
+ Requires-Dist: timm>=0.9; extra == 'dl'
61
+ Requires-Dist: torch>=2.0; extra == 'dl'
62
+ Requires-Dist: torchaudio>=2.0; extra == 'dl'
63
+ Requires-Dist: torchvision>=0.15; extra == 'dl'
64
+ Requires-Dist: transformers>=4.30; extra == 'dl'
65
+ Provides-Extra: ml
66
+ Requires-Dist: imbalanced-learn>=0.11; extra == 'ml'
67
+ Requires-Dist: lightgbm>=4.0; extra == 'ml'
68
+ Requires-Dist: optuna>=3.0; extra == 'ml'
69
+ Requires-Dist: shap>=0.42; extra == 'ml'
70
+ Requires-Dist: xgboost>=2.0; extra == 'ml'
71
+ Provides-Extra: notifications
72
+ Requires-Dist: python-telegram-bot>=20.0; extra == 'notifications'
73
+ Requires-Dist: slack-sdk>=3.0; extra == 'notifications'
74
+ Description-Content-Type: text/markdown
75
+
76
+ <p align="center">
77
+ <img src="docs/assets/header.png" alt="Urika" width="580">
78
+ </p>
79
+
80
+ <p align="center">
81
+ <a href="docs/01-getting-started.md">Getting Started</a> &middot;
82
+ <a href="docs/09-agent-system.md">Agent System</a> &middot;
83
+ <a href="docs/12-models-and-privacy.md">Models &amp; Privacy</a> &middot;
84
+ <a href="docs/17-notifications.md">Notifications</a> &middot;
85
+ <a href="docs/15-cli-reference.md">CLI Reference</a> &middot;
86
+ <a href="docs/16-interactive-repl.md">Interactive REPL</a>
87
+ </p>
88
+
89
+ ---
90
+
91
+ > **Early Development** — Urika is under active development. Expect frequent updates, bug fixes, and new features. Check back regularly or run `urika setup` to see if a new version is available. Bug reports and feedback welcome at [GitHub Issues](https://github.com/xkiwilabs/Urika/issues).
92
+
93
+ Urika uses multiple AI agents to autonomously explore analytical approaches for your dataset and research question. It creates experiments, tries different methods, evaluates results, searches relevant literature, and builds custom tools when needed. Everything is documented automatically — experiment labbooks, project-level reports, key findings, and slide presentations you can view in any browser. Each experiment's methods, metrics, and observations are tracked in structured records that agents use to plan the next step.
94
+
95
+ Currently supports the **Claude Agent SDK** (Anthropic), including local models via Ollama. Adapters for **OpenAI Agents SDK**, **Google Agent Development Kit (ADK)**, and **PI** are planned for upcoming releases.
96
+
97
+ **Runs on Linux, macOS, and Windows 11.** For local/private model setups (Ollama, vLLM, LiteLLM), see [Models & Privacy](docs/12-models-and-privacy.md).
98
+
99
+ ## Installation
100
+
101
+ ### Prerequisites
102
+
103
+ 1. Python >= 3.11
104
+ 2. Claude Pro or Max account (recommended) — or an Anthropic API key
105
+ 3. Claude Code CLI — install and log in first:
106
+
107
+ ```bash
108
+ npm install -g @anthropic-ai/claude-code
109
+ claude login # opens browser to authenticate
110
+ ```
111
+
112
+ ### Install Urika
113
+
114
+ ```bash
115
+ pip install urika
116
+ urika setup # check installation, detect hardware, optionally install DL
117
+ ```
118
+
119
+ The default install includes visualization, ML, statistics, knowledge pipeline, and notification support. Deep learning (torch, transformers) is optional: `pip install "urika[dl]"`.
120
+
121
+ **From source (development):**
122
+
123
+ ```bash
124
+ git clone https://github.com/xkiwilabs/Urika.git
125
+ cd Urika
126
+ pip install -e ".[dev]"
127
+ ```
128
+
129
+ See [Getting Started](docs/01-getting-started.md) for full details.
130
+
131
+ ## Quickstart
132
+
133
+ ```bash
134
+ urika new my-study --data ./my_data.csv # create a project (interactive)
135
+ urika run my-study # run experiments
136
+ urika finalize my-study # produce final report
137
+ urika # or use the interactive REPL
138
+ ```
139
+
140
+ See the [Getting Started](docs/01-getting-started.md) guide for a full walkthrough.
141
+
142
+ ## How It Works
143
+
144
+ ```mermaid
145
+ flowchart TD
146
+ A["urika new\nProject Builder"] --> B["Scans data, profiles,\ningests knowledge"]
147
+ B --> C{"How to run?"}
148
+
149
+ C -- "Single experiment\n(guided)" --> D["urika run"]
150
+ C -- "Multiple experiments\n(autonomous)" --> META["urika run --max-experiments N\nAutonomous Mode"]
151
+
152
+ D --> LOOP
153
+ META --> LOOP
154
+
155
+ subgraph LOOP ["Experiment Loop (per experiment)"]
156
+ direction TB
157
+ P["Planning Agent\ndesigns method"] --> TA["Task Agent\nwrites code, runs tools"]
158
+ TA --> EV["Evaluator\nscores against criteria"]
159
+ EV --> Q{Criteria met?}
160
+ Q -- No --> ADV["Advisor Agent\nanalyzes, proposes next"]
161
+ ADV --> P
162
+ Q -- "Yes\n(--review-criteria)" --> RC["Advisor reviews\ncriteria"]
163
+ RC -- "raises bar" --> P
164
+ RC -- "confirms" --> REPORT
165
+ Q -- Yes --> REPORT["Generate Reports"]
166
+ end
167
+
168
+ D -- "after experiment" --> REVIEW["User reviews results\ndecides next step"]
169
+ REVIEW -- "run again" --> D
170
+
171
+ META -- "advisor decides\nnext experiment" --> LOOP
172
+
173
+ REPORT --> FIN["urika finalize\nFinalizer Agent"]
174
+ FIN --> OUT["Standalone methods\nFinal report & presentation\nReproduce scripts"]
175
+
176
+ TA -. "needs tool" .-> TB["Tool Builder"]
177
+ P -. "needs literature" .-> LIT["Literature Agent"]
178
+ TB -.-> TA
179
+ LIT -.-> P
180
+ ```
181
+
182
+ Eleven agents work together. Each experiment runs autonomously — agents plan, execute, evaluate, and iterate without intervention. You choose how to manage the *between-experiment* flow:
183
+
184
+ - **Guided** (`urika run`) — agents run one experiment autonomously, then you review results and decide what to try next. Best for exploratory work and complex domains where human judgment matters between experiments.
185
+ - **Fully autonomous** (`urika run --max-experiments N`) — the system runs multiple experiments back-to-back, with the advisor agent deciding what to try next. Best when you've provided detailed context (see [Prompts and Context](docs/04-prompts-and-context.md)).
186
+
187
+ Within each experiment, the orchestrator cycles through `planning -> task -> evaluator -> advisor` each turn. When all experiments are complete, the **Finalizer** produces standalone deliverables.
188
+
189
+ See [Agent System](docs/09-agent-system.md) for details on each agent role.
190
+
191
+ ## Scriptable CLI
192
+
193
+ Every Urika command is fully scriptable -- pass arguments and flags directly, get structured JSON output with `--json`, and chain commands in shell scripts. No interactive prompts when flags are provided.
194
+
195
+ ```bash
196
+ # Create and run a project in one script
197
+ urika new my-study --data ~/data/scores.csv --question "What predicts outcome?" --mode exploratory
198
+ urika run my-study --max-turns 5 --instructions "focus on tree-based models"
199
+ urika run my-study --max-experiments 3 --auto
200
+ urika finalize my-study --instructions "emphasize the best model"
201
+
202
+ # Get structured output for custom tooling
203
+ urika status my-study --json
204
+ urika results my-study --json
205
+ urika methods my-study --json
206
+
207
+ # Remote control via Telegram/Slack while experiments run
208
+ # See Notifications docs for setup
209
+ ```
210
+
211
+ This makes it straightforward to build custom workflows, batch processing scripts, CI pipelines, or wrap Urika in your own research tools. See [CLI Reference](docs/15-cli-reference.md) for the full command list.
212
+
213
+ ## Privacy and Model Configuration
214
+
215
+ Each project can configure which models and endpoints its agents use. Three privacy modes:
216
+
217
+ - **Open** (default) -- all agents use cloud models via API. No restrictions.
218
+ - **Private** -- all agents use private endpoints only. This can be local models (Ollama), a secure institutional server, or any combination -- whatever stays within your data governance boundary.
219
+ - **Hybrid** -- a private Data Agent reads raw data and outputs sanitized summaries; all other agents run on cloud models for maximum analytical power. Raw data never leaves your private environment. The default hybrid split covers most cases, but you can customize which agents use which endpoints to ensure what needs to be private stays private.
220
+
221
+ Per-agent model routing lets you optimize for cost (Haiku for simple tasks, Opus for complex reasoning) or compliance (institutional servers for data access, cloud for method design). Different projects can have completely different privacy and model settings.
222
+
223
+ See above for supported and upcoming SDK adapters.
224
+
225
+ See [Models and Privacy](docs/12-models-and-privacy.md) for configuration details.
226
+
227
+ ## Documentation
228
+
229
+ | Guide | Description |
230
+ |-------|-------------|
231
+ | [Getting Started](docs/01-getting-started.md) | Installation, requirements, first project |
232
+ | [Core Concepts](docs/02-core-concepts.md) | Projects, experiments, runs, methods, tools, agents |
233
+ | [Creating Projects](docs/03-creating-projects.md) | `urika new`, data scanning, knowledge ingestion |
234
+ | [Prompts and Context](docs/04-prompts-and-context.md) | Writing effective descriptions, instructions, knowledge ingestion |
235
+ | [Running Experiments](docs/05-running-experiments.md) | Orchestrator loop, turns, auto mode, resume |
236
+ | [Advisor Chat and Instructions](docs/06-advisor-and-instructions.md) | Standalone advisor conversations, steering agents, suggestion-to-run flow |
237
+ | [Viewing Results](docs/07-viewing-results.md) | Reports, presentations, methods, leaderboard |
238
+ | [Finalizing Projects](docs/08-finalizing-projects.md) | Finalization sequence, standalone methods, reproducibility |
239
+ | [Agent System](docs/09-agent-system.md) | All 11 agent roles and how they interact |
240
+ | [Built-in Tools](docs/10-built-in-tools.md) | 18 analysis tools agents use |
241
+ | [Knowledge Pipeline](docs/11-knowledge-pipeline.md) | Ingesting papers, PDFs, searching |
242
+ | [Models and Privacy](docs/12-models-and-privacy.md) | Per-agent model routing, endpoints, hybrid privacy mode |
243
+ | [Configuration](docs/13-configuration.md) | urika.toml, criteria, preferences |
244
+ | [Project Structure](docs/14-project-structure.md) | File layout and what each file does |
245
+ | [CLI Reference](docs/15-cli-reference.md) | Every command with full options |
246
+ | [Interactive REPL](docs/16-interactive-repl.md) | Slash commands, tab completion, conversation mode |
247
+ | [Notifications](docs/17-notifications.md) | Email, Slack, Telegram alerts and remote commands |
248
+
249
+ ## Citation
250
+
251
+ If you use Urika in your research or analysis, please acknowledge its use in your publications:
252
+
253
+ > Urika -- Multi-agent scientific analysis platform. Developed by Michael J. Richardson and colleagues at Macquarie University, Sydney, Australia. https://github.com/xkiwilabs/Urika
254
+
255
+ ## License
256
+
257
+ [Apache 2.0](LICENSE) -- Free to use, modify, and distribute for any purpose, including commercial use. Includes patent protection for contributors. See the [full license](LICENSE) for details.