elecevm 0.1.0__tar.gz

elecevm-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright 2026 Kyle Hagen
+
+   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.

elecevm-0.1.0/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: elecevm
+Version: 0.1.0
+Summary: Earned value management engine for electrical construction contractors — reference implementation of the Electrical EVM Recommended Practice
+Author: Kyle Hagen
+License: Apache-2.0
+Project-URL: Documentation, https://github.com/kylehagen2026/elecevm/blob/main/docs/standard.md
+Project-URL: Source, https://github.com/kylehagen2026/elecevm
+Keywords: earned value,EVM,ANSI-748,EIA-748,electrical construction,specialty contractor,project controls,Primavera P6,XER,Viewpoint Vista,job cost,rules of credit
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Other Audience
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Scheduling
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: charts
+Requires-Dist: matplotlib>=3.7; extra == "charts"
+Provides-Extra: xlsx
+Requires-Dist: openpyxl>=3.1; extra == "xlsx"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: matplotlib>=3.7; extra == "dev"
+Requires-Dist: openpyxl>=3.1; extra == "dev"
+Dynamic: license-file
+
+# elecevm — earned value for electrical construction
+
+**elecevm** is an open earned-value management (EVM) engine for electrical specialty
+contractors. It is the reference implementation of
+[*Earned Value Management for Electrical Construction — A Recommended Practice for
+Specialty Contractors*](docs/standard.md), which adapts ANSI/EIA-748 to how trade
+contractors actually run work: labor-hour-driven scope, weekly payroll statusing,
+a CPM schedule owned by the CM, and a job-cost ledger that was never designed to
+feed an EVM system.
+
+It takes three things every contractor already has — the schedule, the job-cost
+detail, and what the foremen installed this week — and produces defensible
+planned value, earned value, actual cost, indices, estimates at completion, a
+funding-crossover forecast and a Weekly Status Report, with every number tied
+back to its source and every statused week locked.
+
+Pure Python 3.11+, no required dependencies. Charts and `.xlsx` ingest are optional extras.
+
+## Why
+
+Electrical contractors keep cost in Vista, Spectrum or Sage and schedules in P6,
+and the two never meet. EVM practice lives at the owner/CM level and in defense
+work; specialty trades get a percent-complete column and a gut feel. This engine
+makes the connection reproducible:
+
+- **Planned value** from a cost-loaded copy of your own activities, allocated from
+  the estimate so that every discipline ties exactly and terminal PV equals BAC.
+- **Earned value** from field quantities through published electrical rules of
+  credit (conduit, feeders, gear, fixtures, fire alarm, telecom, instrumentation …),
+  with measurement tiers so an invoiced percent is never mistaken for a physical one.
+- **Actual cost** bucketed by transaction date to payroll weeks, reconciled to the
+  job-cost report to the cent, with declared basis rules per cost type (raw,
+  marked-up, or billed with a residual week).
+- **Analysis** on dollars *and* labor hours — the hours indices are what the field
+  can act on — plus every EAC method with one selected by rule, TCPI, thresholds,
+  crew curves and the week the AC curve crosses the funding line.
+- **A locked status log.** Statused weeks are never rewritten; restatements carry a
+  baseline change request and the old record stays in the file.
+- **Thirteen integrity checks** on every run (terminal PV = BAC, allocation ties,
+  hours conserved, AC reconciles, EV ≤ BAC, history contiguous, CO log ties, EAC
+  not below statistical, every activity in the baseline …). A run that fails a check says so and exits non-zero.
+
+## Install
+
+```bash
+pip install elecevm              # core
+pip install "elecevm[charts]"    # + matplotlib for the report charts
+pip install "elecevm[xlsx]"      # + openpyxl for .xlsx job-cost exports
+```
+
+From a checkout: `pip install -e ".[dev]"` then `pytest`.
+
+## Try it in one command
+
+```bash
+elecevm example --out elecevm-example
+```
+
+This writes a synthetic distribution-center electrical project (22 activities,
+three disciplines, ~960 ledger lines, weekly field quantities), builds the
+baseline, statuses 26 payroll weeks into a locked log and renders
+`wsr_wk26.html` — a Weekly Status Report with the cost curve, crew chart,
+discipline table, EAC methods, activity earned value and the integrity checks.
+The same inputs and outputs are committed under [`examples/distribution-center`](examples/distribution-center).
+
+## Using it on a project
+
+```text
+project/
+├── elecevm.toml      # calendars, disciplines, budget on two bases, CO log, AC basis rules
+├── schedule.csv      # or a P6 .xer export
+├── jobcost.csv       # Vista-style JC Detail export (.csv or .xlsx)
+└── quantities.csv    # weekly field progress by activity
+```
+
+```bash
+elecevm init project/                     # writes a commented elecevm.toml
+elecevm baseline --project elecevm.toml --schedule schedule.csv --out baseline.json
+elecevm status   --project elecevm.toml --schedule schedule.csv --baseline baseline.json \
+                 --jobcost jobcost.csv --quantities quantities.csv \
+                 --data-date 2026-09-05 --log status_log.jsonl --out snapshot.json
+elecevm report   --project elecevm.toml --schedule schedule.csv --baseline baseline.json \
+                 --jobcost jobcost.csv --quantities quantities.csv --log status_log.jsonl --out wsr.html
+elecevm check    ...                      # integrity checks only, exit 2 on failure
+elecevm backfill ... --through 2026-09-05 # status every unstatused week into the log
+```
+
+Options worth knowing: `--source-totals "L=hours:amount,M=...,S=..."` (or a JSON
+file) gives the totals printed on the job-cost report so check 5 can reconcile the
+pull against something independent — without it the check is reported as NOT RUN;
+`--billed-labor` / `--billed-material` supply billed-to-date values for the
+*billed* AC basis; `--management-etc` supplies a bottom-up estimate to complete so
+the reported EAC can follow the `max(management, BAC/CPI)` rule; `--invoiced-pct`
+feeds Tier 3 activities; `--schedule-data-date` tells a backfill when the schedule
+file was statused so earlier weeks are interpolated rather than taking a later
+percent complete.
+
+A week whose checks fail is **not** written to the log (pass
+`--allow-failed-checks` to lock it with the failures recorded). Each `status`
+saves the raw pull under `pulls/` beside the log; the next status compares the
+two and annotates any late posting into a locked week (RP §7.2) instead of
+rewriting that week's row.
+
+### Inputs
+
+**`elecevm.toml`** — see [`src/elecevm/config.py`](src/elecevm/config.py) (`template_toml()`)
+for the commented schema: project start and payroll week-ending day, work calendar
+and holidays, standard hours per head per week, contracted value (the funding line),
+reporting basis (`contracted` or `estimated`), disciplines with composite rates,
+budget by discipline × cost type on each basis, the change-order log, AC basis per
+cost type, EAC policy and thresholds, optional crew-cap leveling, and the
+phase → discipline and cost-type maps for the ledger.
+
+**Schedule** — a CSV with `id, name, discipline, area, start, finish, actual_start,
+actual_finish, forecast_finish, original_duration, percent_complete, budget_hours,
+hours_per_day, area_weight, activity_factor, ev_method, commodity, base_activity`,
+or a P6 `.xer` (TASK/PROJWBS/TASKRSRC tables; discipline and area resolved from the
+activity ID by default, pluggable).
+
+**Job cost** — one row per ledger transaction with phase/cost code, cost type,
+transaction date, posted date, hours, amount. Column names are matched
+case-insensitively; disciplines come from `[phase_map]`, cost classes from
+`[cost_type_map]`.
+
+**Quantities** — `activity_id, as_of, commodity, item, uom, total_qty,
+installed_qty, milestones, milestone_progress, percent_complete, reported_by`.
+Milestones are the names in the rule of credit (`layout;supports`), partial
+progress is `name=fraction` (`conduit_installed=0.4`).
+
+### Python API
+
+```python
+from datetime import date
+from elecevm import load_project, build_baseline, bucket_transactions, apply_basis, compute_status, StatusLog
+from elecevm.ingest import activities_from_csv, read_jobcost_csv, read_quantities_csv, source_totals
+
+project    = load_project("elecevm.toml")
+activities = activities_from_csv("schedule.csv")
+baseline   = build_baseline(project, activities, created=project.week_cal.start)
+txns       = read_jobcost_csv("jobcost.csv", project)
+records    = read_quantities_csv("quantities.csv")
+
+data_date = date(2026, 9, 5)
+week      = project.week_cal.status_week(data_date)
+actuals   = apply_basis(bucket_transactions(txns, project.week_cal, week), project.ac_basis)
+log       = StatusLog("status_log.jsonl")
+snap      = compute_status(project, baseline, activities, actuals, records, data_date,
+                           history=log.history(), source_totals=source_totals(txns))
+log.append(snap.to_record())
+print(snap.spi_hours, snap.cpi_hours, snap.eac, snap.crossover_week, snap.all_checks_pass)
+```
+
+## How the engine maps to the Recommended Practice
+
+| RP section | Module |
+| --- | --- |
+| §4 Control structure, bases, calendars | `config.py`, `models.py`, `calendar.py` |
+| §5 Cost-loaded schedule and PV, leveling, baseline control | `allocation.py`, `curves.py` |
+| §6 EV measurement tiers and electrical rules of credit | `rules_of_credit.py`, `evm.py` |
+| §7 Actual cost bucketing, basis rules, reconciliation, late postings | `actuals.py` |
+| §8 Indices, EAC selection, funding crossover, crew | `evm.py`, `crew.py` |
+| §9 Locked status log and the WSR | `status_log.py`, `report.py` |
+| §11 Integrity checks | `evm.health_checks` |
+| §12 Data pulls | `ingest/` |
+
+## Calibrate, don't copy
+
+The rules of credit ship with default milestone weights. They are a reasonable
+published starting point, not your labor-unit distribution. The practice asks
+each contractor to calibrate the weights to its own estimating data and record
+the calibrated set with the project; a future release will accept a custom
+rules table in `elecevm.toml`.
+
+## Known limitations in 0.1.0
+
+- Rules of credit are the shipped defaults; a custom table in `elecevm.toml` is the next release.
+- The billed AC basis takes one billed-to-date figure per cost type for the status week; a backfill applies it to the final week only and carries earlier weeks at ledger × markup (noted on the report).
+- `curves.taper_to_floor` is implemented and tested but not yet wired into baseline building; a long commissioning tail is phased by the activity dates for now.
+- Check 7 (status week complete) is satisfied by construction in this engine and is kept for conformance reporting.
+- A Vista JC Detail **PDF** is not parsed; export the detail to Excel/CSV first.
+
+## Status and roadmap
+
+`0.1.0` is an alpha: the engine, the example and the test suite are complete;
+the report is HTML. Planned: custom rules-of-credit tables in the configuration,
+a PDF export of the WSR, a Vista JC Detail PDF text extractor, restatement
+tooling for late postings, and a labor-unit calibration module that turns
+quantity-tracked actuals into condition-adjusted productivity rates.
+
+Contributions, field data corrections and challenges to the default weights are
+welcome — open an issue with the commodity, the proposed weights and the basis
+for them.
+
+## License
+
+Apache-2.0. Copyright 2026 Kyle Hagen. Not affiliated with or endorsed by NECA,
+AACE International, Oracle (Primavera) or Trimble (Viewpoint).

elecevm-0.1.0/README.md

@@ -0,0 +1,197 @@
+# elecevm — earned value for electrical construction
+
+**elecevm** is an open earned-value management (EVM) engine for electrical specialty
+contractors. It is the reference implementation of
+[*Earned Value Management for Electrical Construction — A Recommended Practice for
+Specialty Contractors*](docs/standard.md), which adapts ANSI/EIA-748 to how trade
+contractors actually run work: labor-hour-driven scope, weekly payroll statusing,
+a CPM schedule owned by the CM, and a job-cost ledger that was never designed to
+feed an EVM system.
+
+It takes three things every contractor already has — the schedule, the job-cost
+detail, and what the foremen installed this week — and produces defensible
+planned value, earned value, actual cost, indices, estimates at completion, a
+funding-crossover forecast and a Weekly Status Report, with every number tied
+back to its source and every statused week locked.
+
+Pure Python 3.11+, no required dependencies. Charts and `.xlsx` ingest are optional extras.
+
+## Why
+
+Electrical contractors keep cost in Vista, Spectrum or Sage and schedules in P6,
+and the two never meet. EVM practice lives at the owner/CM level and in defense
+work; specialty trades get a percent-complete column and a gut feel. This engine
+makes the connection reproducible:
+
+- **Planned value** from a cost-loaded copy of your own activities, allocated from
+  the estimate so that every discipline ties exactly and terminal PV equals BAC.
+- **Earned value** from field quantities through published electrical rules of
+  credit (conduit, feeders, gear, fixtures, fire alarm, telecom, instrumentation …),
+  with measurement tiers so an invoiced percent is never mistaken for a physical one.
+- **Actual cost** bucketed by transaction date to payroll weeks, reconciled to the
+  job-cost report to the cent, with declared basis rules per cost type (raw,
+  marked-up, or billed with a residual week).
+- **Analysis** on dollars *and* labor hours — the hours indices are what the field
+  can act on — plus every EAC method with one selected by rule, TCPI, thresholds,
+  crew curves and the week the AC curve crosses the funding line.
+- **A locked status log.** Statused weeks are never rewritten; restatements carry a
+  baseline change request and the old record stays in the file.
+- **Thirteen integrity checks** on every run (terminal PV = BAC, allocation ties,
+  hours conserved, AC reconciles, EV ≤ BAC, history contiguous, CO log ties, EAC
+  not below statistical, every activity in the baseline …). A run that fails a check says so and exits non-zero.
+
+## Install
+
+```bash
+pip install elecevm              # core
+pip install "elecevm[charts]"    # + matplotlib for the report charts
+pip install "elecevm[xlsx]"      # + openpyxl for .xlsx job-cost exports
+```
+
+From a checkout: `pip install -e ".[dev]"` then `pytest`.
+
+## Try it in one command
+
+```bash
+elecevm example --out elecevm-example
+```
+
+This writes a synthetic distribution-center electrical project (22 activities,
+three disciplines, ~960 ledger lines, weekly field quantities), builds the
+baseline, statuses 26 payroll weeks into a locked log and renders
+`wsr_wk26.html` — a Weekly Status Report with the cost curve, crew chart,
+discipline table, EAC methods, activity earned value and the integrity checks.
+The same inputs and outputs are committed under [`examples/distribution-center`](examples/distribution-center).
+
+## Using it on a project
+
+```text
+project/
+├── elecevm.toml      # calendars, disciplines, budget on two bases, CO log, AC basis rules
+├── schedule.csv      # or a P6 .xer export
+├── jobcost.csv       # Vista-style JC Detail export (.csv or .xlsx)
+└── quantities.csv    # weekly field progress by activity
+```
+
+```bash
+elecevm init project/                     # writes a commented elecevm.toml
+elecevm baseline --project elecevm.toml --schedule schedule.csv --out baseline.json
+elecevm status   --project elecevm.toml --schedule schedule.csv --baseline baseline.json \
+                 --jobcost jobcost.csv --quantities quantities.csv \
+                 --data-date 2026-09-05 --log status_log.jsonl --out snapshot.json
+elecevm report   --project elecevm.toml --schedule schedule.csv --baseline baseline.json \
+                 --jobcost jobcost.csv --quantities quantities.csv --log status_log.jsonl --out wsr.html
+elecevm check    ...                      # integrity checks only, exit 2 on failure
+elecevm backfill ... --through 2026-09-05 # status every unstatused week into the log
+```
+
+Options worth knowing: `--source-totals "L=hours:amount,M=...,S=..."` (or a JSON
+file) gives the totals printed on the job-cost report so check 5 can reconcile the
+pull against something independent — without it the check is reported as NOT RUN;
+`--billed-labor` / `--billed-material` supply billed-to-date values for the
+*billed* AC basis; `--management-etc` supplies a bottom-up estimate to complete so
+the reported EAC can follow the `max(management, BAC/CPI)` rule; `--invoiced-pct`
+feeds Tier 3 activities; `--schedule-data-date` tells a backfill when the schedule
+file was statused so earlier weeks are interpolated rather than taking a later
+percent complete.
+
+A week whose checks fail is **not** written to the log (pass
+`--allow-failed-checks` to lock it with the failures recorded). Each `status`
+saves the raw pull under `pulls/` beside the log; the next status compares the
+two and annotates any late posting into a locked week (RP §7.2) instead of
+rewriting that week's row.
+
+### Inputs
+
+**`elecevm.toml`** — see [`src/elecevm/config.py`](src/elecevm/config.py) (`template_toml()`)
+for the commented schema: project start and payroll week-ending day, work calendar
+and holidays, standard hours per head per week, contracted value (the funding line),
+reporting basis (`contracted` or `estimated`), disciplines with composite rates,
+budget by discipline × cost type on each basis, the change-order log, AC basis per
+cost type, EAC policy and thresholds, optional crew-cap leveling, and the
+phase → discipline and cost-type maps for the ledger.
+
+**Schedule** — a CSV with `id, name, discipline, area, start, finish, actual_start,
+actual_finish, forecast_finish, original_duration, percent_complete, budget_hours,
+hours_per_day, area_weight, activity_factor, ev_method, commodity, base_activity`,
+or a P6 `.xer` (TASK/PROJWBS/TASKRSRC tables; discipline and area resolved from the
+activity ID by default, pluggable).
+
+**Job cost** — one row per ledger transaction with phase/cost code, cost type,
+transaction date, posted date, hours, amount. Column names are matched
+case-insensitively; disciplines come from `[phase_map]`, cost classes from
+`[cost_type_map]`.
+
+**Quantities** — `activity_id, as_of, commodity, item, uom, total_qty,
+installed_qty, milestones, milestone_progress, percent_complete, reported_by`.
+Milestones are the names in the rule of credit (`layout;supports`), partial
+progress is `name=fraction` (`conduit_installed=0.4`).
+
+### Python API
+
+```python
+from datetime import date
+from elecevm import load_project, build_baseline, bucket_transactions, apply_basis, compute_status, StatusLog
+from elecevm.ingest import activities_from_csv, read_jobcost_csv, read_quantities_csv, source_totals
+
+project    = load_project("elecevm.toml")
+activities = activities_from_csv("schedule.csv")
+baseline   = build_baseline(project, activities, created=project.week_cal.start)
+txns       = read_jobcost_csv("jobcost.csv", project)
+records    = read_quantities_csv("quantities.csv")
+
+data_date = date(2026, 9, 5)
+week      = project.week_cal.status_week(data_date)
+actuals   = apply_basis(bucket_transactions(txns, project.week_cal, week), project.ac_basis)
+log       = StatusLog("status_log.jsonl")
+snap      = compute_status(project, baseline, activities, actuals, records, data_date,
+                           history=log.history(), source_totals=source_totals(txns))
+log.append(snap.to_record())
+print(snap.spi_hours, snap.cpi_hours, snap.eac, snap.crossover_week, snap.all_checks_pass)
+```
+
+## How the engine maps to the Recommended Practice
+
+| RP section | Module |
+| --- | --- |
+| §4 Control structure, bases, calendars | `config.py`, `models.py`, `calendar.py` |
+| §5 Cost-loaded schedule and PV, leveling, baseline control | `allocation.py`, `curves.py` |
+| §6 EV measurement tiers and electrical rules of credit | `rules_of_credit.py`, `evm.py` |
+| §7 Actual cost bucketing, basis rules, reconciliation, late postings | `actuals.py` |
+| §8 Indices, EAC selection, funding crossover, crew | `evm.py`, `crew.py` |
+| §9 Locked status log and the WSR | `status_log.py`, `report.py` |
+| §11 Integrity checks | `evm.health_checks` |
+| §12 Data pulls | `ingest/` |
+
+## Calibrate, don't copy
+
+The rules of credit ship with default milestone weights. They are a reasonable
+published starting point, not your labor-unit distribution. The practice asks
+each contractor to calibrate the weights to its own estimating data and record
+the calibrated set with the project; a future release will accept a custom
+rules table in `elecevm.toml`.
+
+## Known limitations in 0.1.0
+
+- Rules of credit are the shipped defaults; a custom table in `elecevm.toml` is the next release.
+- The billed AC basis takes one billed-to-date figure per cost type for the status week; a backfill applies it to the final week only and carries earlier weeks at ledger × markup (noted on the report).
+- `curves.taper_to_floor` is implemented and tested but not yet wired into baseline building; a long commissioning tail is phased by the activity dates for now.
+- Check 7 (status week complete) is satisfied by construction in this engine and is kept for conformance reporting.
+- A Vista JC Detail **PDF** is not parsed; export the detail to Excel/CSV first.
+
+## Status and roadmap
+
+`0.1.0` is an alpha: the engine, the example and the test suite are complete;
+the report is HTML. Planned: custom rules-of-credit tables in the configuration,
+a PDF export of the WSR, a Vista JC Detail PDF text extractor, restatement
+tooling for late postings, and a labor-unit calibration module that turns
+quantity-tracked actuals into condition-adjusted productivity rates.
+
+Contributions, field data corrections and challenges to the default weights are
+welcome — open an issue with the commodity, the proposed weights and the basis
+for them.
+
+## License
+
+Apache-2.0. Copyright 2026 Kyle Hagen. Not affiliated with or endorsed by NECA,
+AACE International, Oracle (Primavera) or Trimble (Viewpoint).

elecevm-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "elecevm"
+version = "0.1.0"
+description = "Earned value management engine for electrical construction contractors — reference implementation of the Electrical EVM Recommended Practice"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Kyle Hagen" }]
+keywords = [
+  "earned value", "EVM", "ANSI-748", "EIA-748", "electrical construction", "specialty contractor",
+  "project controls", "Primavera P6", "XER", "Viewpoint Vista", "job cost", "rules of credit",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Other Audience",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Office/Business :: Scheduling",
+  "Topic :: Office/Business :: Financial :: Accounting",
+]
+dependencies = []
+
+[project.optional-dependencies]
+charts = ["matplotlib>=3.7"]
+xlsx = ["openpyxl>=3.1"]
+dev = ["pytest>=7", "matplotlib>=3.7", "openpyxl>=3.1"]
+
+[project.scripts]
+elecevm = "elecevm.cli:main"
+
+[project.urls]
+Documentation = "https://github.com/kylehagen2026/elecevm/blob/main/docs/standard.md"
+Source = "https://github.com/kylehagen2026/elecevm"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

elecevm-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+