samplekit 1.0.0rc2__cp315-cp315-win_amd64.whl
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.
- samplekit/__init__.py +405 -0
- samplekit/__init__.pyi +2218 -0
- samplekit/_figure.py +173 -0
- samplekit/_figures.py +2066 -0
- samplekit/_native.cp315-win_amd64.pyd +0 -0
- samplekit/_script.py +231 -0
- samplekit/_scripts.py +212 -0
- samplekit/_worker.py +1458 -0
- samplekit/py.typed +0 -0
- samplekit-1.0.0rc2.dist-info/METADATA +196 -0
- samplekit-1.0.0rc2.dist-info/RECORD +15 -0
- samplekit-1.0.0rc2.dist-info/WHEEL +4 -0
- samplekit-1.0.0rc2.dist-info/licenses/LICENSE +21 -0
- samplekit-1.0.0rc2.dist-info/licenses/THIRD-PARTY-LICENSES.md +2496 -0
- samplekit-1.0.0rc2.dist-info/sboms/samplekit.cyclonedx.json +10882 -0
samplekit/py.typed
ADDED
|
File without changes
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: samplekit
|
|
3
|
+
Version: 1.0.0rc2
|
|
4
|
+
Classifier: Development Status :: 4 - Beta
|
|
5
|
+
Classifier: Intended Audience :: Science/Research
|
|
6
|
+
Classifier: Operating System :: OS Independent
|
|
7
|
+
Classifier: Programming Language :: Python :: 3
|
|
8
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
9
|
+
Classifier: Programming Language :: Rust
|
|
10
|
+
Classifier: Topic :: Scientific/Engineering
|
|
11
|
+
Requires-Dist: matplotlib>=3.8
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
License-File: THIRD-PARTY-LICENSES.md
|
|
14
|
+
Summary: Sample data in plain Markdown: computed, current, tracked
|
|
15
|
+
Keywords: samples,notebook,markdown,uncertainty
|
|
16
|
+
Home-Page: https://zelyph.github.io/SampleKit/
|
|
17
|
+
Author: zelyph
|
|
18
|
+
License-Expression: MIT
|
|
19
|
+
Requires-Python: >=3.11
|
|
20
|
+
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
|
|
21
|
+
Project-URL: Changelog, https://github.com/zelyph/SampleKit/blob/main/CHANGELOG.md
|
|
22
|
+
Project-URL: Documentation, https://zelyph.github.io/SampleKit/latest/
|
|
23
|
+
Project-URL: Homepage, https://github.com/zelyph/SampleKit
|
|
24
|
+
Project-URL: Issues, https://github.com/zelyph/SampleKit/issues
|
|
25
|
+
|
|
26
|
+
# SampleKit
|
|
27
|
+
|
|
28
|
+
**Sample data in plain Markdown: computed, current, tracked.**
|
|
29
|
+
|
|
30
|
+
Which value was computed from which measurement? Was this table made before or
|
|
31
|
+
after the thickness was measured again? Is the figure in the draft still
|
|
32
|
+
right? SampleKit answers these questions for a folder of plain text files:
|
|
33
|
+
one sample, one Markdown file, readable in any editor, in Obsidian, and in
|
|
34
|
+
git.
|
|
35
|
+
|
|
36
|
+
```yaml
|
|
37
|
+
---
|
|
38
|
+
schema_version: 1
|
|
39
|
+
name: copper-01
|
|
40
|
+
material: copper
|
|
41
|
+
compared_with: "[[steel-01]]"
|
|
42
|
+
properties:
|
|
43
|
+
width: {readings: [12.509, 12.498, 12.506], unit: mm}
|
|
44
|
+
thickness: {readings: [1.995, 1.988, 2.007], unit: mm}
|
|
45
|
+
---
|
|
46
|
+
Tested at 2 mm/min, across the rolling direction.
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Above the second `---` are the sample's data: attributes, values with their
|
|
50
|
+
uncertainties and units, readings, tables of measurements. Below is a note
|
|
51
|
+
that is yours, kept as you write it. A folder of such files is a project,
|
|
52
|
+
with no database and nothing to set up.
|
|
53
|
+
|
|
54
|
+
## What it does
|
|
55
|
+
|
|
56
|
+
- **Computed**: the values that derive from your measurements, an area, a
|
|
57
|
+
modulus, a whole column of stress, come from formulas you write in Python,
|
|
58
|
+
uncertainties included.
|
|
59
|
+
- **Current**: SampleKit knows which results still rest on the measurements
|
|
60
|
+
they were computed from, and says which do not, and why.
|
|
61
|
+
- **Tracked**: every change it writes is kept in a history of the project's
|
|
62
|
+
own, with the command that made it, and no git to install. `--at` reads the
|
|
63
|
+
project as it was, and makes a table or a figure again exactly as it was.
|
|
64
|
+
- **Tables and figures**: select, sort and group samples, then write a CSV, a
|
|
65
|
+
LaTeX or Markdown table, or a matplotlib figure, in one style for the whole
|
|
66
|
+
project, by one command you run again at each draft.
|
|
67
|
+
- **Linked**: a sample names another, a file or a web page, as Obsidian and
|
|
68
|
+
Markdown write a link; SampleKit follows it both ways, checks it, and keeps
|
|
69
|
+
it when a sample is renamed.
|
|
70
|
+
- **Three ways in**: a command line, a full-screen terminal interface, and a
|
|
71
|
+
Python package reading the same files with the same names.
|
|
72
|
+
|
|
73
|
+
## A taste
|
|
74
|
+
|
|
75
|
+
From the last step of the demo, three tensile specimens:
|
|
76
|
+
|
|
77
|
+
```console
|
|
78
|
+
$ samplekit -c name,material,tensile_strength -s -tensile_strength # a table, sorted
|
|
79
|
+
$ samplekit -f 'elongation > 20' # the specimens a filter selects
|
|
80
|
+
$ samplekit status # what is not current, and why
|
|
81
|
+
$ samplekit compute --write # run the project's Python model
|
|
82
|
+
$ samplekit export paper --write # a LaTeX table for a paper
|
|
83
|
+
$ samplekit samples/steel-01.md view curve --csv # a sample's curve, as CSV
|
|
84
|
+
$ samplekit samples/steel-01.md log # every change kept, and what made it
|
|
85
|
+
$ samplekit # the terminal interface, full screen
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
import samplekit as sk
|
|
90
|
+
|
|
91
|
+
for specimen in sk.load("samples").filter("elongation > 20"):
|
|
92
|
+
print(specimen.name, specimen.young_modulus.value, specimen.young_modulus.uncertainty)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Install
|
|
96
|
+
|
|
97
|
+
The command line is one file: download it for Linux, macOS or Windows from
|
|
98
|
+
[the releases](https://github.com/zelyph/SampleKit/releases), or build it with
|
|
99
|
+
Rust:
|
|
100
|
+
|
|
101
|
+
```console
|
|
102
|
+
$ cargo install samplekit --locked --version VERSION
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
The Python package goes into each project's `.venv/`, at the version of the
|
|
106
|
+
command line, `VERSION` being what `samplekit --version` says; `samplekit
|
|
107
|
+
init` makes that environment and installs it for you:
|
|
108
|
+
|
|
109
|
+
```console
|
|
110
|
+
$ pip install samplekit==VERSION
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
> **Until 1.0, name the version.** `pip install samplekit` alone gives 0.2.0,
|
|
114
|
+
> the previous version, whose API is not this one; likewise the *Latest*
|
|
115
|
+
> release on GitHub is 0.2.0, and this version's archives are under its own
|
|
116
|
+
> release, marked *pre-release*.
|
|
117
|
+
|
|
118
|
+
[Install SampleKit](https://zelyph.github.io/SampleKit/latest/guides/install.html)
|
|
119
|
+
says more, system by system. **From an earlier version**, 0.x or 1.0.0-rc.1,
|
|
120
|
+
`samplekit-migrate.pyz`, in each release, carries a project into a new
|
|
121
|
+
folder this version reads, and says what to check by hand
|
|
122
|
+
([upgrade](https://zelyph.github.io/SampleKit/latest/guides/upgrade.html)).
|
|
123
|
+
It never writes in the folder it reads; back your project up all the same.
|
|
124
|
+
|
|
125
|
+
## Try the demo
|
|
126
|
+
|
|
127
|
+
`samplekit` alone opens its start page; `g`, then *The demo*, writes a
|
|
128
|
+
tensile test in five steps, from three specimens measured by hand to their
|
|
129
|
+
curves, results, a paper's tables and figures, and opens the first.
|
|
130
|
+
[The documentation](https://zelyph.github.io/SampleKit/latest/) walks
|
|
131
|
+
through it, then goes further: guides a task each, the concepts, and the
|
|
132
|
+
reference.
|
|
133
|
+
|
|
134
|
+
## Where things are
|
|
135
|
+
|
|
136
|
+
| | |
|
|
137
|
+
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
138
|
+
| [`docs/`](https://zelyph.github.io/SampleKit/latest/index.html) | The documentation: the home page's walkthrough of the demo, [guides](https://zelyph.github.io/SampleKit/latest/guides/index.html), [concepts](https://zelyph.github.io/SampleKit/latest/concepts/index.html) and the [reference](https://zelyph.github.io/SampleKit/latest/reference/index.html) |
|
|
139
|
+
| `src/`, `tests/` | The Rust crate: the core, the command line, the terminal interface and the Rust half of the Python package; a test file per source file |
|
|
140
|
+
| `python/samplekit/` | The Python half of the Python package |
|
|
141
|
+
| [`examples/tensile/`](https://github.com/zelyph/SampleKit/blob/main/examples/tensile/README.md) | The demo, in five steps, generated from `fixtures/tensile/`; the start page writes it for you |
|
|
142
|
+
| `fixtures/tensile/` | What the demo is generated from: its model, scripts and READMEs, and the generator |
|
|
143
|
+
| [`migrate/`](https://github.com/zelyph/SampleKit/blob/main/migrate/README.md) | The migration tool, `samplekit-migrate.pyz` in each release |
|
|
144
|
+
|
|
145
|
+
## Building
|
|
146
|
+
|
|
147
|
+
```console
|
|
148
|
+
$ cargo build --release # the command line: target/release/samplekit
|
|
149
|
+
$ python -m venv .venv && source .venv/bin/activate
|
|
150
|
+
$ pip install maturin
|
|
151
|
+
$ maturin develop --release # the Python package, into .venv
|
|
152
|
+
$ tools/check.sh # everything a commit must pass
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
The documentation is a Sphinx site, built from `docs/` into `target/site`,
|
|
156
|
+
after `maturin develop`, since the Python reference reads the package:
|
|
157
|
+
|
|
158
|
+
```console
|
|
159
|
+
$ .venv/bin/pip install -r docs/requirements.txt
|
|
160
|
+
$ .venv/bin/sphinx-build docs target/site
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
The command line needs no Python to read, select, render, check or export;
|
|
164
|
+
Python runs a project's model, and matplotlib draws its figures.
|
|
165
|
+
|
|
166
|
+
## Status
|
|
167
|
+
|
|
168
|
+
Version `1.0.0-rc.2` (`1.0.0rc2` as Python spells it), the second release
|
|
169
|
+
candidate of `1.0.0`. It follows `0.2.0`, the previous implementation, in
|
|
170
|
+
Python alone, published under the same name. What changed is in
|
|
171
|
+
[CHANGELOG.md](https://github.com/zelyph/SampleKit/blob/main/CHANGELOG.md).
|
|
172
|
+
|
|
173
|
+
## Roadmap
|
|
174
|
+
|
|
175
|
+
In order of priority:
|
|
176
|
+
|
|
177
|
+
- [ ] **1.0**: this release candidate, tried, then published as `1.0.0`;
|
|
178
|
+
from then on, `pip install samplekit` gives it without naming a version.
|
|
179
|
+
- [ ] **Designs of experiments**: full and
|
|
180
|
+
fractional factorials, central composite, Box-Behnken, definitive
|
|
181
|
+
screening and mixture designs, with centre points, replicates, blocks and
|
|
182
|
+
a randomised order. SampleKit lays out a plan's runs, makes a sample of
|
|
183
|
+
each, takes in the samples already made, says which runs are still to
|
|
184
|
+
make, and analyses what they measured: a model per response, reduced and
|
|
185
|
+
tested term by term, its residuals examined, then used to predict,
|
|
186
|
+
optimise and draw; in the terminal interface and from Python too.
|
|
187
|
+
- [ ] **An Obsidian plugin**, so that a project opened as a vault shows its
|
|
188
|
+
properties and tables as SampleKit does, hides what only SampleKit reads,
|
|
189
|
+
such as `schema_version`, and edits them.
|
|
190
|
+
|
|
191
|
+
## Licence
|
|
192
|
+
|
|
193
|
+
MIT: see [LICENSE](https://github.com/zelyph/SampleKit/blob/main/LICENSE).
|
|
194
|
+
Keep the notice with any copy; everything else is permitted, including
|
|
195
|
+
commercial use.
|
|
196
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
samplekit/__init__.py,sha256=Jrtctx0Fjew5sXr4vssq9I5aNEDXW84tfO-cLUo87q8,12539
|
|
2
|
+
samplekit/__init__.pyi,sha256=XiFPdkMbKDzbQcNVXueW6niPYcLqyRW8lBvPF3dQPn8,85978
|
|
3
|
+
samplekit/_figure.py,sha256=AzZ4_0adhYMrsw4w3H3n8a-EOe2FDi8jrvZZKHwHg5I,6975
|
|
4
|
+
samplekit/_figures.py,sha256=49NJBG5ELC-DhIN1wKji6Ry407u2D4Tr9DRlf1_c4kA,85809
|
|
5
|
+
samplekit/_native.cp315-win_amd64.pyd,sha256=n94sKSrb8hn6ItVwoaKsoyNzg5QTBekFQT9-E1qTxyQ,14072320
|
|
6
|
+
samplekit/_script.py,sha256=Mp6-504M3kE2KGU6DCgIgun_4whWm2Af6UCVoCGySkA,7994
|
|
7
|
+
samplekit/_scripts.py,sha256=pbNRpUrcE6yu9r_Y85FZPnh1aKeM00-G4yr5qKHna5I,7726
|
|
8
|
+
samplekit/_worker.py,sha256=iYvOnxmvgqRXIi_HZe0-4g0LioyL5Omr9bzfXQiM7IY,59485
|
|
9
|
+
samplekit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
10
|
+
samplekit-1.0.0rc2.dist-info/METADATA,sha256=3WNbUL5Nd9b3wRBFV0aK_h4drsltZEXuatX2jeP0kmA,10877
|
|
11
|
+
samplekit-1.0.0rc2.dist-info/WHEEL,sha256=Q5QdGvjBfn8x6ihg-B4VQuuGKk7DT67L9DVrwEH_qj8,97
|
|
12
|
+
samplekit-1.0.0rc2.dist-info/licenses/LICENSE,sha256=y-2RDiB6Le29GZ_g31YgsDS0MnW41VAR_wzKGWbgbgU,1063
|
|
13
|
+
samplekit-1.0.0rc2.dist-info/licenses/THIRD-PARTY-LICENSES.md,sha256=HGN01unPqPxTu3qJi1Y7Vx9IP14Gzg1n83edEFBuW2U,127199
|
|
14
|
+
samplekit-1.0.0rc2.dist-info/sboms/samplekit.cyclonedx.json,sha256=v_4m0rXabKi_UlgZ-sjX373CG8BrNaHe63KiFKHw9KA,356508
|
|
15
|
+
samplekit-1.0.0rc2.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 zelyph
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|