pepe
72dd781dbc
Audit every document in the repository, convert the non-markdown ones into markdown reports, and split current documentation from outdated material. docs/ — 31 markdown documents in seven numbered sections. Twenty are new reports generated from .docx / .pdf / .xlsx / .mlx / .m sources that were previously unreadable in the browser and undiffable in git. Each report carries a provenance block (source path, format, MD5) and links back to its original; all 13 recorded checksums verify against the files on disk. Machine-extraction losses (PDF table column interleaving, Word OMML equations, embedded figures) are called out explicitly rather than silently smoothed over. superseded/ — outdated material with a documented reason per entry: two byte-identical ClickUp re-exports, an older revision of the BIDMC/UCSD energy-flow doc (the retained copy adds the SoC Violation Rate KPI), a duplicate of Shift input data.docx, the May 2026 simulation plan, the root PV+Battery.md now covered by a fuller report, GitHub's stock demo-repository template, and a zero-byte placeholder. Its README also records what was deliberately NOT retired and why — the "Old Frameworks" and "Old Simulations" folders hold unique Simulink revisions, and "Big Ugly Folder" holds the only copy of framework revision 1.3. Findings worth flagging, all documented in the reports: - Simulink lineage recovered from each .slx's internal coreProperties.xml revision counter. The current model is Current Framework/Bobert0206_Initial_Simulation_Framework.slx (rev 2.7); the top-level copy is rev 1.3, five revisions behind. - Simulations/Constants.m is a truncated byte-prefix of the Current Framework copy, silently missing H2_leak, H2_cap and E_H2_vol_h. - The PEM electrolyser and fuel cell are unmodified MathWorks Simscape examples still at vendor defaults; the "10x bigger" sizing TODO recorded in Constants.m was never carried out. - controller-claude.m does not compile — undefined P_Electro_max, outputs unassigned on several paths. - The specification set uses two incompatible variable naming conventions and disagrees on action-space size (5 vs 16). - MA_hourly_load.csv (13.7 MB) is the same 35,040 rows as 89993-0.parquet (2.4 MB). - Clinical data is the MIMIC-IV *demo* (ODbL, 100 patients), not full MIMIC-IV — redistributable, but the licence and citation are unrecorded. Housekeeping: untrack 21 Simulink build artefacts (slprj/, *.slxc) and add ignore rules for them. Root README rewritten around the new layout. Recruitment notes naming individual candidates are excluded from version control via .gitignore rather than committed; the generic question template is kept in docs/07-team-and-operations/. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| demo-repository | ||
| BIDCM-UCSD hybrid hospital energy flow and balances (older revision).docx | ||
| Cost Analysis Excel File-20260725175434.md | ||
| github-profile-photos-temp.md | ||
| MAY MONTH SIMULATION PLANS-20260725175516.md | ||
| PV+Battery.md | ||
| README.md | ||
| Shift input data (duplicate copy).docx | ||
| Social Cost-Benefit Analysis-20260725174919.md | ||
Superseded documents
Nothing here is current. Every file in this folder has been replaced, duplicated, or has expired — but is kept because deleting project history is worse than storing a few kilobytes.
If you are looking for current documentation, go to docs/.
Each entry below records why it was retired and what replaced it. If you disagree with a call, the evidence is stated — argue with the evidence.
Exact duplicates
Two files, byte-identical to a file still in docs/. Both are ClickUp bulk exports made on
2026-07-25 where the same page was exported twice, seconds apart.
| File | Identical to | MD5 |
|---|---|---|
Cost Analysis Excel File-20260725175434.md |
docs/05-business-economics/cost-analysis.md |
2cbbb87f383126cd2f27bee20cc1f636 |
Social Cost-Benefit Analysis-20260725174919.md |
docs/05-business-economics/social-cost-benefit-analysis.md |
fe37dd0ba965306ae4b6623d0e808178 |
Evidence: identical MD5. The retained copy is the earlier export of each pair (…5431 and …4855 respectively); the choice between two identical files is arbitrary.
Older revisions
BIDCM-UCSD hybrid hospital energy flow and balances (older revision).docx
Was: Shift Matlab Drive/Shift Matlab Drive/Energy_Managment/BIDCM-UCSD hybrid hospital energy flow and balances.docx
Superseded by: the copy in
Energy_Managment/Beth Israel Deaconess Medical Center/, reported at
docs/03-energy-management/bidmc-ucsd-energy-flow-and-balances.md.
Evidence: the two files differ by exactly one addition. The newer revision appends the SoC Violation Rate KPI, its formula, and its 0% target:
+ - SoC Violation Rate:
+ - Aiming for 0% , so that the battery never went dangerously low (risking losing from
+ Tier 1 load ) or overcharged (risking hardware damage)
Everything else is identical. This is a strict superset relationship — nothing is lost.
PV+Battery.md
Was: PV+Battery.md at the repository root.
Superseded by: docs/04-simulations/pv-battery-simulink.md.
Evidence: this file was a plain-markdown transcription of
Simulations/PV+Battery Simulink/PV+Battery.docx — same five sections, same wording, same
"To be continued" list. The new report covers the same ground and transcribes
PVBatteryRead.mlx and Constants.mlx, cross-checks the constants against the project
specification, and diagnoses the time-dependency bug. The .docx original stays where it is.
Shift input data (duplicate copy).docx
Was: Shift Matlab Drive/Shift Matlab Drive/Simulations/Old Simulations/Shift input data.docx
Evidence: byte-identical (MD5 b4e1cea6…) to
Simulations/Shift input data.docx, which remains in place and is reported at
docs/04-simulations/shift-input-data.md. This
was the copy inside Old Simulations/.
Time-expired
MAY MONTH SIMULATION PLANS-20260725175516.md
A status-and-plan snapshot for May 2026. Today is 2026-07-25.
Why retired: it is a dated plan whose horizon has passed, and its status claims are stale by construction — "Current progress is around 75% done", "Grid is not ready thats all", "Step 2 — Define Inputs and Outputs - (Completed)".
Where its content lives now:
| Content | Current home |
|---|---|
| Component list and I/O definitions | docs/02-specifications/simulator-io-interface.md |
| Model integration status | docs/04-simulations/simulink-model-inventory.md |
| Hospital data research | docs/06-data/dataset-inventory.md |
Kept because it is the only record of the digital-twin-paper rationale for the component-based modelling approach, and of the outreach effort ("3 replies received") to people with digital-twin and microgrid experience. That is project history worth not losing.
Stock templates and empty files
demo-repository/
GitHub's stock organisation demo template. Contains index.html, package.json, and two
sample workflows (auto-assign.yml, proof-html.yml).
Evidence: the README is unedited GitHub boilerplate —
"This code repository (or "repo") is designed to demonstrate the best GitHub has to offer with the least amount of noise."
No SHIFT-specific content of any kind. The workflow badges point at
github.com/Team-SHIFT-Space/demo-repository, not at anything this project builds.
github-profile-photos-temp.md
Was: .github/profile/photos/temp.md — a zero-byte file whose only purpose was to let git
track the otherwise-empty photos/ directory before the PNGs were added. The directory now has
three images, so the placeholder is redundant.
What was not retired, and why
Several things look retirable and are deliberately kept in place. Recording the reasoning here so it does not have to be re-derived.
Simulations/Old Frameworks/ and Simulations/Old Simulations/
Despite the names, these hold unique Simulink revisions that exist nowhere else:
| File | Revision | Unique? |
|---|---|---|
Old Frameworks/Copy_of_Initial_Simulation_Framework.slx |
2.2 | ✅ only copy |
Old Frameworks/EL20N_Electrolyser_Model.slx |
1.3 | ✅ only copy |
Old Frameworks/electrolyserNEW.slx |
1.1 | ✅ only copy |
Old Frameworks/FC_DigitalTwin_MathModel.slx |
1.1 | ✅ only copy of rev 1.1 |
Old Simulations/Initial_Simulation_Framework.slx.autosave |
1.2 | ✅ only trace of rev 1.2 |
Moving binary Simulink models around risks breaking model references in ways that are invisible
until someone opens MATLAB. They stay put; the lineage is documented instead at
docs/04-simulations/simulink-model-inventory.md.
Simulations/Big Ugly Folder/
21 of its 22 files are byte-identical duplicates of the two "Ready Made" folders — but its
Initial_Simulation_Framework.slx (revision 1.3, 1.03 MB, MD5 46010d0d) is unique.
Deleting the folder would lose it.
Exisiting EST Model/
Vendored third-party code, MIT-licensed, © 2023 Energy Storage and Transport, from
gitlab.tue.nl. Its internal duplicates and its ~100 MATLAB Project bookkeeping XMLs are
upstream's structure, not a defect here. Nothing inside it was touched. See
docs/04-simulations/existing-est-model.md.
website/images/
Superficially a superseded predecessor of website/public/images/ — several files are the same
size (sim.png / cluster-sim.png at 2.30 MB, business.png / cluster-business.png at
2.08 MB). But the Astro build only serves public/, and confirming that nothing references the
legacy folder requires a build check that has not been run. Left alone pending that check.
RL_ML/Empty.mlx, Energy_Managment/Emptier.mlx, Business_Economics/Emptiest.mlx
Each contains a single string literal ('Test', 'Exam', 'Attempt'). They are directory
placeholders — MATLAB Drive does not sync empty folders. Deleting them drops the three
cluster directories. Documented at
docs/04-simulations/matlab-live-scripts.md.
Not in this folder: recruitment notes
Interview Questions-20260725174912.md contains interview notes on named candidates —
ages, nationalities, course loads, and hiring assessments. It is excluded from version
control entirely via .gitignore rather than committed here, because parking personal data
in superseded/ still publishes it.
The file remains on local disk. The generic question template — the same document without the
candidate notes — is committed at
docs/07-team-and-operations/interview-questions.md.
Restoring something
git mv superseded/<file> <destination>
Everything here is in git history; nothing has been deleted.