claimset 0.40.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 (94) hide show
  1. claimset-0.40.0/LICENSE +201 -0
  2. claimset-0.40.0/PKG-INFO +198 -0
  3. claimset-0.40.0/README.md +181 -0
  4. claimset-0.40.0/pyproject.toml +33 -0
  5. claimset-0.40.0/setup.cfg +4 -0
  6. claimset-0.40.0/src/claimset/__init__.py +12 -0
  7. claimset-0.40.0/src/claimset/__main__.py +7 -0
  8. claimset-0.40.0/src/claimset/agents.py +495 -0
  9. claimset-0.40.0/src/claimset/bundle.py +198 -0
  10. claimset-0.40.0/src/claimset/claim.py +79 -0
  11. claimset-0.40.0/src/claimset/cli.py +345 -0
  12. claimset-0.40.0/src/claimset/data/agents/AGENTS.md +16 -0
  13. claimset-0.40.0/src/claimset/data/agents/opencode-guard.js +13 -0
  14. claimset-0.40.0/src/claimset/data/examples/published-native.json +285 -0
  15. claimset-0.40.0/src/claimset/data/examples/submission-from-lab.json +507 -0
  16. claimset-0.40.0/src/claimset/data/examples/submission-native.json +271 -0
  17. claimset-0.40.0/src/claimset/data/skills/claimset-lab/SKILL.md +266 -0
  18. claimset-0.40.0/src/claimset/data/skills/claimset-lab/claimset +16 -0
  19. claimset-0.40.0/src/claimset/data/skills/claimset-review/SKILL.md +183 -0
  20. claimset-0.40.0/src/claimset/data/skills/claimset-revise/SKILL.md +87 -0
  21. claimset-0.40.0/src/claimset/data/skills/claimset-submit/SKILL.md +347 -0
  22. claimset-0.40.0/src/claimset/data/spec/claimset-revision-v0.6.md +561 -0
  23. claimset-0.40.0/src/claimset/data/spec/claimset-v0.40.md +1896 -0
  24. claimset-0.40.0/src/claimset/data/spec/extensions/README.md +23 -0
  25. claimset-0.40.0/src/claimset/data/spec/extensions/linguistics-v0.1.md +37 -0
  26. claimset-0.40.0/src/claimset/data/spec/extensions/qualitative-v0.1.md +117 -0
  27. claimset-0.40.0/src/claimset/data/spec/lab-record-v0.21.md +904 -0
  28. claimset-0.40.0/src/claimset/extensions/__init__.py +34 -0
  29. claimset-0.40.0/src/claimset/extensions/linguistics_v0_1.py +52 -0
  30. claimset-0.40.0/src/claimset/extensions/qualitative_count.py +168 -0
  31. claimset-0.40.0/src/claimset/extensions/qualitative_v0_1.py +96 -0
  32. claimset-0.40.0/src/claimset/lab/__init__.py +3 -0
  33. claimset-0.40.0/src/claimset/lab/anchor.py +508 -0
  34. claimset-0.40.0/src/claimset/lab/cli.py +1195 -0
  35. claimset-0.40.0/src/claimset/lab/core.py +2044 -0
  36. claimset-0.40.0/src/claimset/lab/decision.py +396 -0
  37. claimset-0.40.0/src/claimset/lab/export.py +1051 -0
  38. claimset-0.40.0/src/claimset/lab/guard.py +212 -0
  39. claimset-0.40.0/src/claimset/lab/layout.py +171 -0
  40. claimset-0.40.0/src/claimset/lab/protect.py +43 -0
  41. claimset-0.40.0/src/claimset/lab/qualitative.py +350 -0
  42. claimset-0.40.0/src/claimset/lab/record.py +578 -0
  43. claimset-0.40.0/src/claimset/lab/run.py +249 -0
  44. claimset-0.40.0/src/claimset/lab/sources.py +361 -0
  45. claimset-0.40.0/src/claimset/lab/summary.py +216 -0
  46. claimset-0.40.0/src/claimset/migrate.py +193 -0
  47. claimset-0.40.0/src/claimset/package.py +101 -0
  48. claimset-0.40.0/src/claimset/render.py +402 -0
  49. claimset-0.40.0/src/claimset/renumber.py +93 -0
  50. claimset-0.40.0/src/claimset/revision.py +1292 -0
  51. claimset-0.40.0/src/claimset/submit.py +168 -0
  52. claimset-0.40.0/src/claimset/validate.py +3330 -0
  53. claimset-0.40.0/src/claimset/versions/__init__.py +21 -0
  54. claimset-0.40.0/src/claimset/versions/v0_39.py +3288 -0
  55. claimset-0.40.0/src/claimset.egg-info/PKG-INFO +198 -0
  56. claimset-0.40.0/src/claimset.egg-info/SOURCES.txt +92 -0
  57. claimset-0.40.0/src/claimset.egg-info/dependency_links.txt +1 -0
  58. claimset-0.40.0/src/claimset.egg-info/entry_points.txt +2 -0
  59. claimset-0.40.0/src/claimset.egg-info/top_level.txt +1 -0
  60. claimset-0.40.0/tests/test_additions.py +157 -0
  61. claimset-0.40.0/tests/test_agents.py +256 -0
  62. claimset-0.40.0/tests/test_bugs.py +89 -0
  63. claimset-0.40.0/tests/test_bundle.py +103 -0
  64. claimset-0.40.0/tests/test_claim.py +78 -0
  65. claimset-0.40.0/tests/test_compat.py +160 -0
  66. claimset-0.40.0/tests/test_extensions.py +259 -0
  67. claimset-0.40.0/tests/test_highlights.py +89 -0
  68. claimset-0.40.0/tests/test_kinds.py +76 -0
  69. claimset-0.40.0/tests/test_lab.py +577 -0
  70. claimset-0.40.0/tests/test_lab_actors.py +183 -0
  71. claimset-0.40.0/tests/test_lab_agents.py +465 -0
  72. claimset-0.40.0/tests/test_lab_coding.py +172 -0
  73. claimset-0.40.0/tests/test_lab_counts.py +283 -0
  74. claimset-0.40.0/tests/test_lab_decision.py +469 -0
  75. claimset-0.40.0/tests/test_lab_export.py +530 -0
  76. claimset-0.40.0/tests/test_lab_extensions.py +169 -0
  77. claimset-0.40.0/tests/test_lab_protect.py +277 -0
  78. claimset-0.40.0/tests/test_lab_rules_per_hypothesis.py +127 -0
  79. claimset-0.40.0/tests/test_lab_skill.py +98 -0
  80. claimset-0.40.0/tests/test_lab_sources.py +272 -0
  81. claimset-0.40.0/tests/test_limits.py +93 -0
  82. claimset-0.40.0/tests/test_observation.py +107 -0
  83. claimset-0.40.0/tests/test_packaging.py +55 -0
  84. claimset-0.40.0/tests/test_process_checks.py +424 -0
  85. claimset-0.40.0/tests/test_registered.py +207 -0
  86. claimset-0.40.0/tests/test_renumber.py +88 -0
  87. claimset-0.40.0/tests/test_revision.py +708 -0
  88. claimset-0.40.0/tests/test_second_round.py +178 -0
  89. claimset-0.40.0/tests/test_studies.py +379 -0
  90. claimset-0.40.0/tests/test_study_branches.py +523 -0
  91. claimset-0.40.0/tests/test_submit.py +161 -0
  92. claimset-0.40.0/tests/test_sync.py +58 -0
  93. claimset-0.40.0/tests/test_uncertainty.py +157 -0
  94. claimset-0.40.0/tests/test_validate.py +2124 -0
@@ -0,0 +1,201 @@
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 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 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 those 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
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,198 @@
1
+ Metadata-Version: 2.4
2
+ Name: claimset
3
+ Version: 0.40.0
4
+ Summary: Tools for Claimset, an open format for research papers written by and for LLMs: validation, lab records and export.
5
+ Author: Claimset contributors
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/entrylib/claimset
8
+ Project-URL: Issues, https://github.com/entrylib/claimset/issues
9
+ Keywords: research,scholarly communication,LLM,agents,claims,reproducibility
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Topic :: Scientific/Engineering
13
+ Requires-Python: >=3.10
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Dynamic: license-file
17
+
18
+ # Claimset
19
+
20
+ Claimset is an open format for research papers written by AI agents for AI readers, and the tools that go with it.
21
+
22
+ A claimset is a JSON file of atomic, self-contained **claims**, each with its scope, assumptions, limitations, kind and strength of support, and links to the evidence, results and artefacts behind it. Agents write the papers; a human supervisor and guarantor answer for them. Humans read them by asking an LLM.
23
+
24
+ Research is iterative, so the format has a companion: the **lab record**, an append-only, hash-chained log of questions, hypotheses, plans, runs, results and decisions kept while the research happens. The claimset is distilled from it, negative results included.
25
+
26
+ > Status: early draft. The format and tools are changing quickly; expect breaking changes before 1.0.
27
+
28
+ ## What is in this repository
29
+
30
+ | Path | Contents |
31
+ |---|---|
32
+ | `spec/` | The claimset specification and the lab record specification (normative) |
33
+ | `src/claimset/` | The `claimset` Python package and command-line tool |
34
+ | `skills/` | Instructions for AI agents (Agent Skills), bundling everything they need |
35
+ | `agents/` | What `claimset init` writes for coding agents: the instructions block and the guard's plugin |
36
+ | `examples/` | Valid example claimsets |
37
+ | `tests/` | Test suite |
38
+ | `tools/` | Maintenance scripts |
39
+
40
+ ## Install
41
+
42
+ ```
43
+ pip install claimset # a release, from PyPI
44
+ pip install git+https://github.com/entrylib/claimset # the development version
45
+ ```
46
+
47
+ The package has no dependencies beyond the Python standard library (Python 3.10 or later). It carries the specifications and the agent skills of its version:
48
+
49
+ ```
50
+ claimset spec # the claimset specification this version validates against
51
+ claimset spec --lab # the lab record specification
52
+ claimset spec --revision # the revision specification: reviews, responses, revised versions, scores
53
+ claimset init # set the project up for the coding agent running this shell (see below)
54
+ claimset skill install # install or update the skills in .claude/skills (--dir for another place)
55
+ claimset skill check # are the installed skills this version's?
56
+ ```
57
+
58
+ The tools and skills work with any coding agent. `claimset init` sets a project up for the ones its people use, from one template:
59
+
60
+ ```
61
+ claimset init --agent codex --agent gemini --agent claude # or --agent all; --list shows every agent
62
+ claimset init --agent opencode --guard # also the lab record's guard, where the agent has hooks
63
+ ```
64
+
65
+ It installs the skills in the fewest folders that reach every agent chosen (`.agents/skills/` for Codex, Gemini CLI, Qwen Code, opencode, Kilo Code, GitHub Copilot, Cursor, Windsurf, Amp, Goose, Factory, Crush, Zed and MiniMax Code; `.claude/skills/` for Claude Code; their own for Junie, Kiro and Deep Code), writes one instructions block to `AGENTS.md` that `CLAUDE.md` and `GEMINI.md` import, and with `--guard` registers the guard in each agent's hook configuration (Claude Code, Codex, Gemini CLI, Qwen Code, opencode, GitHub Copilot, Cursor, Cline). Running it again updates what it wrote and leaves the rest of those files alone. Any model works: DeepSeek, MiniMax, Qwen or Kimi through opencode, Kilo Code, Crush or another harness are set up the same way, and the harness an agent runs in is recorded with it (lab record §5.2). An agent that cannot tell which model it is takes it from `CLAIMSET_MODEL`, which the human sets.
66
+
67
+ Studies and papers live in the research repository, each study on its own branch `claimset/<study>` that is never merged with the code. The tool checks it out at `claimset/<study>/` (ignored by the code branches), and commits and pushes it after every change to the record (see the lab record specification §3):
68
+
69
+ ```
70
+ claimset setup --study <study> --title … # new study: branch claimset/<study>, checked out at claimset/<study>/
71
+ claimset setup # in a fresh clone: check out every study branch
72
+ claimset setup --ci # GitHub check: pull requests never carry study records
73
+ claimset studies # the studies and their state
74
+ claimset/<study>/lab/ # the lab record, on the study branch
75
+ claimset/<study>/<paper>.claimset.json # a paper drawn from it (claimset lab export [--paper <paper>])
76
+ claimset-code/<study>/ # code only this study uses, on the code branches
77
+ claimset tag claimset/<study>/<paper>.claimset.json # mark a submitted version: git tag claimset/<study>/<paper>/v<n>
78
+ ```
79
+
80
+ Skills copied into a project do not follow later versions of the package; `claimset skill check` finds an out-of-date copy and `claimset skill install` replaces it.
81
+
82
+ ## Use
83
+
84
+ Validate a claimset before submission:
85
+
86
+ ```
87
+ claimset validate claimset.json
88
+ claimset validate claimset.json --json # machine-readable report
89
+ claimset validate claimset.json --published # check a published file
90
+ claimset render claimset.json -o claimset.txt # the reading view: plain text for reading models
91
+ claimset renumber claimset.json # before the first submission: IDs in reading order
92
+ claimset migrate claimset.json # bring a file from an earlier version; lists what needs judgement
93
+ claimset package claimset.json -o paper.zip # the submission package: the claimset and its files (BagIt)
94
+ claimset validate paper.zip # validate a package: files, checksums and the claimset
95
+ ```
96
+
97
+ The report lists errors (the file is rejected), warnings (accepted, recorded) and the verifiability the platform will compute for each claim.
98
+
99
+ Submit to EntryLib and follow the submission:
100
+
101
+ ```
102
+ claimset submit paper.zip # a package (zip or folder) or a claimset JSON file; prints the consent link
103
+ claimset submit https://zenodo.org/…/paper.zip # a package deposited elsewhere: the platform fetches it
104
+ claimset status sub_… # pending, confirmed, publishing, published, refused or expired
105
+ ```
106
+
107
+ A local file is validated first and not sent if it has errors. The answer gives a consent link for the guarantor, who signs in with ORCID within 48 hours and confirms; it is shown only once. A new version of a published claimset sets `paper.id` to its identifier. `--portal` (or `$CLAIMSET_PORTAL`) names another platform.
108
+
109
+ Keep a lab record while doing research:
110
+
111
+ ```
112
+ claimset lab init --title "Working title"
113
+ claimset lab actor --kind agent --name "Research agent" --model "Anthropic|Claude Opus|5.5" # the harness is recorded too
114
+ export CLAIMSET_ACTOR=AC1
115
+ claimset lab question "Does X improve Y?"
116
+ claimset lab hypothesis "X improves Y on monthly series." --question Q1
117
+ claimset lab plan --kind confirmatory --hypotheses H1 --design "…" --analysis "…" \
118
+ --framework frequentist --parameter alpha=0.05 --parameter test="paired t-test" --parameter sides=greater \
119
+ --parameter correction=none --parameter sample="400 series, fixed" \
120
+ --quantity p="p-value" --quantity d="mean difference" --supported "p < alpha and d > 0" --not-supported "…"
121
+ claimset lab run --plan PL1 --seed 7 -- python3 experiment.py
122
+ claimset lab verdict PL1 # the verdict the plan's rule gives on the run's results
123
+ claimset lab status H1 supported --plan PL1 --why "Rule of PL1 met." --evidence RS1 RS2
124
+ claimset lab summary # current state, for whoever picks up the work
125
+ claimset lab verify # hash chain, rules and run files
126
+ ```
127
+
128
+ A confirmatory plan fixes everything that decides the outcome before any run: the test, significance level, sidedness, correction for multiple tests, sample size and stopping rule, the results the decision is made on, and the rules for *supported* and *not supported* (anything else is *inconclusive*). The tool computes the verdict from those rules and refuses a status that disagrees or a second attempt at a decided test, and every planned test that ran is exported as a claim, whatever its result. Exploration stays light: record the runs you learn from; nothing else is enforced. Weaknesses that do not break a rule are flagged rather than refused: code changed after the plan, held-out data used elsewhere, a test that reproduced the result that suggested its hypothesis; `plan`, `run` and `verdict` also warn about a hypothesis from exploration without `--new-data`, exclusions without counts and the same computation run under two plans.
129
+
130
+ `run` records the command, code version, environment and every output file, and turns the numbers the script writes to `$CLAIMSET_RESULTS` into result events. The log is append-only and hash-chained; the tool refuses writes that break the rules (e.g. confirming a hypothesis with the result that suggested it).
131
+
132
+ When the research is done, draft the claimset from the record:
133
+
134
+ ```
135
+ claimset lab export -o claimset.json
136
+ ```
137
+
138
+ The draft carries everything the record states: a claim for every tested hypothesis (negative results included) with its outcome and whether the test was planned, evidence with the runs and results behind it, contributors, models and the exploration counts. Export also prints a completion list of what only people or the writing agent can decide: licence, guarantor, principal claims, the highlights a reader sees first (up to five, chosen by the guarantor), wording and scope. The `claimset-submit` skill works through it.
139
+
140
+ Several agents working at once each keep their own log, merged when they finish:
141
+
142
+ ```
143
+ claimset lab start --by AC2 # AC2's events now go to lab/agents/AC2.jsonl, with IDs like AC2.H1
144
+ claimset lab start --by AC3
145
+ claimset lab merge # appends both logs to the main log, interleaved by time
146
+ ```
147
+
148
+ An agent sees the main log as it was when it started, plus its own events. The merge is refused as a whole if any event no longer fits the main log, and `verify` checks that every merged event matches its agent log.
149
+
150
+ ### Answering a review
151
+
152
+ A published claimset is reviewed, and every comment states in advance what evidence would settle it. The author may answer with a revised version and a response; reviews, responses and versions are kept side by side, never rewritten, and the reviewer's score of each claim rests on comments the author can answer. The commands read the claimset's record folder (`v1/claimset.json`, `v1/reviews/RV1.json`, …):
153
+
154
+ ```
155
+ claimset revision status <record> # comments, their states and tests; what to answer
156
+ claimset lab plan --kind confirmatory --hypotheses H9 --comment doi:…@v1/RV1.c2 --review RV1.json --analysis "…"
157
+ # run a comment's resolution test as a planned test
158
+ claimset revision respond <record> --revision revised.json --lab lab.jsonl -o response.json
159
+ claimset revision check <record> --revision revised.json --response response.json --lab lab.jsonl
160
+ ```
161
+
162
+ ### Protecting the lab record
163
+
164
+ The hash chain makes any edit to the log detectable. Three optional layers stop edits from happening or make them impossible to hide (spec §4.5):
165
+
166
+ ```
167
+ claimset lab anchor --git # push the log to a `claimset-lab` branch after every plan
168
+ claimset lab verify --remote # check the local log against the anchored copy
169
+ claimset lab protect # append-only attribute on the log files (Linux, needs sudo)
170
+ ```
171
+
172
+ - **Anchoring** commits the log to its own branch without touching your working tree and never force-pushes. A confirmatory run is refused until its plan has been anchored, so the plan provably existed before the results. Protect the branch on your git host against force-pushes and deletion to make the remote copy append-only.
173
+ - **The guard** is a hook for agent harnesses that refuses tool calls that would edit or delete files in the lab directory other than through `claimset lab`. `claimset init --guard --agent NAME` installs it for Claude Code, Codex, Gemini CLI, Qwen Code, opencode, GitHub Copilot, Cursor or Cline (`claimset lab guard --print-config --agent NAME` prints the configuration instead). Codex, Gemini CLI, Qwen Code and Copilot run a project's hooks only once you trust them.
174
+ - **The append-only attribute** makes the kernel refuse anything but appending, as long as the agent cannot use `sudo`.
175
+
176
+ ## For AI agents
177
+
178
+ `skills/claimset-submit/` teaches an agent to turn finished research, or a lab record, into a valid claimset submission. It is self-contained: `claimset init` installs it where your agent reads skills, or copy the folder there yourself. Agents without skills support are pointed at its `SKILL.md` by the block `claimset init` writes to `AGENTS.md`.
179
+
180
+ `skills/claimset-lab/` teaches an agent to keep a lab record while it does research: registering itself honestly, planning before testing, running code through the tool, recording failures and negative results, working alongside other agents, and handing over to `claimset-submit` at the end. It bundles a copy of the `claimset` package, so it works without installing anything (`python3 scripts/claimset lab ...`).
181
+
182
+ `skills/claimset-revise/` teaches an agent to answer the reviews of a published claimset: settling each comment with evidence (running its resolution test as a planned test where it can be computed), building the revised version and writing the response. It bundles the package too.
183
+
184
+ `skills/claimset-review/` is the platform's reviewer, published so that every author can see how a claimset is reviewed and review their own before submitting: what to check, how to write a comment whose resolution test either side could run, how to judge an author's answers, and how every score below 100 rests on comments. Each review names the version of the skill it followed.
185
+
186
+ ## Contributing
187
+
188
+ - The specifications in `spec/` are the source of truth; the validator implements them and the tests check both.
189
+ - After changing the validator, a spec, an example or a template in `agents/`, run `python3 tools/sync_skills.py` to update the copies bundled in the skills and the package.
190
+ - Run the tests with `python3 -m unittest discover -s tests`.
191
+ - Releasing, in two stages:
192
+ 1. Set the version in `pyproject.toml` and `src/claimset/__init__.py` and merge. Then run the `build` workflow by hand on `main` (Actions > build > Run workflow): it runs the tests, builds the sdist and wheel, tries the wheel in a clean environment and drafts the GitHub release `v<version>` for that commit, with both files attached. Run again while it is a draft, it replaces the draft; a published version is never rebuilt.
193
+ 2. Review the draft and publish it. Publishing creates the tag `v<version>` on the commit that was built, and the `release` workflow checks that the files are the ones `build` made from that commit and uploads them to PyPI by trusted publishing (no token; set up once on PyPI and as a `pypi` environment on GitHub, see `.github/workflows/release.yml`).
194
+ - Planned work is tracked in [issues labelled `roadmap`](https://github.com/entrylib/claimset/issues?q=is%3Aissue+label%3Aroadmap).
195
+
196
+ ## Licence
197
+
198
+ Code is licensed under the Apache License 2.0 (`LICENSE`). The specifications in `spec/` are licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
@@ -0,0 +1,181 @@
1
+ # Claimset
2
+
3
+ Claimset is an open format for research papers written by AI agents for AI readers, and the tools that go with it.
4
+
5
+ A claimset is a JSON file of atomic, self-contained **claims**, each with its scope, assumptions, limitations, kind and strength of support, and links to the evidence, results and artefacts behind it. Agents write the papers; a human supervisor and guarantor answer for them. Humans read them by asking an LLM.
6
+
7
+ Research is iterative, so the format has a companion: the **lab record**, an append-only, hash-chained log of questions, hypotheses, plans, runs, results and decisions kept while the research happens. The claimset is distilled from it, negative results included.
8
+
9
+ > Status: early draft. The format and tools are changing quickly; expect breaking changes before 1.0.
10
+
11
+ ## What is in this repository
12
+
13
+ | Path | Contents |
14
+ |---|---|
15
+ | `spec/` | The claimset specification and the lab record specification (normative) |
16
+ | `src/claimset/` | The `claimset` Python package and command-line tool |
17
+ | `skills/` | Instructions for AI agents (Agent Skills), bundling everything they need |
18
+ | `agents/` | What `claimset init` writes for coding agents: the instructions block and the guard's plugin |
19
+ | `examples/` | Valid example claimsets |
20
+ | `tests/` | Test suite |
21
+ | `tools/` | Maintenance scripts |
22
+
23
+ ## Install
24
+
25
+ ```
26
+ pip install claimset # a release, from PyPI
27
+ pip install git+https://github.com/entrylib/claimset # the development version
28
+ ```
29
+
30
+ The package has no dependencies beyond the Python standard library (Python 3.10 or later). It carries the specifications and the agent skills of its version:
31
+
32
+ ```
33
+ claimset spec # the claimset specification this version validates against
34
+ claimset spec --lab # the lab record specification
35
+ claimset spec --revision # the revision specification: reviews, responses, revised versions, scores
36
+ claimset init # set the project up for the coding agent running this shell (see below)
37
+ claimset skill install # install or update the skills in .claude/skills (--dir for another place)
38
+ claimset skill check # are the installed skills this version's?
39
+ ```
40
+
41
+ The tools and skills work with any coding agent. `claimset init` sets a project up for the ones its people use, from one template:
42
+
43
+ ```
44
+ claimset init --agent codex --agent gemini --agent claude # or --agent all; --list shows every agent
45
+ claimset init --agent opencode --guard # also the lab record's guard, where the agent has hooks
46
+ ```
47
+
48
+ It installs the skills in the fewest folders that reach every agent chosen (`.agents/skills/` for Codex, Gemini CLI, Qwen Code, opencode, Kilo Code, GitHub Copilot, Cursor, Windsurf, Amp, Goose, Factory, Crush, Zed and MiniMax Code; `.claude/skills/` for Claude Code; their own for Junie, Kiro and Deep Code), writes one instructions block to `AGENTS.md` that `CLAUDE.md` and `GEMINI.md` import, and with `--guard` registers the guard in each agent's hook configuration (Claude Code, Codex, Gemini CLI, Qwen Code, opencode, GitHub Copilot, Cursor, Cline). Running it again updates what it wrote and leaves the rest of those files alone. Any model works: DeepSeek, MiniMax, Qwen or Kimi through opencode, Kilo Code, Crush or another harness are set up the same way, and the harness an agent runs in is recorded with it (lab record §5.2). An agent that cannot tell which model it is takes it from `CLAIMSET_MODEL`, which the human sets.
49
+
50
+ Studies and papers live in the research repository, each study on its own branch `claimset/<study>` that is never merged with the code. The tool checks it out at `claimset/<study>/` (ignored by the code branches), and commits and pushes it after every change to the record (see the lab record specification §3):
51
+
52
+ ```
53
+ claimset setup --study <study> --title … # new study: branch claimset/<study>, checked out at claimset/<study>/
54
+ claimset setup # in a fresh clone: check out every study branch
55
+ claimset setup --ci # GitHub check: pull requests never carry study records
56
+ claimset studies # the studies and their state
57
+ claimset/<study>/lab/ # the lab record, on the study branch
58
+ claimset/<study>/<paper>.claimset.json # a paper drawn from it (claimset lab export [--paper <paper>])
59
+ claimset-code/<study>/ # code only this study uses, on the code branches
60
+ claimset tag claimset/<study>/<paper>.claimset.json # mark a submitted version: git tag claimset/<study>/<paper>/v<n>
61
+ ```
62
+
63
+ Skills copied into a project do not follow later versions of the package; `claimset skill check` finds an out-of-date copy and `claimset skill install` replaces it.
64
+
65
+ ## Use
66
+
67
+ Validate a claimset before submission:
68
+
69
+ ```
70
+ claimset validate claimset.json
71
+ claimset validate claimset.json --json # machine-readable report
72
+ claimset validate claimset.json --published # check a published file
73
+ claimset render claimset.json -o claimset.txt # the reading view: plain text for reading models
74
+ claimset renumber claimset.json # before the first submission: IDs in reading order
75
+ claimset migrate claimset.json # bring a file from an earlier version; lists what needs judgement
76
+ claimset package claimset.json -o paper.zip # the submission package: the claimset and its files (BagIt)
77
+ claimset validate paper.zip # validate a package: files, checksums and the claimset
78
+ ```
79
+
80
+ The report lists errors (the file is rejected), warnings (accepted, recorded) and the verifiability the platform will compute for each claim.
81
+
82
+ Submit to EntryLib and follow the submission:
83
+
84
+ ```
85
+ claimset submit paper.zip # a package (zip or folder) or a claimset JSON file; prints the consent link
86
+ claimset submit https://zenodo.org/…/paper.zip # a package deposited elsewhere: the platform fetches it
87
+ claimset status sub_… # pending, confirmed, publishing, published, refused or expired
88
+ ```
89
+
90
+ A local file is validated first and not sent if it has errors. The answer gives a consent link for the guarantor, who signs in with ORCID within 48 hours and confirms; it is shown only once. A new version of a published claimset sets `paper.id` to its identifier. `--portal` (or `$CLAIMSET_PORTAL`) names another platform.
91
+
92
+ Keep a lab record while doing research:
93
+
94
+ ```
95
+ claimset lab init --title "Working title"
96
+ claimset lab actor --kind agent --name "Research agent" --model "Anthropic|Claude Opus|5.5" # the harness is recorded too
97
+ export CLAIMSET_ACTOR=AC1
98
+ claimset lab question "Does X improve Y?"
99
+ claimset lab hypothesis "X improves Y on monthly series." --question Q1
100
+ claimset lab plan --kind confirmatory --hypotheses H1 --design "…" --analysis "…" \
101
+ --framework frequentist --parameter alpha=0.05 --parameter test="paired t-test" --parameter sides=greater \
102
+ --parameter correction=none --parameter sample="400 series, fixed" \
103
+ --quantity p="p-value" --quantity d="mean difference" --supported "p < alpha and d > 0" --not-supported "…"
104
+ claimset lab run --plan PL1 --seed 7 -- python3 experiment.py
105
+ claimset lab verdict PL1 # the verdict the plan's rule gives on the run's results
106
+ claimset lab status H1 supported --plan PL1 --why "Rule of PL1 met." --evidence RS1 RS2
107
+ claimset lab summary # current state, for whoever picks up the work
108
+ claimset lab verify # hash chain, rules and run files
109
+ ```
110
+
111
+ A confirmatory plan fixes everything that decides the outcome before any run: the test, significance level, sidedness, correction for multiple tests, sample size and stopping rule, the results the decision is made on, and the rules for *supported* and *not supported* (anything else is *inconclusive*). The tool computes the verdict from those rules and refuses a status that disagrees or a second attempt at a decided test, and every planned test that ran is exported as a claim, whatever its result. Exploration stays light: record the runs you learn from; nothing else is enforced. Weaknesses that do not break a rule are flagged rather than refused: code changed after the plan, held-out data used elsewhere, a test that reproduced the result that suggested its hypothesis; `plan`, `run` and `verdict` also warn about a hypothesis from exploration without `--new-data`, exclusions without counts and the same computation run under two plans.
112
+
113
+ `run` records the command, code version, environment and every output file, and turns the numbers the script writes to `$CLAIMSET_RESULTS` into result events. The log is append-only and hash-chained; the tool refuses writes that break the rules (e.g. confirming a hypothesis with the result that suggested it).
114
+
115
+ When the research is done, draft the claimset from the record:
116
+
117
+ ```
118
+ claimset lab export -o claimset.json
119
+ ```
120
+
121
+ The draft carries everything the record states: a claim for every tested hypothesis (negative results included) with its outcome and whether the test was planned, evidence with the runs and results behind it, contributors, models and the exploration counts. Export also prints a completion list of what only people or the writing agent can decide: licence, guarantor, principal claims, the highlights a reader sees first (up to five, chosen by the guarantor), wording and scope. The `claimset-submit` skill works through it.
122
+
123
+ Several agents working at once each keep their own log, merged when they finish:
124
+
125
+ ```
126
+ claimset lab start --by AC2 # AC2's events now go to lab/agents/AC2.jsonl, with IDs like AC2.H1
127
+ claimset lab start --by AC3
128
+ claimset lab merge # appends both logs to the main log, interleaved by time
129
+ ```
130
+
131
+ An agent sees the main log as it was when it started, plus its own events. The merge is refused as a whole if any event no longer fits the main log, and `verify` checks that every merged event matches its agent log.
132
+
133
+ ### Answering a review
134
+
135
+ A published claimset is reviewed, and every comment states in advance what evidence would settle it. The author may answer with a revised version and a response; reviews, responses and versions are kept side by side, never rewritten, and the reviewer's score of each claim rests on comments the author can answer. The commands read the claimset's record folder (`v1/claimset.json`, `v1/reviews/RV1.json`, …):
136
+
137
+ ```
138
+ claimset revision status <record> # comments, their states and tests; what to answer
139
+ claimset lab plan --kind confirmatory --hypotheses H9 --comment doi:…@v1/RV1.c2 --review RV1.json --analysis "…"
140
+ # run a comment's resolution test as a planned test
141
+ claimset revision respond <record> --revision revised.json --lab lab.jsonl -o response.json
142
+ claimset revision check <record> --revision revised.json --response response.json --lab lab.jsonl
143
+ ```
144
+
145
+ ### Protecting the lab record
146
+
147
+ The hash chain makes any edit to the log detectable. Three optional layers stop edits from happening or make them impossible to hide (spec §4.5):
148
+
149
+ ```
150
+ claimset lab anchor --git # push the log to a `claimset-lab` branch after every plan
151
+ claimset lab verify --remote # check the local log against the anchored copy
152
+ claimset lab protect # append-only attribute on the log files (Linux, needs sudo)
153
+ ```
154
+
155
+ - **Anchoring** commits the log to its own branch without touching your working tree and never force-pushes. A confirmatory run is refused until its plan has been anchored, so the plan provably existed before the results. Protect the branch on your git host against force-pushes and deletion to make the remote copy append-only.
156
+ - **The guard** is a hook for agent harnesses that refuses tool calls that would edit or delete files in the lab directory other than through `claimset lab`. `claimset init --guard --agent NAME` installs it for Claude Code, Codex, Gemini CLI, Qwen Code, opencode, GitHub Copilot, Cursor or Cline (`claimset lab guard --print-config --agent NAME` prints the configuration instead). Codex, Gemini CLI, Qwen Code and Copilot run a project's hooks only once you trust them.
157
+ - **The append-only attribute** makes the kernel refuse anything but appending, as long as the agent cannot use `sudo`.
158
+
159
+ ## For AI agents
160
+
161
+ `skills/claimset-submit/` teaches an agent to turn finished research, or a lab record, into a valid claimset submission. It is self-contained: `claimset init` installs it where your agent reads skills, or copy the folder there yourself. Agents without skills support are pointed at its `SKILL.md` by the block `claimset init` writes to `AGENTS.md`.
162
+
163
+ `skills/claimset-lab/` teaches an agent to keep a lab record while it does research: registering itself honestly, planning before testing, running code through the tool, recording failures and negative results, working alongside other agents, and handing over to `claimset-submit` at the end. It bundles a copy of the `claimset` package, so it works without installing anything (`python3 scripts/claimset lab ...`).
164
+
165
+ `skills/claimset-revise/` teaches an agent to answer the reviews of a published claimset: settling each comment with evidence (running its resolution test as a planned test where it can be computed), building the revised version and writing the response. It bundles the package too.
166
+
167
+ `skills/claimset-review/` is the platform's reviewer, published so that every author can see how a claimset is reviewed and review their own before submitting: what to check, how to write a comment whose resolution test either side could run, how to judge an author's answers, and how every score below 100 rests on comments. Each review names the version of the skill it followed.
168
+
169
+ ## Contributing
170
+
171
+ - The specifications in `spec/` are the source of truth; the validator implements them and the tests check both.
172
+ - After changing the validator, a spec, an example or a template in `agents/`, run `python3 tools/sync_skills.py` to update the copies bundled in the skills and the package.
173
+ - Run the tests with `python3 -m unittest discover -s tests`.
174
+ - Releasing, in two stages:
175
+ 1. Set the version in `pyproject.toml` and `src/claimset/__init__.py` and merge. Then run the `build` workflow by hand on `main` (Actions > build > Run workflow): it runs the tests, builds the sdist and wheel, tries the wheel in a clean environment and drafts the GitHub release `v<version>` for that commit, with both files attached. Run again while it is a draft, it replaces the draft; a published version is never rebuilt.
176
+ 2. Review the draft and publish it. Publishing creates the tag `v<version>` on the commit that was built, and the `release` workflow checks that the files are the ones `build` made from that commit and uploads them to PyPI by trusted publishing (no token; set up once on PyPI and as a `pypi` environment on GitHub, see `.github/workflows/release.yml`).
177
+ - Planned work is tracked in [issues labelled `roadmap`](https://github.com/entrylib/claimset/issues?q=is%3Aissue+label%3Aroadmap).
178
+
179
+ ## Licence
180
+
181
+ Code is licensed under the Apache License 2.0 (`LICENSE`). The specifications in `spec/` are licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
@@ -0,0 +1,33 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "claimset"
7
+ version = "0.40.0"
8
+ description = "Tools for Claimset, an open format for research papers written by and for LLMs: validation, lab records and export."
9
+ readme = "README.md"
10
+ license = "Apache-2.0"
11
+ license-files = ["LICENSE"]
12
+ requires-python = ">=3.10"
13
+ authors = [{name = "Claimset contributors"}]
14
+ keywords = ["research", "scholarly communication", "LLM", "agents", "claims", "reproducibility"]
15
+ classifiers = [
16
+ "Programming Language :: Python :: 3",
17
+ "Operating System :: OS Independent",
18
+ "Topic :: Scientific/Engineering",
19
+ ]
20
+ dependencies = []
21
+
22
+ [project.urls]
23
+ Homepage = "https://github.com/entrylib/claimset"
24
+ Issues = "https://github.com/entrylib/claimset/issues"
25
+
26
+ [project.scripts]
27
+ claimset = "claimset.cli:main"
28
+
29
+ [tool.setuptools.packages.find]
30
+ where = ["src"]
31
+
32
+ [tool.setuptools.package-data]
33
+ claimset = ["data/spec/*.md", "data/spec/extensions/*.md", "data/examples/*.json", "data/skills/*/SKILL.md", "data/skills/claimset-lab/claimset", "data/agents/*"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,12 @@
1
+ """Claimset: an open format for research papers written by and for LLMs."""
2
+
3
+ __version__ = "0.40.0"
4
+
5
+ #: Version of the claimset specification this package implements.
6
+ SPEC_VERSION = "0.40"
7
+
8
+ #: Version of the lab record specification this package implements.
9
+ LAB_SPEC_VERSION = "0.21"
10
+
11
+ #: Version of the revision specification (reviews, responses, revised versions and scores) this package implements.
12
+ REVISION_SPEC_VERSION = "0.6"