labrecipe 0.1.1__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 (146) hide show
  1. labrecipe-0.1.1/.github/dependabot.yml +18 -0
  2. labrecipe-0.1.1/.github/workflows/ci.yml +68 -0
  3. labrecipe-0.1.1/.github/workflows/release.yml +96 -0
  4. labrecipe-0.1.1/.gitignore +13 -0
  5. labrecipe-0.1.1/.python-version +1 -0
  6. labrecipe-0.1.1/CHANGELOG.md +36 -0
  7. labrecipe-0.1.1/CITATION.cff +24 -0
  8. labrecipe-0.1.1/CODE_OF_CONDUCT.md +108 -0
  9. labrecipe-0.1.1/CONTRIBUTING.md +52 -0
  10. labrecipe-0.1.1/DEVELOPMENT.md +55 -0
  11. labrecipe-0.1.1/LICENSE +201 -0
  12. labrecipe-0.1.1/PKG-INFO +127 -0
  13. labrecipe-0.1.1/README.md +84 -0
  14. labrecipe-0.1.1/RELEASING.md +51 -0
  15. labrecipe-0.1.1/SECURITY.md +38 -0
  16. labrecipe-0.1.1/docs/cli-api.md +58 -0
  17. labrecipe-0.1.1/docs/conf.py +32 -0
  18. labrecipe-0.1.1/docs/index.md +20 -0
  19. labrecipe-0.1.1/docs/methods.md +63 -0
  20. labrecipe-0.1.1/docs/quickstart.md +67 -0
  21. labrecipe-0.1.1/docs/recipe-schema.md +64 -0
  22. labrecipe-0.1.1/docs/reproducibility.md +67 -0
  23. labrecipe-0.1.1/docs/troubleshooting.md +54 -0
  24. labrecipe-0.1.1/examples/README.md +35 -0
  25. labrecipe-0.1.1/examples/clean_time_series/data.csv +6 -0
  26. labrecipe-0.1.1/examples/clean_time_series/expected.json +18 -0
  27. labrecipe-0.1.1/examples/clean_time_series/recipe.yaml +92 -0
  28. labrecipe-0.1.1/examples/data_manifest.json +46 -0
  29. labrecipe-0.1.1/examples/dirty_time_series/data.csv +10 -0
  30. labrecipe-0.1.1/examples/dirty_time_series/expected.json +41 -0
  31. labrecipe-0.1.1/examples/dirty_time_series/recipe.yaml +122 -0
  32. labrecipe-0.1.1/examples/grouped_sweep/data.tsv +13 -0
  33. labrecipe-0.1.1/examples/grouped_sweep/expected.json +24 -0
  34. labrecipe-0.1.1/examples/grouped_sweep/recipe.yaml +118 -0
  35. labrecipe-0.1.1/examples/xlsx_named_range/data.xlsx +0 -0
  36. labrecipe-0.1.1/examples/xlsx_named_range/expected.json +26 -0
  37. labrecipe-0.1.1/examples/xlsx_named_range/recipe.yaml +114 -0
  38. labrecipe-0.1.1/pyproject.toml +140 -0
  39. labrecipe-0.1.1/scripts/export_recipe_schema.py +53 -0
  40. labrecipe-0.1.1/scripts/smoke_built_wheel.py +255 -0
  41. labrecipe-0.1.1/src/labrecipe/__init__.py +172 -0
  42. labrecipe-0.1.1/src/labrecipe/analyses/__init__.py +16 -0
  43. labrecipe-0.1.1/src/labrecipe/analyses/builtins.py +25 -0
  44. labrecipe-0.1.1/src/labrecipe/analyses/candidates.py +529 -0
  45. labrecipe-0.1.1/src/labrecipe/analyses/common.py +26 -0
  46. labrecipe-0.1.1/src/labrecipe/analyses/eda.py +547 -0
  47. labrecipe-0.1.1/src/labrecipe/analyses/models.py +205 -0
  48. labrecipe-0.1.1/src/labrecipe/analyses/runner.py +246 -0
  49. labrecipe-0.1.1/src/labrecipe/analyses/summary.py +983 -0
  50. labrecipe-0.1.1/src/labrecipe/api.py +148 -0
  51. labrecipe-0.1.1/src/labrecipe/artifacts.py +497 -0
  52. labrecipe-0.1.1/src/labrecipe/bundle.py +562 -0
  53. labrecipe-0.1.1/src/labrecipe/cli.py +283 -0
  54. labrecipe-0.1.1/src/labrecipe/data/__init__.py +19 -0
  55. labrecipe-0.1.1/src/labrecipe/data/excel.py +632 -0
  56. labrecipe-0.1.1/src/labrecipe/data/inspect.py +450 -0
  57. labrecipe-0.1.1/src/labrecipe/data/models.py +180 -0
  58. labrecipe-0.1.1/src/labrecipe/data/sources.py +283 -0
  59. labrecipe-0.1.1/src/labrecipe/data/validate.py +188 -0
  60. labrecipe-0.1.1/src/labrecipe/diagnostics.py +131 -0
  61. labrecipe-0.1.1/src/labrecipe/engine.py +157 -0
  62. labrecipe-0.1.1/src/labrecipe/errors.py +135 -0
  63. labrecipe-0.1.1/src/labrecipe/hashing.py +67 -0
  64. labrecipe-0.1.1/src/labrecipe/plan.py +776 -0
  65. labrecipe-0.1.1/src/labrecipe/provenance.py +824 -0
  66. labrecipe-0.1.1/src/labrecipe/py.typed +0 -0
  67. labrecipe-0.1.1/src/labrecipe/randomness.py +202 -0
  68. labrecipe-0.1.1/src/labrecipe/recipe/__init__.py +38 -0
  69. labrecipe-0.1.1/src/labrecipe/recipe/canonical.py +106 -0
  70. labrecipe-0.1.1/src/labrecipe/recipe/loader.py +225 -0
  71. labrecipe-0.1.1/src/labrecipe/recipe/models.py +405 -0
  72. labrecipe-0.1.1/src/labrecipe/registry.py +373 -0
  73. labrecipe-0.1.1/src/labrecipe/resources/labrecipe.mplstyle +11 -0
  74. labrecipe-0.1.1/src/labrecipe/resources/recipe.schema.json +713 -0
  75. labrecipe-0.1.1/src/labrecipe/science.py +82 -0
  76. labrecipe-0.1.1/src/labrecipe/serialization.py +382 -0
  77. labrecipe-0.1.1/src/labrecipe/transforms/__init__.py +26 -0
  78. labrecipe-0.1.1/src/labrecipe/transforms/baseline.py +600 -0
  79. labrecipe-0.1.1/src/labrecipe/transforms/builtins.py +49 -0
  80. labrecipe-0.1.1/src/labrecipe/transforms/convert.py +328 -0
  81. labrecipe-0.1.1/src/labrecipe/transforms/grouping.py +313 -0
  82. labrecipe-0.1.1/src/labrecipe/transforms/lineage.py +78 -0
  83. labrecipe-0.1.1/src/labrecipe/transforms/missing.py +353 -0
  84. labrecipe-0.1.1/src/labrecipe/transforms/models.py +313 -0
  85. labrecipe-0.1.1/src/labrecipe/transforms/normalize.py +540 -0
  86. labrecipe-0.1.1/src/labrecipe/transforms/runner.py +429 -0
  87. labrecipe-0.1.1/src/labrecipe/transforms/signal.py +537 -0
  88. labrecipe-0.1.1/src/labrecipe/transforms/smooth.py +481 -0
  89. labrecipe-0.1.1/src/labrecipe/transforms/structural.py +532 -0
  90. labrecipe-0.1.1/src/labrecipe/units.py +19 -0
  91. labrecipe-0.1.1/src/labrecipe/visualization/__init__.py +22 -0
  92. labrecipe-0.1.1/src/labrecipe/visualization/builtins.py +50 -0
  93. labrecipe-0.1.1/src/labrecipe/visualization/models.py +201 -0
  94. labrecipe-0.1.1/src/labrecipe/visualization/renderer.py +503 -0
  95. labrecipe-0.1.1/tests/example_assertions.py +242 -0
  96. labrecipe-0.1.1/tests/fixtures/blank-lines.csv +4 -0
  97. labrecipe-0.1.1/tests/fixtures/clean.csv +4 -0
  98. labrecipe-0.1.1/tests/fixtures/clean.tsv +4 -0
  99. labrecipe-0.1.1/tests/fixtures/dirty.csv +8 -0
  100. labrecipe-0.1.1/tests/fixtures/grouped-transform.csv +19 -0
  101. labrecipe-0.1.1/tests/fixtures/grouped.csv +8 -0
  102. labrecipe-0.1.1/tests/fixtures/multiline.csv +4 -0
  103. labrecipe-0.1.1/tests/fixtures/recipe-clean.yaml +40 -0
  104. labrecipe-0.1.1/tests/fixtures/recipe-complete.yaml +62 -0
  105. labrecipe-0.1.1/tests/fixtures/recipe-dirty.yaml +39 -0
  106. labrecipe-0.1.1/tests/fixtures/recipe-transforms.yaml +108 -0
  107. labrecipe-0.1.1/tests/test_analysis_models.py +302 -0
  108. labrecipe-0.1.1/tests/test_artifact_store.py +141 -0
  109. labrecipe-0.1.1/tests/test_bundle.py +186 -0
  110. labrecipe-0.1.1/tests/test_candidate_analysis.py +226 -0
  111. labrecipe-0.1.1/tests/test_cli.py +171 -0
  112. labrecipe-0.1.1/tests/test_cli_api_parity.py +109 -0
  113. labrecipe-0.1.1/tests/test_community_files.py +172 -0
  114. labrecipe-0.1.1/tests/test_diagnostics.py +77 -0
  115. labrecipe-0.1.1/tests/test_distribution.py +228 -0
  116. labrecipe-0.1.1/tests/test_docs.py +162 -0
  117. labrecipe-0.1.1/tests/test_eda_analysis.py +234 -0
  118. labrecipe-0.1.1/tests/test_engine_modes.py +247 -0
  119. labrecipe-0.1.1/tests/test_example_inventory.py +111 -0
  120. labrecipe-0.1.1/tests/test_examples.py +94 -0
  121. labrecipe-0.1.1/tests/test_excel_source.py +354 -0
  122. labrecipe-0.1.1/tests/test_hashing.py +37 -0
  123. labrecipe-0.1.1/tests/test_inspection.py +209 -0
  124. labrecipe-0.1.1/tests/test_missing_transforms.py +318 -0
  125. labrecipe-0.1.1/tests/test_normalize_baseline.py +500 -0
  126. labrecipe-0.1.1/tests/test_plan.py +212 -0
  127. labrecipe-0.1.1/tests/test_provenance.py +344 -0
  128. labrecipe-0.1.1/tests/test_public_api.py +153 -0
  129. labrecipe-0.1.1/tests/test_randomness.py +113 -0
  130. labrecipe-0.1.1/tests/test_recipe_loader.py +118 -0
  131. labrecipe-0.1.1/tests/test_recipe_models.py +111 -0
  132. labrecipe-0.1.1/tests/test_scientific_api.py +236 -0
  133. labrecipe-0.1.1/tests/test_serialization.py +288 -0
  134. labrecipe-0.1.1/tests/test_signal_transforms.py +213 -0
  135. labrecipe-0.1.1/tests/test_smoothing_transforms.py +205 -0
  136. labrecipe-0.1.1/tests/test_sources.py +170 -0
  137. labrecipe-0.1.1/tests/test_structural_transforms.py +336 -0
  138. labrecipe-0.1.1/tests/test_summary_analysis.py +409 -0
  139. labrecipe-0.1.1/tests/test_transform_api.py +307 -0
  140. labrecipe-0.1.1/tests/test_transform_contract.py +357 -0
  141. labrecipe-0.1.1/tests/test_transform_runner.py +450 -0
  142. labrecipe-0.1.1/tests/test_unit_transform.py +313 -0
  143. labrecipe-0.1.1/tests/test_units.py +111 -0
  144. labrecipe-0.1.1/tests/test_visualization.py +353 -0
  145. labrecipe-0.1.1/tests/test_workflows.py +240 -0
  146. labrecipe-0.1.1/uv.lock +2200 -0
@@ -0,0 +1,18 @@
1
+ version: 2
2
+ updates:
3
+ - package-ecosystem: pip
4
+ directory: /
5
+ schedule:
6
+ interval: monthly
7
+ labels:
8
+ - dependencies
9
+ groups:
10
+ python-dependencies:
11
+ patterns:
12
+ - "*"
13
+ - package-ecosystem: github-actions
14
+ directory: /
15
+ schedule:
16
+ interval: monthly
17
+ labels:
18
+ - dependencies
@@ -0,0 +1,68 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ pull_request:
6
+
7
+ permissions:
8
+ contents: read
9
+
10
+ jobs:
11
+ quality:
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
15
+ with:
16
+ persist-credentials: false
17
+ - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
18
+ with:
19
+ python-version: "3.13"
20
+ - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
21
+ with:
22
+ version: "0.11.28"
23
+ enable-cache: true
24
+ - run: uv sync --frozen --no-install-project --all-groups --extra excel
25
+ - run: uv run --frozen ruff format --check .
26
+ - run: uv run --frozen ruff check src tests scripts
27
+ - run: uv run --frozen mypy
28
+ - run: uv run --frozen python -m pytest -W error -q
29
+ env:
30
+ MPLBACKEND: Agg
31
+ - run: uv run --frozen python scripts/export_recipe_schema.py --check
32
+ - run: uv run --frozen sphinx-build -E -W --keep-going -b html docs docs/_build/html
33
+ - run: uv run --frozen python -m build
34
+ - run: uv run --frozen twine check dist/*
35
+ - run: uv run --frozen python -m pytest tests/test_distribution.py tests/test_workflows.py -q
36
+ - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
37
+ with:
38
+ name: distributions
39
+ path: dist/*
40
+ if-no-files-found: error
41
+
42
+ compatibility:
43
+ strategy:
44
+ fail-fast: false
45
+ matrix:
46
+ os: [ubuntu-latest, macos-latest, windows-latest]
47
+ python: ["3.12", "3.13", "3.14"]
48
+ mode: [core, excel]
49
+ runs-on: ${{ matrix.os }}
50
+ steps:
51
+ - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
52
+ with:
53
+ persist-credentials: false
54
+ - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
55
+ with:
56
+ python-version: ${{ matrix.python }}
57
+ - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
58
+ with:
59
+ version: "0.11.28"
60
+ enable-cache: true
61
+ - run: uv sync --frozen --no-install-project --all-groups --extra excel
62
+ - run: uv run --frozen --no-sync python -m build --wheel --no-isolation --outdir wheelhouse
63
+ - run: >-
64
+ uv run --frozen --no-sync python scripts/smoke_built_wheel.py
65
+ --wheel wheelhouse/labrecipe-0.1.1-py3-none-any.whl
66
+ --mode ${{ matrix.mode }}
67
+ env:
68
+ MPLBACKEND: Agg
@@ -0,0 +1,96 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - "v*.*.*"
7
+
8
+ permissions:
9
+ contents: read
10
+
11
+ jobs:
12
+ build:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
16
+ with:
17
+ persist-credentials: false
18
+ - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
19
+ with:
20
+ python-version: "3.13"
21
+ - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
22
+ with:
23
+ version: "0.11.28"
24
+ enable-cache: true
25
+ - name: Install locked release environment
26
+ run: uv sync --frozen --no-install-project --all-groups --extra excel
27
+ - name: Require tag, package, and citation versions to match
28
+ env:
29
+ RELEASE_TAG: ${{ github.ref_name }}
30
+ run: |
31
+ uv run --frozen --no-sync python - <<'PY'
32
+ import os
33
+ import tomllib
34
+ from pathlib import Path
35
+ import yaml
36
+
37
+ version = tomllib.loads(Path("pyproject.toml").read_text())["project"]["version"]
38
+ citation_version = str(yaml.safe_load(Path("CITATION.cff").read_text())["version"])
39
+ assert os.environ["RELEASE_TAG"] == f"v{version}"
40
+ assert citation_version == version
41
+ PY
42
+ - run: uv run --frozen --no-sync python -m pytest -W error -q
43
+ env:
44
+ MPLBACKEND: Agg
45
+ - run: uv run --frozen --no-sync sphinx-build -E -W --keep-going -b html docs docs/_build/html
46
+ - name: Build one source archive and one wheel
47
+ run: uv run --frozen --no-sync python -m build --no-isolation
48
+ - run: uv run --frozen --no-sync twine check dist/*
49
+ - run: uv run --frozen --no-sync python -m pytest tests/test_distribution.py -q
50
+ - name: Smoke exact wheel in core and Excel environments
51
+ run: |
52
+ uv run --frozen --no-sync python scripts/smoke_built_wheel.py --wheel dist/labrecipe-0.1.1-py3-none-any.whl --mode core
53
+ uv run --frozen --no-sync python scripts/smoke_built_wheel.py --wheel dist/labrecipe-0.1.1-py3-none-any.whl --mode excel
54
+ - name: Assert release inventory and create checksums
55
+ run: |
56
+ uv run --frozen --no-sync python - <<'PY'
57
+ from pathlib import Path
58
+
59
+ files = sorted(path.name for path in Path("dist").iterdir() if path.is_file())
60
+ assert files == ["labrecipe-0.1.1-py3-none-any.whl", "labrecipe-0.1.1.tar.gz"]
61
+ PY
62
+ cd dist
63
+ sha256sum labrecipe-0.1.1-py3-none-any.whl labrecipe-0.1.1.tar.gz > SHA256SUMS
64
+ sha256sum -c SHA256SUMS
65
+ - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
66
+ with:
67
+ name: release-distributions
68
+ path: |
69
+ dist/labrecipe-0.1.1-py3-none-any.whl
70
+ dist/labrecipe-0.1.1.tar.gz
71
+ dist/SHA256SUMS
72
+ if-no-files-found: error
73
+
74
+ publish:
75
+ needs: build
76
+ runs-on: ubuntu-latest
77
+ environment:
78
+ name: pypi
79
+ url: https://pypi.org/project/labrecipe/
80
+ permissions:
81
+ contents: read
82
+ id-token: write
83
+ steps:
84
+ - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
85
+ with:
86
+ name: release-distributions
87
+ path: dist
88
+ - name: Verify downloaded artifact bytes
89
+ working-directory: dist
90
+ run: sha256sum -c SHA256SUMS
91
+ - name: Keep checksum metadata outside the package upload directory
92
+ run: mv dist/SHA256SUMS SHA256SUMS
93
+ - uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
94
+ with:
95
+ packages-dir: dist/
96
+ attestations: true
@@ -0,0 +1,13 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ .pytest_cache/
6
+ .ruff_cache/
7
+ .mypy_cache/
8
+ .coverage
9
+ htmlcov/
10
+ docs/_build/
11
+ build/
12
+ dist/
13
+ *.egg-info/
@@ -0,0 +1 @@
1
+ 3.13
@@ -0,0 +1,36 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
6
+ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ### Added
11
+
12
+ - Nothing yet.
13
+
14
+ ## [0.1.1] - 2026-07-15
15
+
16
+ ### Fixed
17
+
18
+ - Correct the immutable PyPI publish action pin to reference the signed v1.13.0 release's
19
+ underlying commit so its published container image can be resolved.
20
+
21
+ ## [0.1.0] - 2026-07-14
22
+
23
+ ### Added
24
+
25
+ - Strict versioned YAML recipes, immutable CSV/TSV and optional bounded XLSX ingestion.
26
+ - Explicit group-safe transforms, transparent analyses, candidate scoring, and evidence-bearing
27
+ figures.
28
+ - Deterministic evidence bundles with exact structural contracts, numerical tolerances,
29
+ provenance, and atomic publication.
30
+ - Equivalent Python and CLI validate, inspect, plan/explain, and run interfaces.
31
+ - Four executable representative example controls and warnings-as-errors documentation.
32
+ - Apache-2.0 licensing, contributor guidance, security policy, and citation metadata.
33
+
34
+ [Unreleased]: https://github.com/JK1234567899999/labrecipe/compare/v0.1.1...HEAD
35
+ [0.1.1]: https://github.com/JK1234567899999/labrecipe/releases/tag/v0.1.1
36
+ [0.1.0]: https://github.com/JK1234567899999/labrecipe/releases/tag/v0.1.0
@@ -0,0 +1,24 @@
1
+ cff-version: 1.2.0
2
+ message: If you use LabRecipe, please cite the software using this metadata.
3
+ title: LabRecipe
4
+ type: software
5
+ authors:
6
+ - name: LabRecipe contributors
7
+ version: 0.1.1
8
+ repository-code: https://github.com/JK1234567899999/labrecipe
9
+ url: https://github.com/JK1234567899999/labrecipe
10
+ license: Apache-2.0
11
+ keywords:
12
+ - reproducible research
13
+ - scientific Python
14
+ - experimental data
15
+ - time series
16
+ - provenance
17
+ preferred-citation:
18
+ type: software
19
+ title: LabRecipe
20
+ authors:
21
+ - name: LabRecipe contributors
22
+ version: 0.1.1
23
+ repository-code: https://github.com/JK1234567899999/labrecipe
24
+ license: Apache-2.0
@@ -0,0 +1,108 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a
6
+ harassment-free experience for everyone, regardless of age, body size, visible or invisible
7
+ disability, ethnicity, sex characteristics, gender identity and expression, level of
8
+ experience, education, socio-economic status, nationality, personal appearance, race,
9
+ religion, or sexual identity and orientation.
10
+
11
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse,
12
+ inclusive, and healthy community.
13
+
14
+ ## Our Standards
15
+
16
+ Examples of behavior that contributes to a positive environment for our community include:
17
+
18
+ - Demonstrating empathy and kindness toward other people
19
+ - Being respectful of differing opinions, viewpoints, and experiences
20
+ - Giving and gracefully accepting constructive feedback
21
+ - Accepting responsibility and apologizing to those affected by our mistakes, and learning
22
+ from the experience
23
+ - Focusing on what is best not just for us as individuals, but for the overall community
24
+
25
+ Examples of unacceptable behavior include:
26
+
27
+ - The use of sexualized language or imagery, and sexual attention or advances of any kind
28
+ - Trolling, insulting or derogatory comments, and personal or political attacks
29
+ - Public or private harassment
30
+ - Publishing others' private information, such as a physical or email address, without their
31
+ explicit permission
32
+ - Other conduct which could reasonably be considered inappropriate in a professional setting
33
+
34
+ ## Enforcement Responsibilities
35
+
36
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable
37
+ behavior and will take appropriate and fair corrective action in response to any behavior that
38
+ they deem inappropriate, threatening, offensive, or harmful.
39
+
40
+ Community leaders have the right and responsibility to remove, edit, or reject comments,
41
+ commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of
42
+ Conduct, and will communicate reasons for moderation decisions when appropriate.
43
+
44
+ ## Scope
45
+
46
+ This Code of Conduct applies within all community spaces, and also applies when an individual
47
+ is officially representing the community in public spaces. Examples of representing our
48
+ community include using an official email address, posting via an official social media
49
+ account, or acting as an appointed representative at an online or offline event.
50
+
51
+ ## Enforcement
52
+
53
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported privately
54
+ to the repository maintainers at
55
+ https://github.com/JK1234567899999/labrecipe/security/advisories/new. Mark the report as a Code of
56
+ Conduct matter. All complaints will be reviewed and investigated promptly and fairly.
57
+
58
+ All community leaders are obligated to respect the privacy and security of the reporter of any
59
+ incident.
60
+
61
+ ## Enforcement Guidelines
62
+
63
+ Community leaders will follow these Community Impact Guidelines in determining the
64
+ consequences for any action they deem in violation of this Code of Conduct:
65
+
66
+ ### 1. Correction
67
+
68
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional
69
+ or unwelcome in the community.
70
+
71
+ **Consequence**: A private, written warning from community leaders, providing clarity around
72
+ the nature of the violation and an explanation of why the behavior was inappropriate. A
73
+ public apology may be requested.
74
+
75
+ ### 2. Warning
76
+
77
+ **Community Impact**: A violation through a single incident or series of actions.
78
+
79
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the
80
+ people involved, including unsolicited interaction with those enforcing the Code of Conduct,
81
+ for a specified period of time. This includes avoiding interactions in community spaces as
82
+ well as external channels like social media. Violating these terms may lead to a temporary or
83
+ permanent ban.
84
+
85
+ ### 3. Temporary Ban
86
+
87
+ **Community Impact**: A serious violation of community standards, including sustained
88
+ inappropriate behavior.
89
+
90
+ **Consequence**: A temporary ban from any sort of interaction or public communication with
91
+ the community for a specified period of time. No public or private interaction with the
92
+ people involved, including unsolicited interaction with those enforcing the Code of Conduct,
93
+ is allowed during this period. Violating these terms may lead to a permanent ban.
94
+
95
+ ### 4. Permanent Ban
96
+
97
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including
98
+ sustained inappropriate behavior, harassment of an individual, or aggression toward or
99
+ disparagement of classes of individuals.
100
+
101
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
102
+
103
+ ## Attribution
104
+
105
+ This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at
106
+ https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
107
+
108
+ Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
@@ -0,0 +1,52 @@
1
+ # Contributing to LabRecipe
2
+
3
+ Thank you for improving transparent experimental-data analysis. By participating, you agree
4
+ to follow [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
5
+
6
+ ## Before opening work
7
+
8
+ 1. Search existing [issues](https://github.com/JK1234567899999/labrecipe/issues).
9
+ 2. Open or comment on an issue before a large change so scope and scientific intent are clear.
10
+ 3. Keep pull requests small, focused, and independently reviewable.
11
+ 4. Base work on the current default branch and do not mix unrelated formatting or generated
12
+ changes.
13
+
14
+ Bug reports should include a minimal redistributable source/recipe, LabRecipe and Python
15
+ versions, operating system, exact stable diagnostic codes, expected behavior, and actual
16
+ behavior. Remove sensitive experimental data.
17
+
18
+ ## Pull requests
19
+
20
+ - Explain the user-visible scientific or maintenance outcome and its limits.
21
+ - Add focused tests first or with the implementation; include dirty and edge cases.
22
+ - Preserve raw-input immutability, named-stage non-mutation, group/replicate isolation,
23
+ deterministic ordering, typed errors, and atomic publication.
24
+ - Update documentation and CHANGELOG.md for public behavior.
25
+ - Regenerate the recipe schema when its authoritative model changes.
26
+ - Run the commands in [DEVELOPMENT.md](DEVELOPMENT.md).
27
+ - Link the issue and state any compatibility or reproducibility impact.
28
+
29
+ ## Adding or changing a public scientific method
30
+
31
+ A method contribution is incomplete unless it includes all of the following:
32
+
33
+ 1. A strict typed parameter model with explicit defaults and finite bounds.
34
+ 2. Documented assumptions, caveats, and an appropriate primary citation.
35
+ 3. Explicit unit, sampling, axis, group/replicate, missing/non-finite, and short-data
36
+ preconditions.
37
+ 4. Analytical numerical controls plus clean, dirty, and failure fixtures.
38
+ 5. Tests proving input/prior-stage non-mutation and no cross-group or cross-replicate leakage.
39
+ 6. Stable structured diagnostics for every rejected precondition.
40
+ 7. Complete effective-parameter, method/provider, mask, exclusion, unit, and lineage evidence.
41
+ 8. Reference-oriented numerical tolerances and semantic figure checks where relevant.
42
+ 9. User documentation, recipe examples, and an Unreleased changelog entry.
43
+
44
+ Candidate detectors must remain candidates rather than automatic physical conclusions or
45
+ silent exclusions. New methods may not add executable YAML, implicit parameter tuning, or
46
+ third-party plugin discovery to v1.
47
+
48
+ ## Review and licensing
49
+
50
+ Maintainers review correctness, scientific transparency, tests, compatibility, documentation,
51
+ security, and scope. Contributions intentionally submitted for inclusion are accepted under
52
+ the repository's [Apache-2.0 license](LICENSE).
@@ -0,0 +1,55 @@
1
+ # Development guide
2
+
3
+ LabRecipe supports Python 3.12, 3.13, and 3.14. The commands below are run from the repository
4
+ root on a POSIX shell; Windows contributors may use the equivalent virtual-environment paths.
5
+
6
+ ## Environment
7
+
8
+ ~~~console
9
+ python3.12 -m venv .venv
10
+ .venv/bin/python -m pip install --upgrade pip
11
+ .venv/bin/python -m pip install -e ".[dev,docs,excel]"
12
+ ~~~
13
+
14
+ The editable install is for development only. Distribution tests build and install the wheel
15
+ outside the checkout.
16
+
17
+ ## Focused and full checks
18
+
19
+ ~~~console
20
+ .venv/bin/python -m pytest tests/test_docs.py -q
21
+ .venv/bin/python -m pytest tests/test_community_files.py -q
22
+ .venv/bin/python -m pytest -q
23
+ .venv/bin/python -m ruff check src tests scripts
24
+ .venv/bin/python -m mypy
25
+ .venv/bin/python -m sphinx -E -W --keep-going -b html docs docs/_build/html
26
+ .venv/bin/python -m build
27
+ .venv/bin/python -m twine check dist/*
28
+ ~~~
29
+
30
+ Warnings are errors in release verification. Do not weaken scientific tests, diagnostic
31
+ contracts, or tolerances to make a platform pass.
32
+
33
+ ## Regenerate authoritative resources
34
+
35
+ ~~~console
36
+ .venv/bin/python scripts/export_recipe_schema.py
37
+ .venv/bin/python scripts/export_recipe_schema.py --check
38
+ ~~~
39
+
40
+ The generated recipe schema must be committed with its Pydantic model change. To execute the
41
+ representative corpus and exact expected contracts:
42
+
43
+ ~~~console
44
+ .venv/bin/python -m pytest tests/test_example_inventory.py tests/test_examples.py -q
45
+ ~~~
46
+
47
+ The examples are immutable CC0 controls. Add a new source hash, explicit provenance/license,
48
+ complete recipe, expected diagnostic/mask/unit/metric/lineage contract, and analytical intent
49
+ when changing the corpus.
50
+
51
+ ## Build artifacts
52
+
53
+ Build outputs belong in dist/ and are not committed. Inspect both wheel and sdist, install the
54
+ wheel in a fresh environment outside the checkout, then verify import, labrecipe --help, and
55
+ representative CLI/API recipes. See RELEASING.md once release automation is present.