camber-toolkit 0.1.0__tar.gz

camber_toolkit-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

camber_toolkit-0.1.0/MANIFEST.in

@@ -0,0 +1,7 @@
+# Keep the sdist library-only: the package + project metadata (README/LICENSE/
+# NOTICE/pyproject are included automatically). Tests and examples live in the
+# repo, not the published distribution.
+prune tests
+prune examples
+prune docs
+global-exclude __pycache__ *.py[cod]

camber_toolkit-0.1.0/NOTICE

@@ -0,0 +1,7 @@
+CAMBER — Commissioning, Analytics & M&V for Building Energy Re-tuning
+Copyright 2026 The CAMBER authors
+
+This product includes software for analyzing Building Automation System (BAS)
+trend data. Its algorithms are reimplemented from public standards (ASHRAE
+Guideline 36, Guideline 14, Standard 55, Standard 211; IPMVP; PNNL Building
+Re-tuning; NIST APAR). No third-party source code is included.

camber_toolkit-0.1.0/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: camber-toolkit
+Version: 0.1.0
+Summary: Vendor-neutral building-automation-system trend analysis: FDD, M&V, and retro-commissioning
+Author: The CAMBER authors
+License: Apache-2.0
+Keywords: BAS,HVAC,FDD,fault detection,measurement and verification,retro-commissioning,ASHRAE,energy,EMIS
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy<2,>=1.24
+Requires-Dist: pandas<3,>=2.0
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: pyarrow>=14
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Provides-Extra: brick
+Requires-Dist: rdflib>=6; extra == "brick"
+Provides-Extra: haystack
+Requires-Dist: phable>=0.1.0; python_version >= "3.11" and extra == "haystack"
+Requires-Dist: pyhaystack; python_version < "3.11" and extra == "haystack"
+Provides-Extra: tariff
+Requires-Dist: nrel-pysam>=4; extra == "tariff"
+Provides-Extra: better
+Requires-Dist: better-lbnl-os; extra == "better"
+Provides-Extra: psychro
+Requires-Dist: psychrolib>=2; extra == "psychro"
+Provides-Extra: pv
+Requires-Dist: pvlib>=0.10; extra == "pv"
+Provides-Extra: modbus
+Requires-Dist: pymodbus>=3; extra == "modbus"
+Provides-Extra: mqtt
+Requires-Dist: paho-mqtt>=1.6; extra == "mqtt"
+Provides-Extra: bacnet
+Requires-Dist: bacpypes3>=0.0.98; extra == "bacnet"
+Provides-Extra: opcua
+Requires-Dist: asyncua>=1.0; extra == "opcua"
+Dynamic: license-file
+
+# CAMBER
+
+[![CI](https://github.com/yroussev/camber/actions/workflows/ci.yml/badge.svg)](https://github.com/yroussev/camber/actions/workflows/ci.yml)
+
+**Commissioning, Analytics & M&V for Building Energy Re-tuning**
+
+A vendor-neutral Python toolkit for analyzing Building Automation System (BAS)
+trend data — fault detection & diagnostics (FDD), measurement & verification
+(M&V), and retro-commissioning (RCx) — across *any* building, independent of the
+BAS vendor.
+
+The core idea: points are mapped to a small vocabulary of vendor-neutral **roles**
+(`HEAT_VALVE`, `SUPPLY_AIR_TEMP`, `OAT`, …), and every diagnostic is written
+against those roles. Map a building's tags once and the whole rule set runs on it
+— one rule, all equipment, any BAS.
+
+## What it does
+
+- **Ingest** — adapters for per-point CSV exports, wide/tabular CSV, and a Project
+  Haystack `hisRead` client (behind an injectable transport).
+- **Semantic model** — a role vocabulary + mapping provider, plus a site/equipment
+  /point entity model with **completeness validation** (which analytics a
+  building's instrumentation can support). **Brick interop**: derive the
+  point→role mapping automatically from a building's Brick (`.ttl`) model.
+- **FDD** — a rule engine implementing ASHRAE Guideline 36 AFDD (operating states,
+  fault conditions FC#1–15, trim-and-respond resets) and PNNL Building Re-tuning
+  diagnostics (simultaneous heat/cool, reheat penalty, SAT/CHW reset, economizer,
+  boiler lockout, overcooling, setback, OA fraction incl. under-ventilation,
+  leaking valves, static/pump resets). Plus impact prioritization, fault-lifecycle
+  tracking, and an FDD-accuracy benchmark harness (scored against labeled data).
+- **M&V** — IPMVP / ASHRAE Guideline 14 change-point inverse models (2P–5P plus
+  heating-zero variants) and the LBNL Time-of-Week & Temperature (TOWT) model for
+  schedule-driven loads, CV(RMSE)/NMBE statistics and fractional savings
+  uncertainty, CUSUM savings tracking, weather normalization (TMY/EPW), and
+  rate/energy-aware resampling.
+- **Cost & carbon** — utility cost accounting (energy + demand + time-of-use, and
+  tiered water/wastewater with marginal vs. average rates) and GHG emissions
+  (eGRID/EIA factors → CO₂e and intensity).
+- **Water** — irrigation water budgets (ETo / landscape coefficient / efficiency /
+  effective precipitation), cooling-tower makeup (cycles of concentration,
+  gal/ton-hr), and leak detection (minimum night flow, flow duration, leak cost).
+- **Load profiling** — peak / near-peak / base, base-to-peak ratio, load factor,
+  load-duration curve, and weekday/weekend daily shapes.
+- **On-site systems** — PV performance ratio, specific yield, and net/self-
+  consumption energy; lighting operational efficiency vs. installed power with
+  controls-fault flags (failed setback, no turndown).
+- **Comfort** — Fanger PMV/PPD per ASHRAE Standard 55 / ISO 7730.
+- **Reporting** — ASHRAE/ACCA Standard 211 audit deliverables (benchmark +
+  prioritized findings + ECM table) to text/HTML, and a fleet/portfolio rollup
+  (cross-sectional EUI benchmarking + fleet-wide fault counts).
+- **Storage** — a Parquet time-series store keyed to the entity model, with
+  tag-filtered reads.
+- **Quality** — per-point data-quality scoring (robust outliers, flatline/gap
+  detection) with an auditable cleaning trail.
+- **Integration** — findings → CMMS-ticket records and a pluggable notifier; a
+  read-only HTTP API over the store (`python -m camber.api.server <store> [port]`:
+  `/sites`, `/points`, `/history`).
+
+## Install
+
+Python 3.10+. The PyPI distribution name is **`camber-toolkit`** (it imports as `camber`).
+
+```sh
+pip install camber-toolkit             # from PyPI
+pip install "camber-toolkit[brick]"    # + rdflib, for robust Brick-model parsing (optional)
+```
+
+From source (for development):
+
+```sh
+pip install -e .            # the package (editable)
+pip install -e .[dev]       # + pytest, for development
+pip install -e .[brick]     # + rdflib, for robust Brick-model parsing (optional)
+pip install -e .[haystack]  # + a Haystack client (phable / pyhaystack) (optional)
+```
+
+## Quickstart
+
+```sh
+python -m pytest -q                 # run the test suite
+python examples/synthetic_demo.py   # data-free FDD demo on generated trends
+```
+
+## Usage
+
+Everything runs on **role-named frames** — a DataFrame whose columns are
+vendor-neutral `Role`s. Map a building's tags to roles once, then every diagnostic
+and model runs on it.
+
+**Fault detection** — run a diagnostic, get a structured `Finding`:
+
+```python
+import numpy as np, pandas as pd
+from camber.model.roles import Role
+from camber.rules.simul_hc import SimultaneousHeatCool
+
+idx = pd.date_range("2025-07-07", periods=24 * 7, freq="1h")
+frame = pd.DataFrame({
+    Role.OAT:        90 + 10 * np.sin((idx.hour - 9) / 24 * 2 * np.pi),
+    Role.COOL_VALVE: 70.0,                                  # cooling all day
+    Role.HEAT_VALVE: np.where((idx.dayofweek < 5) & idx.hour.isin([11, 12, 13, 14]),
+                              40.0, 0.0),                    # midday reheat — a fault
+}, index=idx)
+
+f = SimultaneousHeatCool().analyze("AHU_1", frame)
+print(f.severity, f.metrics["simultaneous_hc_pct"])         # -> fault 36.36
+```
+
+**Measurement & verification** — fit a change-point baseline and score it:
+
+```python
+import numpy as np
+from camber.mandv.models import best_model, N_PARAMS
+from camber.mandv.stats import fit_stats
+
+oat = np.linspace(35, 100, 120)
+energy = 50 + np.clip(oat - 65, 0, None) * 3 + np.random.default_rng(0).normal(0, 2, 120)
+m = best_model(oat, energy)                                 # picks the inverse model
+st = fit_stats(energy, m.predict(oat), N_PARAMS[m.kind])
+print(m.kind, round(st.r2, 2), f"{st.cv_rmse:.0%}")         # -> 3PC 1.0 2%
+```
+
+**Your own building** — map point names → roles in a small JSON config (or derive
+it from a Brick model with `camber.interop.brick`), then `resolve()` assembles the
+role-frames. See `examples/` for end-to-end runs on public datasets.
+
+**Reproducible runs** — describe a whole analysis (source → mapping → equipment →
+rules → report) in one JSON config and run it without a script:
+
+```sh
+python -m camber.config run.json     # discovers equipment, runs the rules, writes the report
+```
+
+## Docker
+
+```sh
+docker build -t camber .
+docker run --rm camber               # runs the test suite as a clean-build proof
+docker run --rm -it camber bash      # interactive shell
+```
+
+Mount a building's CSV export at `/data` to run analytics on real trends.
+
+## Public datasets
+
+The toolkit is data-agnostic. Two open datasets are wired as runnable examples
+(referenced + fetched, not bundled):
+
+- **[LBNL Fault Detection and Diagnostics Datasets](https://www.osti.gov/dataexplorer/biblio/dataset/1881324)**
+  (CC-BY) — labeled single-duct-AHU data. `examples/lbnl_fdd/` maps its point
+  names to roles, validates completeness, round-trips through the Parquet store,
+  and detects a labeled stuck-damper fault (OAF ~21% baseline → ~100% fault).
+- **[Building Data Genome Project 2](https://github.com/buds-lab/building-data-genome-project-2)**
+  (CC-BY) — 3,053 whole-building hourly meters. `examples/bdg2/` fits the
+  G14/IPMVP change-point engine (textbook 3PC on cooling energy, R² 0.78–0.94)
+  and ingests the portfolio into the store.
+
+Each example has a `fetch.py` (downloads to the git-ignored `examples/_data/`) and
+a runnable script. See the per-example READMEs.
+
+## Contributing
+
+Contributions are welcome — new diagnostics, ingest adapters, M&V models, ontology
+interop, docs, and fixes. See [CONTRIBUTING.md](CONTRIBUTING.md) for the dev setup
+and conventions, [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the layered
+design, [ROADMAP.md](ROADMAP.md) for what's planned and where to help,
+[docs/ECOSYSTEM.md](docs/ECOSYSTEM.md) for the OSS-integration strategy, and the
+[Code of Conduct](CODE_OF_CONDUCT.md). Security reports: see [SECURITY.md](SECURITY.md).
+
+## Provenance
+
+This is a clean-room implementation. Algorithms are reimplemented from public
+standards — ASHRAE Guideline 36, Guideline 14, Standard 55, Standard 211; IPMVP;
+PNNL Building Re-tuning; NIST APAR. No third-party source code is included.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+> Status: pre-release (v0.x). APIs may change.

camber_toolkit-0.1.0/README.md

@@ -0,0 +1,180 @@
+# CAMBER
+
+[![CI](https://github.com/yroussev/camber/actions/workflows/ci.yml/badge.svg)](https://github.com/yroussev/camber/actions/workflows/ci.yml)
+
+**Commissioning, Analytics & M&V for Building Energy Re-tuning**
+
+A vendor-neutral Python toolkit for analyzing Building Automation System (BAS)
+trend data — fault detection & diagnostics (FDD), measurement & verification
+(M&V), and retro-commissioning (RCx) — across *any* building, independent of the
+BAS vendor.
+
+The core idea: points are mapped to a small vocabulary of vendor-neutral **roles**
+(`HEAT_VALVE`, `SUPPLY_AIR_TEMP`, `OAT`, …), and every diagnostic is written
+against those roles. Map a building's tags once and the whole rule set runs on it
+— one rule, all equipment, any BAS.
+
+## What it does
+
+- **Ingest** — adapters for per-point CSV exports, wide/tabular CSV, and a Project
+  Haystack `hisRead` client (behind an injectable transport).
+- **Semantic model** — a role vocabulary + mapping provider, plus a site/equipment
+  /point entity model with **completeness validation** (which analytics a
+  building's instrumentation can support). **Brick interop**: derive the
+  point→role mapping automatically from a building's Brick (`.ttl`) model.
+- **FDD** — a rule engine implementing ASHRAE Guideline 36 AFDD (operating states,
+  fault conditions FC#1–15, trim-and-respond resets) and PNNL Building Re-tuning
+  diagnostics (simultaneous heat/cool, reheat penalty, SAT/CHW reset, economizer,
+  boiler lockout, overcooling, setback, OA fraction incl. under-ventilation,
+  leaking valves, static/pump resets). Plus impact prioritization, fault-lifecycle
+  tracking, and an FDD-accuracy benchmark harness (scored against labeled data).
+- **M&V** — IPMVP / ASHRAE Guideline 14 change-point inverse models (2P–5P plus
+  heating-zero variants) and the LBNL Time-of-Week & Temperature (TOWT) model for
+  schedule-driven loads, CV(RMSE)/NMBE statistics and fractional savings
+  uncertainty, CUSUM savings tracking, weather normalization (TMY/EPW), and
+  rate/energy-aware resampling.
+- **Cost & carbon** — utility cost accounting (energy + demand + time-of-use, and
+  tiered water/wastewater with marginal vs. average rates) and GHG emissions
+  (eGRID/EIA factors → CO₂e and intensity).
+- **Water** — irrigation water budgets (ETo / landscape coefficient / efficiency /
+  effective precipitation), cooling-tower makeup (cycles of concentration,
+  gal/ton-hr), and leak detection (minimum night flow, flow duration, leak cost).
+- **Load profiling** — peak / near-peak / base, base-to-peak ratio, load factor,
+  load-duration curve, and weekday/weekend daily shapes.
+- **On-site systems** — PV performance ratio, specific yield, and net/self-
+  consumption energy; lighting operational efficiency vs. installed power with
+  controls-fault flags (failed setback, no turndown).
+- **Comfort** — Fanger PMV/PPD per ASHRAE Standard 55 / ISO 7730.
+- **Reporting** — ASHRAE/ACCA Standard 211 audit deliverables (benchmark +
+  prioritized findings + ECM table) to text/HTML, and a fleet/portfolio rollup
+  (cross-sectional EUI benchmarking + fleet-wide fault counts).
+- **Storage** — a Parquet time-series store keyed to the entity model, with
+  tag-filtered reads.
+- **Quality** — per-point data-quality scoring (robust outliers, flatline/gap
+  detection) with an auditable cleaning trail.
+- **Integration** — findings → CMMS-ticket records and a pluggable notifier; a
+  read-only HTTP API over the store (`python -m camber.api.server <store> [port]`:
+  `/sites`, `/points`, `/history`).
+
+## Install
+
+Python 3.10+. The PyPI distribution name is **`camber-toolkit`** (it imports as `camber`).
+
+```sh
+pip install camber-toolkit             # from PyPI
+pip install "camber-toolkit[brick]"    # + rdflib, for robust Brick-model parsing (optional)
+```
+
+From source (for development):
+
+```sh
+pip install -e .            # the package (editable)
+pip install -e .[dev]       # + pytest, for development
+pip install -e .[brick]     # + rdflib, for robust Brick-model parsing (optional)
+pip install -e .[haystack]  # + a Haystack client (phable / pyhaystack) (optional)
+```
+
+## Quickstart
+
+```sh
+python -m pytest -q                 # run the test suite
+python examples/synthetic_demo.py   # data-free FDD demo on generated trends
+```
+
+## Usage
+
+Everything runs on **role-named frames** — a DataFrame whose columns are
+vendor-neutral `Role`s. Map a building's tags to roles once, then every diagnostic
+and model runs on it.
+
+**Fault detection** — run a diagnostic, get a structured `Finding`:
+
+```python
+import numpy as np, pandas as pd
+from camber.model.roles import Role
+from camber.rules.simul_hc import SimultaneousHeatCool
+
+idx = pd.date_range("2025-07-07", periods=24 * 7, freq="1h")
+frame = pd.DataFrame({
+    Role.OAT:        90 + 10 * np.sin((idx.hour - 9) / 24 * 2 * np.pi),
+    Role.COOL_VALVE: 70.0,                                  # cooling all day
+    Role.HEAT_VALVE: np.where((idx.dayofweek < 5) & idx.hour.isin([11, 12, 13, 14]),
+                              40.0, 0.0),                    # midday reheat — a fault
+}, index=idx)
+
+f = SimultaneousHeatCool().analyze("AHU_1", frame)
+print(f.severity, f.metrics["simultaneous_hc_pct"])         # -> fault 36.36
+```
+
+**Measurement & verification** — fit a change-point baseline and score it:
+
+```python
+import numpy as np
+from camber.mandv.models import best_model, N_PARAMS
+from camber.mandv.stats import fit_stats
+
+oat = np.linspace(35, 100, 120)
+energy = 50 + np.clip(oat - 65, 0, None) * 3 + np.random.default_rng(0).normal(0, 2, 120)
+m = best_model(oat, energy)                                 # picks the inverse model
+st = fit_stats(energy, m.predict(oat), N_PARAMS[m.kind])
+print(m.kind, round(st.r2, 2), f"{st.cv_rmse:.0%}")         # -> 3PC 1.0 2%
+```
+
+**Your own building** — map point names → roles in a small JSON config (or derive
+it from a Brick model with `camber.interop.brick`), then `resolve()` assembles the
+role-frames. See `examples/` for end-to-end runs on public datasets.
+
+**Reproducible runs** — describe a whole analysis (source → mapping → equipment →
+rules → report) in one JSON config and run it without a script:
+
+```sh
+python -m camber.config run.json     # discovers equipment, runs the rules, writes the report
+```
+
+## Docker
+
+```sh
+docker build -t camber .
+docker run --rm camber               # runs the test suite as a clean-build proof
+docker run --rm -it camber bash      # interactive shell
+```
+
+Mount a building's CSV export at `/data` to run analytics on real trends.
+
+## Public datasets
+
+The toolkit is data-agnostic. Two open datasets are wired as runnable examples
+(referenced + fetched, not bundled):
+
+- **[LBNL Fault Detection and Diagnostics Datasets](https://www.osti.gov/dataexplorer/biblio/dataset/1881324)**
+  (CC-BY) — labeled single-duct-AHU data. `examples/lbnl_fdd/` maps its point
+  names to roles, validates completeness, round-trips through the Parquet store,
+  and detects a labeled stuck-damper fault (OAF ~21% baseline → ~100% fault).
+- **[Building Data Genome Project 2](https://github.com/buds-lab/building-data-genome-project-2)**
+  (CC-BY) — 3,053 whole-building hourly meters. `examples/bdg2/` fits the
+  G14/IPMVP change-point engine (textbook 3PC on cooling energy, R² 0.78–0.94)
+  and ingests the portfolio into the store.
+
+Each example has a `fetch.py` (downloads to the git-ignored `examples/_data/`) and
+a runnable script. See the per-example READMEs.
+
+## Contributing
+
+Contributions are welcome — new diagnostics, ingest adapters, M&V models, ontology
+interop, docs, and fixes. See [CONTRIBUTING.md](CONTRIBUTING.md) for the dev setup
+and conventions, [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the layered
+design, [ROADMAP.md](ROADMAP.md) for what's planned and where to help,
+[docs/ECOSYSTEM.md](docs/ECOSYSTEM.md) for the OSS-integration strategy, and the
+[Code of Conduct](CODE_OF_CONDUCT.md). Security reports: see [SECURITY.md](SECURITY.md).
+
+## Provenance
+
+This is a clean-room implementation. Algorithms are reimplemented from public
+standards — ASHRAE Guideline 36, Guideline 14, Standard 55, Standard 211; IPMVP;
+PNNL Building Re-tuning; NIST APAR. No third-party source code is included.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+> Status: pre-release (v0.x). APIs may change.

camber_toolkit-0.1.0/camber/__init__.py

@@ -0,0 +1,3 @@
+"""CAMBER — Commissioning, Analytics & M&V for Building Energy Re-tuning."""
+
+__version__ = "0.1.0"