Contract
- Input: experiment setup, measurements, calibration data.
- Output: digital notebook entry + FAIR checklist.
- Side effects: none.
- Dependencies: none.
- Stop condition: entry complete; FAIR checklist filled.
- Risk: low.
- Boundary: produces documentation artifacts; no changes to equipment.
Experimental Physics Notebook
Build an experimental lab notebook — structured, reproducible, FAIR-compliant — that another physicist could use to reproduce the measurement.
When to use
- A measurement has been made.
- Data must be preserved for publication or collaboration.
- A reviewer asks for raw data or calibration details.
Process
1. Experiment description
State:
- Physical system — apparatus, conditions (T, P, B, etc.), scale.
- Measured quantity — with units and expected magnitude.
- Purpose — hypothesis tested or parameter extracted.
- References — theory / prior measurement.
Completion criterion: all elements present.
2. Setup and calibration
Document:
- Apparatus — instruments with model numbers, settings.
- Calibration procedure — standard source, method, date, result.
- Traceability — chain to a national/international standard if applicable.
- Calibration uncertainty — propagated into the final result.
Completion criterion: calibration documented with traceability and uncertainty.
3. Measurements
Record:
- Raw data — time stamps, conditions, instrument readings.
- Data format — file format (CSV, HDF5, ROOT) with schema description.
- Sampling rate / integration time — with justification.
- Environment conditions — during measurement (temperature, humidity, magnetic field, vibration).
Completion criterion: raw data linked; format described.
4. Error analysis
Distinguish:
- Statistical errors — variance of repeated measurements.
- Systematic errors — calibration errors, instrument bias, environmental effects.
- Combined uncertainty — root-sum-square or full covariance matrix.
- Sensitivity analysis — how does the result change with key parameter perturbation?
Completion criterion: statistical and systematic errors quantified; combined uncertainty reported.
5. FAIR checklist
- Findable — metadata (title, authors, date, keywords) in a repository (Zenodo, OSF, institutional).
- Accessible — open access policy; file formats (CSV, HDF5) with open specifications.
- Interoperable — metadata uses standard vocabularies (e.g. Dublin Core, DataCite, FAIRsharing).
- Reusable — licence (CC0 / MIT), code for analysis linked, version control (Git tag / DOI).
Completion criterion: checklist filled; DOI or Git tag assigned.
6. Deliver
Markdown entry with: description, setup, calibration, measurements, error analysis, FAIR checklist, and linked data. The entry should be readable by another physicist without the original experimenter.
Completion criterion: entry saved; all links active; FAIR checklist complete.
1---2name: physics-experimental-notebook3description: Maintain experimental physics lab notebooks — measurements, calibration, error analysis, FAIR data principles, reproducibility — with digital and physical structure.4---56## Contract78- **Input:** experiment setup, measurements, calibration data.9- **Output:** digital notebook entry + FAIR checklist.10- **Side effects:** none.11- **Dependencies:** none.12- **Stop condition:** entry complete; FAIR checklist filled.13- **Risk:** low.14- **Boundary:** produces documentation artifacts; no changes to equipment.1516# Experimental Physics Notebook1718Build an **experimental lab notebook** — structured, reproducible, FAIR-compliant — that another physicist could use to reproduce the measurement.1920## When to use2122- A measurement has been made.23- Data must be preserved for publication or collaboration.24- A reviewer asks for raw data or calibration details.2526## Process2728### 1. Experiment description2930State:3132- **Physical system** — apparatus, conditions (T, P, B, etc.), scale.33- **Measured quantity** — with units and expected magnitude.34- **Purpose** — hypothesis tested or parameter extracted.35- **References** — theory / prior measurement.3637**Completion criterion:** all elements present.3839### 2. Setup and calibration4041Document:4243- **Apparatus** — instruments with model numbers, settings.44- **Calibration procedure** — standard source, method, date, result.45- **Traceability** — chain to a national/international standard if applicable.46- **Calibration uncertainty** — propagated into the final result.4748**Completion criterion:** calibration documented with traceability and uncertainty.4950### 3. Measurements5152Record:5354- **Raw data** — time stamps, conditions, instrument readings.55- **Data format** — file format (CSV, HDF5, ROOT) with schema description.56- **Sampling rate / integration time** — with justification.57- **Environment conditions** — during measurement (temperature, humidity, magnetic field, vibration).5859**Completion criterion:** raw data linked; format described.6061### 4. Error analysis6263Distinguish:6465- **Statistical errors** — variance of repeated measurements.66- **Systematic errors** — calibration errors, instrument bias, environmental effects.67- **Combined uncertainty** — root-sum-square or full covariance matrix.68- **Sensitivity analysis** — how does the result change with key parameter perturbation?6970**Completion criterion:** statistical and systematic errors quantified; combined uncertainty reported.7172### 5. FAIR checklist7374- **Findable** — metadata (title, authors, date, keywords) in a repository (Zenodo, OSF, institutional).75- **Accessible** — open access policy; file formats (CSV, HDF5) with open specifications.76- **Interoperable** — metadata uses standard vocabularies (e.g. Dublin Core, DataCite, FAIRsharing).77- **Reusable** — licence (CC0 / MIT), code for analysis linked, version control (Git tag / DOI).7879**Completion criterion:** checklist filled; DOI or Git tag assigned.8081### 6. Deliver8283Markdown entry with: description, setup, calibration, measurements, error analysis, FAIR checklist, and linked data. The entry should be readable by another physicist without the original experimenter.8485**Completion criterion:** entry saved; all links active; FAIR checklist complete.