mechanicsdsl-datasets 0.1.0__tar.gz

mechanicsdsl_datasets-0.1.0/.gitignore

@@ -0,0 +1,47 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.whl
+MANIFEST
+.env
+.venv
+env/
+venv/
+ENV/
+.Python
+pip-log.txt
+pip-delete-this-directory.txt
+.tox/
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.log
+*.pot
+*.mo
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.ipynb_checkpoints/
+*.ipynb_checkpoints
+profile_output/
+*.prof

mechanicsdsl_datasets-0.1.0/CITATION.cff

@@ -0,0 +1,23 @@
+cff-version: 1.2.0
+message: "If you use these datasets in your research, please cite:"
+type: dataset
+title: "MechanicsDSL Physics Datasets"
+abstract: >
+  Reference datasets for physics parameter estimation and inverse problem
+  benchmarking. Includes synthetic datasets with known ground-truth parameters
+  generated from MechanicsDSL forward simulations with Gaussian observation noise.
+authors:
+  - family-names: Parsons
+    given-names: Noah
+    orcid: "https://orcid.org/0009-0000-7224-6040"
+    affiliation: "American Forge Institute & Eastern Wyoming College"
+repository-code: "https://github.com/MechanicsDSL/mechanicsdsl-datasets"
+license: MIT
+date-released: "2026-03-13"
+references:
+  - type: software
+    title: "MechanicsDSL"
+    doi: "10.5281/zenodo.17771040"
+    authors:
+      - family-names: Parsons
+        given-names: Noah

mechanicsdsl_datasets-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MechanicsDSL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mechanicsdsl_datasets-0.1.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: mechanicsdsl-datasets
+Version: 0.1.0
+Summary: Reference physics datasets for MechanicsDSL parameter estimation and inverse problem benchmarking
+Project-URL: Homepage, https://github.com/MechanicsDSL/mechanicsdsl-datasets
+Project-URL: Documentation, https://mechanicsdsl.readthedocs.io
+Project-URL: Repository, https://github.com/MechanicsDSL/mechanicsdsl-datasets
+Project-URL: Bug Tracker, https://github.com/MechanicsDSL/mechanicsdsl-datasets/issues
+Project-URL: DOI, https://doi.org/10.5281/zenodo.17771040
+Author-email: Noah Parsons <nomapa223@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: MechanicsDSL,datasets,inverse problems,mechanics,parameter estimation,physics,scientific computing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.9
+Requires-Dist: h5py>=3.8
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.0
+Requires-Dist: scipy>=1.10
+Provides-Extra: dev
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: estimation
+Requires-Dist: mechanicsdsl-core; extra == 'estimation'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MechanicsDSL/mechanicsdsl/main/docs/images/logo.png" alt="MechanicsDSL Logo" width="360">
+</p>
+
+<h1 align="center">mechanicsdsl-datasets</h1>
+
+<p align="center">
+  <em>Reference datasets for physics parameter estimation and inverse problem benchmarking.</em>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/mechanicsdsl-datasets/"><img src="https://img.shields.io/pypi/v/mechanicsdsl-datasets" alt="PyPI"></a>
+  <img src="https://img.shields.io/badge/datasets-3-blue" alt="3 Datasets">
+  <img src="https://img.shields.io/badge/format-CSV%20%7C%20HDF5%20%7C%20JSON-blue" alt="Formats">
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT License"></a>
+  <a href="https://github.com/MechanicsDSL/mechanicsdsl"><img src="https://img.shields.io/badge/core-mechanicsdsl-blue" alt="Core Package"></a>
+</p>
+
+---
+
+## Install
+
+```bash
+pip install mechanicsdsl-datasets
+```
+
+Or clone for direct access to raw CSV/HDF5 files:
+
+```bash
+git clone https://github.com/MechanicsDSL/mechanicsdsl-datasets
+```
+
+---
+
+## Available Datasets
+
+| Dataset | System | Observations | Rate | Noise σ | Ground Truth |
+|---------|--------|-------------|------|---------|--------------|
+| [`pendulum_synthetic`](datasets/pendulum_synthetic/) | Simple pendulum | 1,001 | 100 Hz | 0.010 rad | m=1.0, l=0.5, g=9.81 |
+| [`double_pendulum_synthetic`](datasets/double_pendulum_synthetic/) | Double pendulum (near-periodic) | 501 | 100 Hz | 0.005 rad | m=1.0, l=1.0, g=9.81 |
+| [`coupled_oscillators_synthetic`](datasets/coupled_oscillators_synthetic/) | Coupled pendulums (3 beat periods) | 2,001 | 100 Hz | 0.005 rad | m=1.0, l=1.0, k=0.5 |
+
+All datasets include clean trajectories, Gaussian-noisy observations, HDF5 with embedded metadata, and paired estimation/validation scripts.
+
+---
+
+## Quick Start (pip install)
+
+```python
+import mechanicsdsl_datasets as mds
+
+# Load a dataset
+dataset = mds.load("pendulum_synthetic")
+print(dataset.ground_truth)    # {'m': 1.0, 'l': 0.5, 'g': 9.81}
+print(dataset.t.shape)         # (1001,)
+print(dataset.theta_noisy[:5]) # noisy observations
+
+# Run built-in validation
+dataset.validate()             # confirms forward simulation matches clean data
+```
+
+---
+
+## Quick Start (raw files)
+
+```python
+import pandas as pd
+import json
+
+data = pd.read_csv("datasets/pendulum_synthetic/data.csv")
+meta = json.load(open("datasets/pendulum_synthetic/metadata.json"))
+
+t         = data["t_s"].values
+theta_obs = data["theta_rad_noisy"].values
+truth     = meta["ground_truth"]   # {'m': 1.0, 'l': 0.5, 'g': 9.81}
+```
+
+---
+
+## Repository Structure
+
+```
+mechanicsdsl-datasets/
+├── datasets/
+│   ├── pendulum_synthetic/
+│   │   ├── README.md, data.csv, data.hdf5, metadata.json
+│   │   └── examples/  estimate_scipy.py, validate_forward.py
+│   ├── double_pendulum_synthetic/
+│   │   ├── README.md, data.csv, data.hdf5, metadata.json
+│   │   └── examples/  estimate_scipy.py, validate_forward.py
+│   └── coupled_oscillators_synthetic/
+│       ├── README.md, data.csv, data.hdf5, metadata.json
+│       └── examples/  estimate_normal_modes.py, validate_forward.py
+├── docs/
+│   ├── schema.md           # metadata.json schema reference
+│   └── estimation_guide.md # least-squares, MCMC, FFT methods
+├── scripts/
+│   ├── generate_all.py     # regenerate all synthetic datasets
+│   └── validate_all.py     # run all validate_forward.py scripts
+└── tests/
+    └── test_datasets.py    # schema, row count, NaN, noise std checks
+```
+
+---
+
+## Estimation Examples
+
+Each dataset ships with working estimation scripts:
+
+```bash
+# Estimate pendulum length from noisy observations
+cd datasets/pendulum_synthetic
+python examples/estimate_scipy.py
+# Estimated: l = 0.4998 m  (ground truth: 0.5000 m)
+
+# Identify normal mode frequencies via FFT
+cd datasets/coupled_oscillators_synthetic
+python examples/estimate_normal_modes.py
+# omega1 = 3.1321 rad/s, omega2 = 3.2636 rad/s, k = 0.500 N/m
+```
+
+---
+
+## Testing
+
+```bash
+pip install pytest h5py numpy scipy pandas
+pytest tests/ -v
+```
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Experimental datasets with real sensor data especially welcome.
+
+## Citation
+
+```bibtex
+@dataset{mechanicsdsl_datasets2026,
+  author = {Parsons, Noah},
+  title  = {{MechanicsDSL Physics Datasets}},
+  year   = {2026},
+  doi    = {10.5281/zenodo.17771040},
+  url    = {https://github.com/MechanicsDSL/mechanicsdsl-datasets}
+}
+```
+
+## License
+
+MIT License — see [LICENSE](LICENSE).

mechanicsdsl_datasets-0.1.0/README.md

@@ -0,0 +1,151 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MechanicsDSL/mechanicsdsl/main/docs/images/logo.png" alt="MechanicsDSL Logo" width="360">
+</p>
+
+<h1 align="center">mechanicsdsl-datasets</h1>
+
+<p align="center">
+  <em>Reference datasets for physics parameter estimation and inverse problem benchmarking.</em>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/mechanicsdsl-datasets/"><img src="https://img.shields.io/pypi/v/mechanicsdsl-datasets" alt="PyPI"></a>
+  <img src="https://img.shields.io/badge/datasets-3-blue" alt="3 Datasets">
+  <img src="https://img.shields.io/badge/format-CSV%20%7C%20HDF5%20%7C%20JSON-blue" alt="Formats">
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT License"></a>
+  <a href="https://github.com/MechanicsDSL/mechanicsdsl"><img src="https://img.shields.io/badge/core-mechanicsdsl-blue" alt="Core Package"></a>
+</p>
+
+---
+
+## Install
+
+```bash
+pip install mechanicsdsl-datasets
+```
+
+Or clone for direct access to raw CSV/HDF5 files:
+
+```bash
+git clone https://github.com/MechanicsDSL/mechanicsdsl-datasets
+```
+
+---
+
+## Available Datasets
+
+| Dataset | System | Observations | Rate | Noise σ | Ground Truth |
+|---------|--------|-------------|------|---------|--------------|
+| [`pendulum_synthetic`](datasets/pendulum_synthetic/) | Simple pendulum | 1,001 | 100 Hz | 0.010 rad | m=1.0, l=0.5, g=9.81 |
+| [`double_pendulum_synthetic`](datasets/double_pendulum_synthetic/) | Double pendulum (near-periodic) | 501 | 100 Hz | 0.005 rad | m=1.0, l=1.0, g=9.81 |
+| [`coupled_oscillators_synthetic`](datasets/coupled_oscillators_synthetic/) | Coupled pendulums (3 beat periods) | 2,001 | 100 Hz | 0.005 rad | m=1.0, l=1.0, k=0.5 |
+
+All datasets include clean trajectories, Gaussian-noisy observations, HDF5 with embedded metadata, and paired estimation/validation scripts.
+
+---
+
+## Quick Start (pip install)
+
+```python
+import mechanicsdsl_datasets as mds
+
+# Load a dataset
+dataset = mds.load("pendulum_synthetic")
+print(dataset.ground_truth)    # {'m': 1.0, 'l': 0.5, 'g': 9.81}
+print(dataset.t.shape)         # (1001,)
+print(dataset.theta_noisy[:5]) # noisy observations
+
+# Run built-in validation
+dataset.validate()             # confirms forward simulation matches clean data
+```
+
+---
+
+## Quick Start (raw files)
+
+```python
+import pandas as pd
+import json
+
+data = pd.read_csv("datasets/pendulum_synthetic/data.csv")
+meta = json.load(open("datasets/pendulum_synthetic/metadata.json"))
+
+t         = data["t_s"].values
+theta_obs = data["theta_rad_noisy"].values
+truth     = meta["ground_truth"]   # {'m': 1.0, 'l': 0.5, 'g': 9.81}
+```
+
+---
+
+## Repository Structure
+
+```
+mechanicsdsl-datasets/
+├── datasets/
+│   ├── pendulum_synthetic/
+│   │   ├── README.md, data.csv, data.hdf5, metadata.json
+│   │   └── examples/  estimate_scipy.py, validate_forward.py
+│   ├── double_pendulum_synthetic/
+│   │   ├── README.md, data.csv, data.hdf5, metadata.json
+│   │   └── examples/  estimate_scipy.py, validate_forward.py
+│   └── coupled_oscillators_synthetic/
+│       ├── README.md, data.csv, data.hdf5, metadata.json
+│       └── examples/  estimate_normal_modes.py, validate_forward.py
+├── docs/
+│   ├── schema.md           # metadata.json schema reference
+│   └── estimation_guide.md # least-squares, MCMC, FFT methods
+├── scripts/
+│   ├── generate_all.py     # regenerate all synthetic datasets
+│   └── validate_all.py     # run all validate_forward.py scripts
+└── tests/
+    └── test_datasets.py    # schema, row count, NaN, noise std checks
+```
+
+---
+
+## Estimation Examples
+
+Each dataset ships with working estimation scripts:
+
+```bash
+# Estimate pendulum length from noisy observations
+cd datasets/pendulum_synthetic
+python examples/estimate_scipy.py
+# Estimated: l = 0.4998 m  (ground truth: 0.5000 m)
+
+# Identify normal mode frequencies via FFT
+cd datasets/coupled_oscillators_synthetic
+python examples/estimate_normal_modes.py
+# omega1 = 3.1321 rad/s, omega2 = 3.2636 rad/s, k = 0.500 N/m
+```
+
+---
+
+## Testing
+
+```bash
+pip install pytest h5py numpy scipy pandas
+pytest tests/ -v
+```
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Experimental datasets with real sensor data especially welcome.
+
+## Citation
+
+```bibtex
+@dataset{mechanicsdsl_datasets2026,
+  author = {Parsons, Noah},
+  title  = {{MechanicsDSL Physics Datasets}},
+  year   = {2026},
+  doi    = {10.5281/zenodo.17771040},
+  url    = {https://github.com/MechanicsDSL/mechanicsdsl-datasets}
+}
+```
+
+## License
+
+MIT License — see [LICENSE](LICENSE).

mechanicsdsl_datasets-0.1.0/datasets/coupled_oscillators_synthetic/README.md

@@ -0,0 +1,71 @@
+# coupled_oscillators_synthetic
+
+Synthetic coupled pendulum dataset covering 3 beat periods. Designed for spring constant estimation and normal mode frequency identification.
+
+---
+
+## Physical System
+
+Two identical pendulums of mass $m$, length $l$ coupled by a spring of stiffness $k$:
+
+$$L = \frac{1}{2}ml^2(\dot{\theta}_1^2 + \dot{\theta}_2^2) + mgl(\cos\theta_1 + \cos\theta_2) - \frac{1}{2}kl^2(\theta_1-\theta_2)^2$$
+
+**DSL specification:**
+```
+\system{coupled_pendulums}
+\parameter{m}{1.0}{kg}
+\parameter{l}{1.0}{m}
+\parameter{k}{0.5}{N/m}
+\lagrangian{
+    0.5*m*l^2*(\dot{theta1}^2 + \dot{theta2}^2)
+    + m*g*l*(cos(theta1) + cos(theta2))
+    - 0.5*k*l^2*(theta1-theta2)^2
+}
+\initial{theta1: 0.3, theta2: 0.0}
+\target{python_numpy}
+```
+
+---
+
+## Ground Truth
+
+| Parameter | Value | Unit |
+|-----------|-------|------|
+| m | 1.0 | kg |
+| l | 1.0 | m |
+| k | 0.5 | N/m |
+| g | 9.81 | m/s² |
+| ω₁ | 3.1321 | rad/s |
+| ω₂ | 3.2636 | rad/s |
+| T_beat | ~48.0 | s |
+
+---
+
+## Noise Model
+
+Gaussian noise applied to θ₁ and θ₂: **σ = 0.005 rad**, seed = 456
+
+---
+
+## Files
+
+| File | Description |
+|------|-------------|
+| `data.csv` | Time series: t, θ₁_clean, θ₂_clean, θ₁_noisy, θ₂_noisy |
+| `data.hdf5` | Full-precision HDF5 with all attributes including ground-truth k |
+| `metadata.json` | Machine-readable description with normal mode frequencies |
+| `examples/estimate_normal_modes.py` | FFT-based normal mode frequency identification |
+| `examples/validate_forward.py` | Forward simulation validation |
+
+---
+
+## Citation
+
+```bibtex
+@software{mechanicsdsl2026,
+  author = {Parsons, Noah},
+  title  = {{MechanicsDSL}},
+  year   = {2026},
+  doi    = {10.5281/zenodo.17771040}
+}
+```