measurements and constraints [compat]

Author: islent

Project.toml

@@ -18,10 +18,11 @@ YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 
 [compat]
 DataFrames = "1"
-DocStringExtensions = "0.9.5"
+DocStringExtensions = "0.9"
 IterTools = "1"
-OrderedCollections = "1.8.1"
+OrderedCollections = "1"
 ProgressMeter = "1"
 Sobol = "1"
+TOML = "1"
 YAML = "0.4"
 julia = "1.6"

Readme.md

@@ -208,6 +208,66 @@ result = analyse_program(command, content, "param.txt", pspace, analyse;
     folder="output", filename="results.csv")
 ```
 
+### Experiment Data Management
+
+Manage experimental data, constraints, and analysis results:
+
+```julia
+using ParameterSpace
+
+# Create a dataset for experimental data
+ds = DataSet{ExperimentData}("axion-mass-constraints")
+
+# Add experiment data points
+add!(ds, ExperimentData(
+    DataSource(citekey="Smith2020", paper="Axion Search", 
+               year=2020, method="Haloscope"),
+    params=(mass=1e-6, coupling=1e-12),
+    results=(sigma=2.5,),
+    uncertainty=(sigma=0.3,)
+))
+
+# Add constraint data
+add!(ds, ConstraintData(
+    DataSource(citekey="Jones2021", paper="Dark Matter Limits", 
+               year=2021, method="CMB"),
+    param=:mass,
+    lower=1e-9, upper=1e-7,
+    constraint_type=:exclude
+))
+
+# Query and filter data
+subset = filter(ds) do e
+    e.source.year >= 2020 && haskey(e.params, :mass)
+end
+
+# Statistical analysis
+stats = compute_statistics(ds, :sigma)
+# Returns: mean, std, median, min, max, count
+
+# Find gaps in parameter space coverage
+gaps = find_gaps(ds, pspace; n_gaps=10)
+```
+
+### Data Sources and Citations
+
+Track data provenance with `DataSource`:
+
+```julia
+source = DataSource(
+    citekey="Smith2020",
+    paper="Axion Dark Matter Search",
+    year=2020,
+    method="Haloscope",
+    notes="First results from new detector"
+)
+
+# Access source information
+source.citekey  # "Smith2020"
+source.year     # 2020
+source.method   # "Haloscope"
+```
+
 ## Legacy API (Backward Compatibility)
 
 The original `Parameter` type is still supported:
@@ -246,6 +306,13 @@ result = analyse_function(g, params, 1.0)  # x is fixed at 1.0
 - `CoupledParamDim{T}`: Coupled parameter dimension
 - `Parameter{A}`: Legacy parameter type
 
+### Experiment Data Types
+- `DataSet{T}`: Generic dataset container
+- `ExperimentData`: Experimental data point with params, results, and uncertainty
+- `ConstraintData`: Constraint data with parameter bounds
+- `DataSource`: Source metadata (citekey, paper, year, method, notes)
+- `GapRegion`: Gap region in parameter space with center and priority
+
 ### Sampling Strategies
 - `AbstractSamplingStrategy`: Abstract base type
 - `RandomSampling(seed=nothing)`: Random uniform sampling
@@ -261,6 +328,15 @@ result = analyse_function(g, params, 1.0)  # x is fixed at 1.0
 - `load_yaml(filepath)`, `load_toml(filepath)`: Load from config files
 - `save_yaml(pspace, filepath)`, `save_toml(pspace, filepath)`: Save to config files
 
+### Experiment Data Functions
+- `add!(dataset, data)`: Add data to dataset
+- `filter(f, dataset)`: Filter dataset with predicate
+- `compute_statistics(dataset, field)`: Compute statistics for a field
+- `find_gaps(dataset, pspace; n_gaps)`: Find gaps in parameter space coverage
+- `get_param(data, param)`: Get parameter value
+- `get_result(data, result)`: Get result value
+- `source(data)`: Get data source information
+
 ## Examples
 
 See the `examples/` directory for more detailed examples:

src/ParameterSpace.jl

@@ -8,17 +8,32 @@ using DocStringExtensions
 using YAML
 using TOML
 
-import Base: iterate, length, eltype, show, getindex
+import Base: iterate, length, eltype, show, getindex, filter
 
+include("datacore.jl")
+include("dataset.jl")
+include("dataio.jl")
 include("paramdim.jl")
 include("coupled.jl")
 include("paramspace.jl")
+include("analysis.jl")
 include("sampling.jl")
 include("mask.jl")
 include("config.jl")
 include("compat.jl")
 include("analyse.jl")
 
+export DataSource, AbstractDataPoint, source
+export ConstraintData, is_valid, width, in_constraint, merge_constraints
+export is_include_constraint, is_exclude_constraint
+export ExperimentData, param_names, result_names, get_param, get_result
+export to_namedtuple, extract_paramdim
+export DataSet, name, add!, remove!, query
+export save_dataset, load_dataset
+export CoverageReport, analyze_coverage
+export GapRegion, find_gaps, recommend_points
+export ConstraintIntersection, intersect_constraints, allowed_region, is_allowed
+export filter_by_constraints, constraint_summary
 export Parameter, parameter_dimension, parameter_count
 export write_parameter_file, emptyfunction, mkoutputdir
 export analyse_function, analyse_program