cpdatakit 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.
- cpdatakit-0.1.1/.editorconfig +16 -0
- cpdatakit-0.1.1/.github/ISSUE_TEMPLATE/bug.yml +18 -0
- cpdatakit-0.1.1/.github/ISSUE_TEMPLATE/config.yml +2 -0
- cpdatakit-0.1.1/.github/ISSUE_TEMPLATE/data-format.yml +25 -0
- cpdatakit-0.1.1/.github/ISSUE_TEMPLATE/feature.yml +14 -0
- cpdatakit-0.1.1/.github/dependabot.yml +13 -0
- cpdatakit-0.1.1/.github/pull_request_template.md +15 -0
- cpdatakit-0.1.1/.github/release-notes/template.md +14 -0
- cpdatakit-0.1.1/.github/release-notes/v0.1.0.md +18 -0
- cpdatakit-0.1.1/.github/release-notes/v0.1.1.md +23 -0
- cpdatakit-0.1.1/.github/workflows/ci.yml +54 -0
- cpdatakit-0.1.1/.github/workflows/publish-pypi.yml +88 -0
- cpdatakit-0.1.1/.gitignore +17 -0
- cpdatakit-0.1.1/.pre-commit-config.yaml +8 -0
- cpdatakit-0.1.1/CHANGELOG.md +38 -0
- cpdatakit-0.1.1/CITATION.cff +14 -0
- cpdatakit-0.1.1/CODE_OF_CONDUCT.md +12 -0
- cpdatakit-0.1.1/CONTRIBUTING.md +10 -0
- cpdatakit-0.1.1/LICENSE +193 -0
- cpdatakit-0.1.1/MAINTAINERS.md +5 -0
- cpdatakit-0.1.1/NOTICE +18 -0
- cpdatakit-0.1.1/PKG-INFO +216 -0
- cpdatakit-0.1.1/README.md +180 -0
- cpdatakit-0.1.1/README.zh-CN.md +77 -0
- cpdatakit-0.1.1/SECURITY.md +8 -0
- cpdatakit-0.1.1/assets/README.md +24 -0
- cpdatakit-0.1.1/assets/social-preview-v2.jpg +0 -0
- cpdatakit-0.1.1/docs/adapter-guide.md +13 -0
- cpdatakit-0.1.1/docs/architecture.md +16 -0
- cpdatakit-0.1.1/docs/data-format.md +45 -0
- cpdatakit-0.1.1/docs/launch-plan.md +26 -0
- cpdatakit-0.1.1/docs/maintenance.md +10 -0
- cpdatakit-0.1.1/docs/publishing.md +31 -0
- cpdatakit-0.1.1/docs/quickstart.md +84 -0
- cpdatakit-0.1.1/docs/roadmap.md +10 -0
- cpdatakit-0.1.1/examples/generate_sample_data.py +19 -0
- cpdatakit-0.1.1/pyproject.toml +91 -0
- cpdatakit-0.1.1/sample_data/intentionally_invalid_point.csv +5 -0
- cpdatakit-0.1.1/sample_data/synthetic_curve.csv +62 -0
- cpdatakit-0.1.1/sample_data/synthetic_field2d.json +562 -0
- cpdatakit-0.1.1/scripts/check_release.py +113 -0
- cpdatakit-0.1.1/src/cpdatakit/__init__.py +16 -0
- cpdatakit-0.1.1/src/cpdatakit/_version.py +3 -0
- cpdatakit-0.1.1/src/cpdatakit/adapters/__init__.py +16 -0
- cpdatakit-0.1.1/src/cpdatakit/cli.py +145 -0
- cpdatakit-0.1.1/src/cpdatakit/exceptions.py +21 -0
- cpdatakit-0.1.1/src/cpdatakit/io/__init__.py +166 -0
- cpdatakit-0.1.1/src/cpdatakit/model.py +59 -0
- cpdatakit-0.1.1/src/cpdatakit/normalization.py +101 -0
- cpdatakit-0.1.1/src/cpdatakit/plotting.py +132 -0
- cpdatakit-0.1.1/src/cpdatakit/provenance.py +43 -0
- cpdatakit-0.1.1/src/cpdatakit/samples.py +47 -0
- cpdatakit-0.1.1/src/cpdatakit/schema.py +169 -0
- cpdatakit-0.1.1/src/cpdatakit/schemas/__init__.py +1 -0
- cpdatakit-0.1.1/src/cpdatakit/schemas/curve.json +17 -0
- cpdatakit-0.1.1/src/cpdatakit/schemas/field2d.json +13 -0
- cpdatakit-0.1.1/src/cpdatakit/schemas/point.json +21 -0
- cpdatakit-0.1.1/src/cpdatakit/statistics.py +71 -0
- cpdatakit-0.1.1/src/cpdatakit/validation.py +345 -0
- cpdatakit-0.1.1/tests/conftest.py +27 -0
- cpdatakit-0.1.1/tests/test_cli_api_samples.py +83 -0
- cpdatakit-0.1.1/tests/test_io.py +121 -0
- cpdatakit-0.1.1/tests/test_normalization_statistics.py +77 -0
- cpdatakit-0.1.1/tests/test_plotting.py +66 -0
- cpdatakit-0.1.1/tests/test_release_metadata.py +45 -0
- cpdatakit-0.1.1/tests/test_validation.py +163 -0
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
root = true
|
|
2
|
+
|
|
3
|
+
[*]
|
|
4
|
+
charset = utf-8
|
|
5
|
+
end_of_line = lf
|
|
6
|
+
insert_final_newline = true
|
|
7
|
+
trim_trailing_whitespace = true
|
|
8
|
+
indent_style = space
|
|
9
|
+
indent_size = 4
|
|
10
|
+
|
|
11
|
+
[*.{yml,yaml,json}]
|
|
12
|
+
indent_size = 2
|
|
13
|
+
|
|
14
|
+
[*.md]
|
|
15
|
+
trim_trailing_whitespace = false
|
|
16
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
name: Bug report
|
|
2
|
+
description: Report reproducible incorrect behavior
|
|
3
|
+
title: "[Bug]: "
|
|
4
|
+
labels: [bug]
|
|
5
|
+
body:
|
|
6
|
+
- type: textarea
|
|
7
|
+
id: description
|
|
8
|
+
attributes: {label: Description, description: What happened and what did you expect?}
|
|
9
|
+
validations: {required: true}
|
|
10
|
+
- type: textarea
|
|
11
|
+
id: reproduce
|
|
12
|
+
attributes: {label: Reproduction, description: Minimal commands and synthetic data only.}
|
|
13
|
+
validations: {required: true}
|
|
14
|
+
- type: input
|
|
15
|
+
id: versions
|
|
16
|
+
attributes: {label: Versions, description: CPDataKit, Python, and operating system.}
|
|
17
|
+
validations: {required: true}
|
|
18
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
name: Data format compatibility
|
|
2
|
+
description: Request or report compatibility with a documented format
|
|
3
|
+
title: "[Format]: "
|
|
4
|
+
labels: [data-format]
|
|
5
|
+
body:
|
|
6
|
+
- type: input
|
|
7
|
+
id: format
|
|
8
|
+
attributes: {label: Format and version, description: Official name and exact version.}
|
|
9
|
+
validations: {required: true}
|
|
10
|
+
- type: textarea
|
|
11
|
+
id: documentation
|
|
12
|
+
attributes: {label: Public documentation and license, description: Provide authoritative references and redistribution terms.}
|
|
13
|
+
validations: {required: true}
|
|
14
|
+
- type: textarea
|
|
15
|
+
id: conventions
|
|
16
|
+
attributes: {label: Scientific conventions, description: Units, measures, tensor ordering, orientation, and identifiers.}
|
|
17
|
+
validations: {required: true}
|
|
18
|
+
- type: checkboxes
|
|
19
|
+
id: safety
|
|
20
|
+
attributes:
|
|
21
|
+
label: Data safety
|
|
22
|
+
options:
|
|
23
|
+
- label: I will not upload restricted, confidential, or commercial-software data.
|
|
24
|
+
required: true
|
|
25
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
name: Feature request
|
|
2
|
+
description: Propose a focused improvement
|
|
3
|
+
title: "[Feature]: "
|
|
4
|
+
labels: [enhancement]
|
|
5
|
+
body:
|
|
6
|
+
- type: textarea
|
|
7
|
+
id: problem
|
|
8
|
+
attributes: {label: Problem, description: Which research-data workflow is blocked?}
|
|
9
|
+
validations: {required: true}
|
|
10
|
+
- type: textarea
|
|
11
|
+
id: proposal
|
|
12
|
+
attributes: {label: Proposed behavior, description: Include scope and explicit conventions.}
|
|
13
|
+
validations: {required: true}
|
|
14
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
## Summary
|
|
2
|
+
|
|
3
|
+
## Tests and documentation
|
|
4
|
+
|
|
5
|
+
- [ ] `pytest`
|
|
6
|
+
- [ ] `ruff check .`
|
|
7
|
+
- [ ] `ruff format --check .`
|
|
8
|
+
- [ ] Documentation and changelog updated when needed
|
|
9
|
+
|
|
10
|
+
## Data and scientific conventions
|
|
11
|
+
|
|
12
|
+
- [ ] Fixtures are synthetic or redistribution-approved
|
|
13
|
+
- [ ] Units and scientific conventions are explicit
|
|
14
|
+
- [ ] No secrets, personal paths, solver binaries, or restricted data are included
|
|
15
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# CPDataKit v0.1.0 - Explicit, solver-neutral data quality foundations
|
|
2
|
+
|
|
3
|
+
The first alpha release introduces a small Python toolkit for making crystal-plasticity simulation
|
|
4
|
+
datasets explicit, traceable, and easier to inspect. It supports versioned `curve`, `point`, and
|
|
5
|
+
`field2d` profiles; UTF-8 CSV, JSON records, and CPDataKit HDF5; structured validation; explicit
|
|
6
|
+
field/unit normalization; summaries; headless PNG/SVG plots; a CLI; and a typed Python API.
|
|
7
|
+
|
|
8
|
+
CPDataKit HDF5 records schema/profile, units, field mapping, source basename and SHA-256, UTC time,
|
|
9
|
+
software versions, operation log, and validation summary. All bundled datasets are reproducible,
|
|
10
|
+
fixed-seed synthetic examples.
|
|
11
|
+
|
|
12
|
+
This release does **not** read ODB or DAMASK DADF5, run a solver or UMAT, infer scientific
|
|
13
|
+
conventions, certify physical correctness, or provide 3D/GUI/distributed processing. CPDataKit is
|
|
14
|
+
not affiliated with DAMASK, Abaqus, or Dassault Systèmes.
|
|
15
|
+
|
|
16
|
+
Verification before publication: run the GitHub Actions Windows/Ubuntu Python 3.10-3.13 matrix,
|
|
17
|
+
Ruff, package build, and wheel smoke test. Locally, v0.1.0 passed 35 tests on Windows/Python 3.12,
|
|
18
|
+
fresh editable installation, wheel-only installation, and all README core commands.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CPDataKit v0.1.1 - Secure distribution and a five-minute path to value
|
|
2
|
+
|
|
3
|
+
This maintenance release prepares CPDataKit for secure, low-friction distribution without changing
|
|
4
|
+
its solver-neutral data contract or public Python API. It adds a deterministic five-minute
|
|
5
|
+
quickstart, clearer installation guidance, complete package links, and a scientifically scoped
|
|
6
|
+
social preview.
|
|
7
|
+
|
|
8
|
+
Validation now fails closed for malformed custom schemas and incompatible boolean or numeric
|
|
9
|
+
values. Per-record numeric arrays enforce integer and range constraints; duplicate detection safely
|
|
10
|
+
handles nested arrays and mappings; affine unit conversions preserve both scale and offset; and
|
|
11
|
+
malformed CPDataKit HDF5 tables and unsupported histogram fields return concise domain errors.
|
|
12
|
+
|
|
13
|
+
The PyPI workflow builds only from an existing semantic-version tag, verifies that the tag,
|
|
14
|
+
`pyproject.toml`, runtime version, citation metadata, changelog, and release notes agree, checks both
|
|
15
|
+
distributions with Twine, and publishes through short-lived OIDC credentials after an explicit
|
|
16
|
+
GitHub environment approval. No long-lived PyPI token is stored in the repository.
|
|
17
|
+
|
|
18
|
+
CPDataKit validates explicit schemas, units, provenance, and data-quality constraints. It does not
|
|
19
|
+
certify physical correctness, read ODB or DAMASK DADF5, run a solver or UMAT, or infer scientific
|
|
20
|
+
conventions. All bundled examples remain fixed-seed synthetic data.
|
|
21
|
+
|
|
22
|
+
Before publishing, the full Windows/Ubuntu Python 3.10-3.13 matrix passed alongside 51 local tests,
|
|
23
|
+
Ruff, package build, Twine checks, a clean wheel installation, and the quickstart smoke test.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
pull_request:
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: read
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
test:
|
|
12
|
+
strategy:
|
|
13
|
+
fail-fast: false
|
|
14
|
+
matrix:
|
|
15
|
+
os: [ubuntu-latest, windows-latest]
|
|
16
|
+
python-version: ["3.10", "3.11", "3.12", "3.13"]
|
|
17
|
+
runs-on: ${{ matrix.os }}
|
|
18
|
+
steps:
|
|
19
|
+
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
|
|
20
|
+
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
|
|
21
|
+
with:
|
|
22
|
+
python-version: ${{ matrix.python-version }}
|
|
23
|
+
cache: pip
|
|
24
|
+
- run: python -m pip install -e ".[dev]"
|
|
25
|
+
- run: pytest
|
|
26
|
+
|
|
27
|
+
quality-and-build:
|
|
28
|
+
runs-on: ubuntu-latest
|
|
29
|
+
steps:
|
|
30
|
+
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
|
|
31
|
+
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
|
|
32
|
+
with:
|
|
33
|
+
python-version: "3.12"
|
|
34
|
+
cache: pip
|
|
35
|
+
- run: python -m pip install -e ".[dev]"
|
|
36
|
+
- run: ruff check .
|
|
37
|
+
- run: ruff format --check .
|
|
38
|
+
- run: python scripts/check_release.py v0.1.1
|
|
39
|
+
- run: python -m build
|
|
40
|
+
- run: python scripts/check_release.py v0.1.1 --dist-dir dist
|
|
41
|
+
- run: python -m twine check dist/*
|
|
42
|
+
- name: Install wheel and smoke test
|
|
43
|
+
shell: bash
|
|
44
|
+
run: |
|
|
45
|
+
python -m venv wheel-env
|
|
46
|
+
wheel-env/bin/python -m pip install dist/*.whl
|
|
47
|
+
wheel-env/bin/cpdatakit --version
|
|
48
|
+
wheel-env/bin/python -c "import cpdatakit; print(cpdatakit.__version__)"
|
|
49
|
+
wheel-env/bin/python -c "from cpdatakit.samples import generate_sample_data; generate_sample_data('quickstart-smoke')"
|
|
50
|
+
wheel-env/bin/cpdatakit validate quickstart-smoke/synthetic_curve.csv --schema curve --json-output validation.json
|
|
51
|
+
wheel-env/bin/cpdatakit summary quickstart-smoke/synthetic_curve.csv --schema curve --json-output summary.json
|
|
52
|
+
wheel-env/bin/cpdatakit convert quickstart-smoke/synthetic_curve.csv --schema curve --output curve.h5 --source-description "Fixed-seed CI quickstart"
|
|
53
|
+
wheel-env/bin/cpdatakit plot curve.h5 --schema curve --kind stress-strain --output stress-strain.png
|
|
54
|
+
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
inputs:
|
|
6
|
+
tag:
|
|
7
|
+
description: Existing Git tag to publish
|
|
8
|
+
required: true
|
|
9
|
+
default: v0.1.1
|
|
10
|
+
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
|
|
14
|
+
jobs:
|
|
15
|
+
build:
|
|
16
|
+
name: Build distributions
|
|
17
|
+
if: github.ref == 'refs/heads/main'
|
|
18
|
+
runs-on: ubuntu-latest
|
|
19
|
+
env:
|
|
20
|
+
RELEASE_TAG: ${{ inputs.tag }}
|
|
21
|
+
steps:
|
|
22
|
+
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
|
|
23
|
+
with:
|
|
24
|
+
fetch-depth: 0
|
|
25
|
+
persist-credentials: false
|
|
26
|
+
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
|
|
27
|
+
with:
|
|
28
|
+
python-version: "3.12"
|
|
29
|
+
cache: pip
|
|
30
|
+
- name: Verify trusted dispatch and synchronized release metadata
|
|
31
|
+
shell: bash
|
|
32
|
+
run: |
|
|
33
|
+
if [[ "${GITHUB_REF}" != "refs/heads/main" ]]; then
|
|
34
|
+
echo "This workflow must be dispatched from main, got: ${GITHUB_REF}" >&2
|
|
35
|
+
exit 1
|
|
36
|
+
fi
|
|
37
|
+
if [[ ! "${RELEASE_TAG}" =~ ^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$ ]]; then
|
|
38
|
+
echo "Release ref must be a semantic-version tag, got: ${RELEASE_TAG}" >&2
|
|
39
|
+
exit 1
|
|
40
|
+
fi
|
|
41
|
+
if ! git show-ref --verify --quiet "refs/tags/${RELEASE_TAG}"; then
|
|
42
|
+
echo "Tag does not exist: ${RELEASE_TAG}" >&2
|
|
43
|
+
exit 1
|
|
44
|
+
fi
|
|
45
|
+
git fetch --no-tags origin main
|
|
46
|
+
if ! git merge-base --is-ancestor "refs/tags/${RELEASE_TAG}^{commit}" origin/main; then
|
|
47
|
+
echo "Tag is not on the main branch: ${RELEASE_TAG}" >&2
|
|
48
|
+
exit 1
|
|
49
|
+
fi
|
|
50
|
+
git checkout --detach "refs/tags/${RELEASE_TAG}"
|
|
51
|
+
python scripts/check_release.py "${RELEASE_TAG}"
|
|
52
|
+
- name: Build and inspect distributions
|
|
53
|
+
run: |
|
|
54
|
+
python -m pip install --upgrade build twine
|
|
55
|
+
python -m build
|
|
56
|
+
python scripts/check_release.py "${RELEASE_TAG}" --dist-dir dist
|
|
57
|
+
python -m twine check dist/*
|
|
58
|
+
- name: Install wheel and run the five-minute quickstart
|
|
59
|
+
shell: bash
|
|
60
|
+
run: |
|
|
61
|
+
python -m venv wheel-env
|
|
62
|
+
wheel-env/bin/python -m pip install dist/*.whl
|
|
63
|
+
wheel-env/bin/python -c "from cpdatakit.samples import generate_sample_data; generate_sample_data('quickstart-smoke')"
|
|
64
|
+
wheel-env/bin/cpdatakit validate quickstart-smoke/synthetic_curve.csv --schema curve --json-output validation.json
|
|
65
|
+
wheel-env/bin/cpdatakit summary quickstart-smoke/synthetic_curve.csv --schema curve --json-output summary.json
|
|
66
|
+
wheel-env/bin/cpdatakit convert quickstart-smoke/synthetic_curve.csv --schema curve --output curve.h5 --source-description "Fixed-seed release quickstart"
|
|
67
|
+
wheel-env/bin/cpdatakit plot curve.h5 --schema curve --kind stress-strain --output stress-strain.png
|
|
68
|
+
- uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
|
|
69
|
+
with:
|
|
70
|
+
name: python-package-distributions
|
|
71
|
+
path: dist/
|
|
72
|
+
if-no-files-found: error
|
|
73
|
+
|
|
74
|
+
publish:
|
|
75
|
+
name: Publish distributions to PyPI
|
|
76
|
+
needs: build
|
|
77
|
+
runs-on: ubuntu-latest
|
|
78
|
+
environment:
|
|
79
|
+
name: pypi
|
|
80
|
+
url: https://pypi.org/p/cpdatakit
|
|
81
|
+
permissions:
|
|
82
|
+
id-token: write
|
|
83
|
+
steps:
|
|
84
|
+
- uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
|
|
85
|
+
with:
|
|
86
|
+
name: python-package-distributions
|
|
87
|
+
path: dist/
|
|
88
|
+
- uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # release/v1
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes follow Keep a Changelog; versions follow Semantic Versioning.
|
|
4
|
+
|
|
5
|
+
## [Unreleased]
|
|
6
|
+
|
|
7
|
+
## [0.1.1] - 2026-08-17
|
|
8
|
+
|
|
9
|
+
### Fixed
|
|
10
|
+
|
|
11
|
+
- Enforce custom-schema dtype, shape, bounds, alias, and option declarations at load time.
|
|
12
|
+
- Validate boolean and shaped numeric fields without accepting unrelated coercible values.
|
|
13
|
+
- Handle nested custom values safely during duplicate-record detection.
|
|
14
|
+
- Apply affine unit conversions with both scale and offset.
|
|
15
|
+
- Reject malformed CPDataKit HDF5 tables with consistent `DataReadError` failures.
|
|
16
|
+
- Reject shaped or non-numeric histogram fields with a concise domain error.
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- PyPI Trusted Publishing workflow with tagged, inspected distributions and OIDC authentication.
|
|
21
|
+
- Five-minute synthetic-data quickstart and a scientifically scoped repository social-preview asset.
|
|
22
|
+
- Release metadata and semantic-version tag consistency checks.
|
|
23
|
+
|
|
24
|
+
### Changed
|
|
25
|
+
|
|
26
|
+
- The README now offers a one-command GitHub Release installation for non-contributors.
|
|
27
|
+
- Repository-relative README links are absolute so they work correctly on PyPI.
|
|
28
|
+
- Publishing documentation and workflow now target the complete v0.1.1 distribution.
|
|
29
|
+
|
|
30
|
+
## [0.1.0] - 2026-08-12
|
|
31
|
+
|
|
32
|
+
### Added
|
|
33
|
+
|
|
34
|
+
- Versioned `curve`, `point`, and `field2d` schemas.
|
|
35
|
+
- CSV, JSON records, and CPDataKit HDF5 I/O with provenance.
|
|
36
|
+
- Structured validation, explicit normalization, descriptive summaries, plotting, CLI, and API.
|
|
37
|
+
- Deterministic synthetic datasets, tests, documentation, and cross-platform CI.
|
|
38
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: "If you use CPDataKit, please cite this software."
|
|
3
|
+
title: "CPDataKit: Crystal Plasticity Data Quality Toolkit"
|
|
4
|
+
type: software
|
|
5
|
+
version: 0.1.1
|
|
6
|
+
date-released: 2026-08-17
|
|
7
|
+
authors:
|
|
8
|
+
- name: "CPDataKit contributors"
|
|
9
|
+
license: Apache-2.0
|
|
10
|
+
repository-code: "https://github.com/17636365690/cpdatakit"
|
|
11
|
+
keywords:
|
|
12
|
+
- crystal plasticity
|
|
13
|
+
- materials data
|
|
14
|
+
- data validation
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Code of Conduct
|
|
2
|
+
|
|
3
|
+
We pledge to make participation respectful and harassment-free regardless of age, body size,
|
|
4
|
+
disability, ethnicity, sex characteristics, gender identity and expression, experience, education,
|
|
5
|
+
socioeconomic status, nationality, appearance, race, religion, or sexual identity and orientation.
|
|
6
|
+
|
|
7
|
+
Be constructive, accept responsibility, focus on what is best for the community, and respect
|
|
8
|
+
different viewpoints. Harassment, insulting comments, threats, doxxing, and unwanted sexual
|
|
9
|
+
attention are unacceptable. Maintainers may remove contributions or participation that violate
|
|
10
|
+
these standards. Report conduct concerns privately through GitHub private vulnerability reporting
|
|
11
|
+
or to the repository owner. Maintainers will handle reports confidentially and fairly. This policy
|
|
12
|
+
is adapted in spirit from Contributor Covenant 2.1.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Open an issue before large schema or adapter changes. Fork the project, create a focused branch,
|
|
4
|
+
add tests and documentation, then run `pytest`, `ruff check .`, `ruff format --check .`, and
|
|
5
|
+
`python -m build`. Contributions are submitted under Apache-2.0.
|
|
6
|
+
|
|
7
|
+
Use only synthetic, openly licensed, or redistribution-approved fixtures. Never commit ODB files,
|
|
8
|
+
real confidential research data, secrets, personal paths, or commercial installation details.
|
|
9
|
+
Scientific conventions must be explicit; do not add automatic guesses for units or measures.
|
|
10
|
+
|
cpdatakit-0.1.1/LICENSE
ADDED
|
@@ -0,0 +1,193 @@
|
|
|
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
|
+
Copyright 2026 CPDataKit contributors
|
|
181
|
+
|
|
182
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
183
|
+
you may not use this file except in compliance with the License.
|
|
184
|
+
You may obtain a copy of the License at
|
|
185
|
+
|
|
186
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
187
|
+
|
|
188
|
+
Unless required by applicable law or agreed to in writing, software
|
|
189
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
190
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
191
|
+
See the License for the specific language governing permissions and
|
|
192
|
+
limitations under the License.
|
|
193
|
+
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Maintainers
|
|
2
|
+
|
|
3
|
+
GitHub user [@17636365690](https://github.com/17636365690) is the initial release manager.
|
|
4
|
+
Maintainers review schema compatibility, provenance, tests, dependency licenses, security reports,
|
|
5
|
+
and releases. Two reviewers are recommended for future schema-version changes.
|
cpdatakit-0.1.1/NOTICE
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
CPDataKit
|
|
2
|
+
Copyright 2026 CPDataKit contributors
|
|
3
|
+
|
|
4
|
+
Direct runtime dependencies reviewed for v0.1.x:
|
|
5
|
+
- NumPy: BSD-3-Clause core; packaged metadata also identifies licenses for vendored components.
|
|
6
|
+
- pandas: BSD-3-Clause.
|
|
7
|
+
- h5py: BSD-3-Clause.
|
|
8
|
+
- Matplotlib: PSF-based Matplotlib license (BSD-compatible).
|
|
9
|
+
- Pint: BSD-3-Clause.
|
|
10
|
+
|
|
11
|
+
These are permissive licenses with no evident incompatibility with Apache-2.0 for this project's
|
|
12
|
+
ordinary dependency use. Dependencies are not copied into this source distribution. This notice
|
|
13
|
+
is informational, is not legal advice, and must be refreshed against the versions shipped by each
|
|
14
|
+
release. See each installed distribution and upstream repository for complete license texts.
|
|
15
|
+
|
|
16
|
+
DAMASK, Abaqus, and Dassault Systèmes names may be trademarks of their respective owners. Their
|
|
17
|
+
software and data are not distributed with CPDataKit, and they are not core dependencies.
|
|
18
|
+
|