Skip to content

Commit ba44d31

Browse files
committed
ui:assesement pages UI refactor and cleanup
1 parent c8b8948 commit ba44d31

9 files changed

Lines changed: 364 additions & 329 deletions

File tree

‎web/content/assessments/invest.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "PyPSA-Eur Assessment"
3+
project_name: "PyPSA-Eur"
4+
project_url: "https://github.com/pypsa/pypsa-eur"
5+
report_path: "https://raw.githubusercontent.com/protontypes/open-traceability-assessment/refs/heads/main/reports/20260612-130828_pypsa-eur_open_traceability_assessment/pypsa-eur_open_traceability_assessment.runs.json"
6+
report_source: "https://github.com/protontypes/open-traceability-assessment/tree/main/reports/20260612-130828_pypsa-eur_open_traceability_assessment"
7+
summary: "An open sector-coupled optimisation model of the European energy system."
8+
---

‎web/data/assessment_ui.yaml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
hero:
2+
eyebrow: "Evidence Chain Assessment"
3+
claim_header: "Assessed Claim"
4+
score_label: "Traceability Score"
5+
meta:
6+
project_source: "Project Source"
7+
framework_version: "Framework Version"
8+
assessment_date: "Assessment Date"
9+
human_review: "Human Review"
10+
confirmed: "Confirmed"
11+
pending: "Pending"
12+
13+
pathway:
14+
title: "Claim Traceability Pathway"
15+
description: "Inspection trail mapping the connections from raw inputs to the published claim."
16+
legend:
17+
strong: "Strong inspectability (≥80)"
18+
moderate: "Moderate inspectability (55-79)"
19+
weak: "Weak inspectability (<55)"
20+
linkage: "Open Linkage Connection"
21+
22+
health_summary:
23+
title: "Traceability Health Summary"
24+
description: "Scan diagnosis of where the evidence chain stands and what requires attention first."
25+
strongest:
26+
kicker: "Strongest Area"
27+
description: "This stage provides solid evidence, making calculations and documentation highly inspectable and reusable for external actors."
28+
weakest:
29+
kicker: "Traceability Gap"
30+
description: "This is the weakest segment of the evidence chain. Gaps in records or lack of linkage break the evidence chain here."
31+
missing:
32+
kicker: "Missing Artifacts"
33+
priority_action:
34+
kicker: "First Priority Action"
35+
title_prefix: "Strengthen"
36+
37+
linkage:
38+
title: "Evidence Linkage Summary"
39+
description: "Open Linkage is not a standalone category; it is the connectivity of the evidence chain. Below is the connection status of the connection links between each step in this project's journey."
40+
badge: "Framework Metric"
41+
status:
42+
connected: "Connected"
43+
partially_connected: "Partially Connected"
44+
disconnected: "Disconnected"
45+
46+
detailed_inspection:
47+
title: "Detailed Dimension Inspection"
48+
description: "Granular findings for each processing step in the Open Traceability framework."
49+
evidence_found: "Evidence Found"
50+
gaps_identified: "Gaps Identified"
51+
no_gaps: "No significant gaps identified. This stage is fully documented and verifiable."
52+
why_matters_label: "Why this matters for Traceability:"
53+
next_step_label: "Recommended next step:"
54+
artifacts_title: "Inspectable Evidence Artifacts"
55+
relevance_label: "Relevance:"
56+
57+
gaps:
58+
title: "Critical Traceability Gaps"
59+
description: "Inspection details of where the evidence chain breaks down and what that implies for public trust."
60+
table:
61+
gap: "Identified Gap"
62+
impact: "Impact on Traceability"
63+
remediation: "Suggested Remediation"
64+
65+
roadmap:
66+
title: "Remediation & Improvements Roadmap"
67+
description: "Actionable roadmap prioritized by implementation complexity."
68+
69+
methodology:
70+
disclaimer_title: "Disclaimer & Assessment Methodology"
71+
disclaimer_text: "This score was produced via LLM-assisted assessment of the repository structure and the supplied evidence bundle. These findings should be treated as a directional pilot signal rather than a verified rating. For more details on our pilot objectives and the development path toward rules-based human review, see the <a href=\"/#roadmap\" class=\"inline-link-inline\">Development Roadmap</a>."
72+
definitions_title: "Framework Dimension Definitions"
73+
review_notes_title: "Human Review Notes"
74+
review_notes_approved: "Independent human review of this assessment is complete and findings are confirmed."
75+
review_notes_pending: "Human review of this assessment report is pending. An independent reviewer must inspect the repository references to verify the findings."
76+
77+
pending:
78+
eyebrow: "Assessment Pending Review"
79+
source_repo: "Project Source Repository"
80+
claim_header: "Assessed Claim"
81+
signals_title: "Self-Reported Evidence Signals"
82+
in_progress_text: "The quantitative inspectability assessment for this project is currently in progress. The full evidence-chain tracing interface will be generated automatically once the report credentials are compiled."

‎web/data/exemplars.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
title: "Exemplars"
22
subtitle: "Concrete examples of strong traceability in practice."
33
items:
4-
- title: "PyPSA"
4+
- title: "PyPSA-Earth"
55
category: "Energy System Optimisation"
66
description: "A global benchmark for transparent power-sector planning with open-source models and data workflows."
77
url: "/assessments/pypsa-earth"
8+
- title: "PyPSA-Eur"
9+
category: "Energy System Optimisation"
10+
description: "An open sector-coupled optimisation model of the European energy system."
11+
url: "/assessments/pypsa-eur"
812
- title: "Global Forest Watch"
913
category: "Forest Monitoring"
1014
description: "Real-time monitoring of tree-cover loss powered by open APIs and verifiable satellite data layers."
1115
url: "/assessments/global-forest-watch"
12-
- title: "InVest"
13-
category: "Ecosystem Services"
14-
description: "Standardized models for mapping and valuing nature's benefits, with explicit input-to-output linkage."
15-
url: "/assessments/invest"
1616

‎web/data/linkage_checks.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
checks:
2+
- id: 1
3+
title: "Input Data to Models & Software Connection"
4+
question: "Are data input paths and schemas programmatically defined inside the code files or configurations?"
5+
source_stage_index: 0
6+
target_stage_index: 1
7+
- id: 2
8+
title: "Models & Software to Execution Connection"
9+
question: "Is code execution managed through versioned workflow scripts (e.g. Snakemake pipelines) rather than manual scripts?"
10+
source_stage_index: 1
11+
target_stage_index: 2
12+
- id: 3
13+
title: "Execution Run to Community & Review Connection"
14+
question: "Are execution outputs and logs tested automatically (CI/CD) and verified inside public pull request reviews?"
15+
source_stage_index: 2
16+
target_stage_index: 3
17+
- id: 4
18+
title: "Community Review to Publication Connection"
19+
question: "Are peer reviews, community issues, and discussions linked directly to published methodology reports?"
20+
source_stage_index: 3
21+
target_stage_index: 4
22+
- id: 5
23+
title: "Publication to Stated Environmental Claim Connection"
24+
question: "Does the final published paper cite the exact dataset identifiers, model hashes, and run logs that produced the results?"
25+
source_stage_index: 4
26+
target_stage_index: 5

‎web/data/remediation_roadmap.yaml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
phases:
2+
- id: "quick"
3+
badge: "Phase 1"
4+
title: "Quick Wins"
5+
subtitle: "Low effort, high immediate return."
6+
actions:
7+
- title: "Add CITATION.cff file"
8+
description: "Enables clear publication-to-repository citation schema."
9+
- title: "Commit top-level LICENSE"
10+
description: "Resolves legal terms of software and dataset inspectability."
11+
- title: "Link communication channels"
12+
description: "Add status/discord badges to repository README files."
13+
14+
- id: "medium"
15+
badge: "Phase 2"
16+
title: "Medium Effort"
17+
subtitle: "Standard engineering practices."
18+
actions:
19+
- title: "Specify configurations in config files"
20+
description: "Provide explicit parameters and dataset configurations in repository."
21+
- title: "Lock computational environments"
22+
description: "Lock dependencies using Conda-lock or Docker image digests."
23+
- title: "Archive automated workflow logs"
24+
description: "Publish CI test summaries and solver objective check values."
25+
26+
- id: "strategic"
27+
badge: "Phase 3"
28+
title: "Strategic Upgrades"
29+
subtitle: "Highest traceability return."
30+
actions:
31+
- title: "Publish workflow runs on Zenodo"
32+
description: "Create persistent, immutable archives of the full execution outputs."
33+
- title: "Build claims-to-evidence provenance graphs"
34+
description: "Establish a machine-readable map of the end-to-end evidence trail."
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
stages:
2+
- id: 1
3+
short_name: "Input Data"
4+
full_name: "Open Input Data and Measurement Evidence"
5+
definition: "Identifiable, documented, attributable, versioned raw measurement evidence inputs."
6+
why_it_matters: "Without identifiable raw input data, the foundation of the claim cannot be verified, hiding potential errors or data manipulation."
7+
recommended_next_step: "Publish data manifests on Zenodo and document quality controls."
8+
missing_artifact: "Unique dataset DOIs & licenses"
9+
priority_action: "Register raw dataset bundles with persistent repositories (e.g. Zenodo) and define licensing metadata."
10+
gap_name: "Dataset not linked or versioned"
11+
gap_impact_level: "High"
12+
gap_impact_desc: "Blocks inspection of inputs"
13+
gap_remediation: "Register raw datasets in Zenodo and cite unique DOIs in config files."
14+
gap_threshold: 75
15+
16+
- id: 2
17+
short_name: "Models & Software"
18+
full_name: "Open-Source Models, Methods, and Software"
19+
definition: "Inspectability of Analytical logic via code repositories, configurations, and license files."
20+
why_it_matters: "Without open source models and code, computations are hidden in a black box, making independent scientific review impossible."
21+
recommended_next_step: "Add an SPDX AGPLv3 header and root LICENSE file."
22+
missing_artifact: "Top-level LICENSE files"
23+
priority_action: "Add an OSI-compliant LICENSE file to the root repository and specify dependencies via lockfiles."
24+
gap_name: "Missing root license or dependencies"
25+
gap_impact_level: "Medium"
26+
gap_impact_desc: "Restricts model inspectability"
27+
gap_remediation: "Add a LICENSE file (e.g. AGPL-3.0) and export environment lockfiles."
28+
gap_threshold: 80
29+
30+
- id: 3
31+
short_name: "Execution Run"
32+
full_name: "Open Execution and Reproducibility"
33+
definition: "Computational environments, workflows, run logs, and outputs make rerun processes inspectable."
34+
why_it_matters: "Without open run configurations and execution records, we cannot verify if the software was run correctly or generated the reported results."
35+
recommended_next_step: "Export Conda lockfiles and upload workflow execution logs."
36+
missing_artifact: "Execution run configs & workflow logs"
37+
priority_action: "Configure an end-to-end Snakemake workflow and publish the full run logs linking inputs to final figures."
38+
gap_name: "Workflow run details not archived"
39+
gap_impact_level: "Critical"
40+
gap_impact_desc: "Restricts computational reproducibility"
41+
gap_remediation: "Archive Snakemake workflow runs and publish log files on Zenodo."
42+
gap_threshold: 75
43+
44+
- id: 4
45+
short_name: "Community Review"
46+
full_name: "Open Community and Review"
47+
definition: "Scrutiny, peer review, issue tracking, and responses to replication challenges are visible."
48+
why_it_matters: "Without open review channels, the process of critique, debugging, peer-review, and community scrutiny is kept completely invisible."
49+
recommended_next_step: "Create public issue boards and invite third-party replication."
50+
missing_artifact: "Scrutiny logs & replication results"
51+
priority_action: "Document PR review guidelines, set up public issue boards, and make replication logs accessible."
52+
gap_name: "Review and replication logs hidden"
53+
gap_impact_level: "Medium"
54+
gap_impact_desc: "Hides validation gate process"
55+
gap_remediation: "Maintain an open-source technical review tracker in public channels."
56+
gap_threshold: 75
57+
58+
- id: 5
59+
short_name: "Publication"
60+
full_name: "Open Publications and Communication"
61+
definition: "Resulting reports, papers, and dashboards are openly accessible and reference source materials."
62+
why_it_matters: "Without open access publications and summaries, final findings are hidden from general scrutiny and cannot be easily cited."
63+
recommended_next_step: "Publish methodologies in open journals and link to specific run IDs."
64+
missing_artifact: "Open access publications"
65+
priority_action: "Release method documents in open-access formats and link claims to exact workflow artifacts."
66+
gap_name: "Publication lacks direct evidence citation"
67+
gap_impact_level: "High"
68+
gap_impact_desc: "Claims are unlinked to runs"
69+
gap_remediation: "Add structured CITATION.cff and link claim statements to run hashes."
70+
gap_threshold: 75
71+
72+
- id: 6
73+
short_name: "Open Linkage"
74+
full_name: "Open Linkage"
75+
definition: "The versioned, explicit connectivity linking data, models, execution, review, and publication steps."
76+
why_it_matters: "Without versioned linkage records, all other steps are disconnected silos, destroying the integrity of the evidence chain."
77+
recommended_next_step: "Build a machine-readable JSON provenance record linking code to outputs."
78+
missing_artifact: "Dynamic provenance graph mapping"
79+
priority_action: "Create a versioned provenance graph mapping every step of the computation from source data to claim."
80+
gap_name: ""
81+
gap_impact_level: ""
82+
gap_impact_desc: ""
83+
gap_remediation: ""
84+
gap_threshold: 75

0 commit comments

Comments
 (0)