Upload README.md with huggingface_hub

README.md

@@ -1,140 +1,230 @@
 # Optimize Prime Dataset
 
-## ⚠️ Important Attribution
+## # Optimise Prime Dataset Mirror
 
-This is a mirror of the publicly released **Optimise Prime dataset** from UK Power Networks.
+> Independent mirror of the public **Optimise Prime** release from **UK Power Networks**.
 
-**Source:** UK Power Networks, *Project Optimise Prime - Commercial Electric Vehicles Trial*  
-**Original Dataset:** https://ukpowernetworks.opendatasoft.com/explore/dataset/ukpn-optimise-prime/  
-**License:** CC BY 4.0 (Creative Commons Attribution 4.0 International)  
-**Last Updated:** October 2022 (as stated in original source metadata)  
-**Attribution Required:** Yes - as per CC BY 4.0 terms
+## Important Attribution
 
-This mirror does not include any proprietary access credentials or SAS tokens. All data is from the public release only.
+This repository mirrors the **publicly released Optimise Prime dataset** only.
 
-**Disclaimer:** This is an independent mirror. UK Power Networks does not endorse this repository.
+**Original source:** UK Power Networks, *Project Optimise Prime - Commercial Electric Vehicles Trial*  
+**Original dataset page:** `https://ukpowernetworks.opendatasoft.com/explore/dataset/ukpn-optimise-prime/`  
+**License:** CC BY 4.0  
+**Attribution required:** Yes  
+**Mirror type:** Public-release mirror
 
-## Description
+This mirror does **not** include proprietary credentials, private companion files, or SAS tokens.
 
-The UKPN Optimise Prime dataset contains smart grid and energy consumption data from commercial electric vehicle trials conducted by UK Power Networks. This public dataset was released under CC BY 4.0 to support research and innovation in smart grid and EV charging infrastructure.
+> **Disclaimer**  
+> This is an independent mirror for research and data access convenience.  
+> It is **not** an official UK Power Networks repository, and UK Power Networks does not endorse this mirror.
 
-## Dataset Structure
+---
 
-The dataset is organized by **Workstreams (WS)**, each containing multiple tables with temporal measurements:
+## Overview
 
-### Workstreams
+This dataset comes from **Optimise Prime**, a major UK trial focused on the impact of commercial EVs on distribution networks.
 
-- **WS1**: Smart meter data, fleet charging sessions, and EV trip data
-  - Table 06: bg-fleet-charging (charging session data)
-  - Table 07: bg-trips (vehicle trip data)
-  - Additional tables with smart meter readings
+The public release is organized into three workstreams:
 
-- **WS2**: Network topology and infrastructure data
-- **WS3**: Network operations and monitoring data
+- **WS1** — home charging / return-to-home fleet trial
+- **WS2** — depot charging trial
+- **WS3** — mixed / PHV network-impact modelling
 
-Each workstream contains subdirectories organized by table, with CSV files typically split by month or time period.
+For most grid, charging, and smart-control research, **WS2 is the core part**.  
+It contains the depot-side ecosystem: depots, charge points, EV and EV type records, building-load data, telematics, charger / iHost measurements, and smart-charging or flexibility configuration tables.
 
-## Dataset Statistics
+This mirror is meant to make the public release easier to access, browse, and use in research workflows.
 
-- **Total files in this mirror:** 1013
-- **Total size:** 156331.11 MB (152.67 GB)
-- **Successfully downloaded:** 1012
-- **Failed downloads:** 1
-- **Download limit:** 60 GB (partial mirror)
+---
+
+## What This Mirror Contains
+
+This repository contains the **public Optimise Prime release only**.
+
+It includes large CSV collections organized by workstream and table, usually split by **month** or **day** depending on data volume.
+
+The mirror covers data such as:
+
+- depot asset records
+- charge point and charge point type records
+- EV and EV type records
+- charging and telematics data
+- building load data
+- charger / iHost measurements
+- profiled connection data
+- flexibility planning and dispatch data
+- summary and derived public tables released with the project
+
+It does **not** include confidential, personally identifiable, or third-party licensed data that were excluded from the original public publication.
+
+---
+
+## Mirror Statistics
+
+- **Total files:** 1,014
+- **Approximate total size:** 156,923.39 MB
+- **Approximate size in GB:** 156.92 GB
+- **Workstreams included:** WS1, WS2, WS3
+
+> **Note**  
+> Some hosting platforms may show a different total repository size because of chunking, storage accounting, cached revisions, or backend compression.
+
+---
+
+## Recommended Starting Point
+
+If you are new to the dataset, start with these WS2 tables first:
+
+- **Table 10 — depots**
+- **Table 12 — chargepoints**
+- **Table 14 — evehicles**
+- **Table 19 — building-load-measures**
+- **Table 21 / 22 — nortech-ihost-measurements**
+- **Table 23 — profiled-connections**
+- **Table 25 — planned-flexibility-events**
+- **Table 26 — flexibility-dispatches**
+- **Table 27 — depot load data table**
+- **Table 32 — load profile data table**
+
+That gives the cleanest entry point into the depot-side EV + site load + smart-charging part of the release.
+
+---
+
+## Repository Structure
+
+```text
+optimise-prime/
+├── WS1/
+│   ├── Table 06 – bg-fleet-charging/
+│   ├── Table 07 – bg-trips/
+│   └── Table 08 – aggregated shift telematics data/
+├── WS2/
+│   ├── Table 10 – depots/
+│   ├── Table 11 – cptypes/
+│   ├── Table 12 – chargepoints/
+│   ├── Table 13 – evtypes/
+│   ├── Table 14 – evehicles/
+│   ├── Table 15 – brand-a-*/
+│   ├── Table 16 – brand-b-measures/
+│   ├── Table 17 – brand-b-measures/
+│   ├── Table 18 – brand-c-ev/
+│   ├── Table 19 – building-load-measures/
+│   ├── Table 20 – building-catalog/
+│   ├── Table 21 – nortech-ihost-measurements/
+│   ├── Table 22 – nortech-ihost-measurements/
+│   ├── Table 23 – profiled-connections/
+│   ├── Table 24 – time-of-use-throttling/
+│   ├── Table 25 – planned-flexibility-events/
+│   ├── Table 26 – flexibility-dispatches/
+│   ├── Table 27 – depot load data table/
+│   ├── Table 28 – EV details by site/
+│   ├── Table 29 – CP count/
+│   ├── Table 30 – enacted flexibility product A/
+│   ├── Table 31 – enacted flexibility product B/
+│   └── Table 32 – load profile data table/
+└── WS3/
+    └── Table 33 – network_impact_by_borough/
+```
+
+---
 
 ## Usage
 
-### Loading with Hugging Face Datasets
+### Load with Hugging Face Datasets
 
 ```python
 from datasets import load_dataset
 
-# Load the dataset
-dataset = load_dataset('AIsekai/OptimizePrime')
+dataset = load_dataset("<your-hf-repo-id>")
 ```
 
-### Loading CSV files directly
+### Load files directly with pandas
 
 ```python
 import pandas as pd
 
-# Example: Load fleet charging data
-df = pd.read_csv('WS1/Table 06 – bg-fleet-charging/bg_fleet_charging_202106.csv')
+df = pd.read_csv("WS2/Table 10 – depots/depots_202111.csv")
 ```
 
-## File Organization
+### Practical Note
 
-```
-optimiseprime_data/
-├── WS1/
-│   ├── Table 06 – bg-fleet-charging/
-│   │   ├── bg_fleet_charging_202012.csv
-│   │   ├── bg_fleet_charging_202106.csv
-│   │   └── ...
-│   ├── Table 07 – bg-trips/
-│   │   ├── bg_trips_201808.csv
-│   │   └── ...
-│   └── [Additional tables...]
-├── WS2/
-├── WS3/
-├── METADATA.json
-└── README.md
-```
+Some tables are very large. For serious work, use tools such as:
+
+- pandas / polars
+- DuckDB
+- PyArrow
+- Dask / Spark
+- SQL-based ingestion pipelines
 
-## Data Fields
+Do **not** expect the full release to open comfortably in Excel.
 
-Typical fields vary by table, but commonly include:
-- Temporal data (timestamps, dates)
-- Location identifiers
-- Energy consumption metrics
-- Charging session details
-- Trip information for EVs
+---
 
-See individual CSV files for complete field definitions.
+## What This Dataset Is Good For
 
-## License & Terms
+This dataset is especially useful for:
 
-**License:** Creative Commons Attribution 4.0 International (CC BY 4.0)
+- commercial EV charging research
+- depot smart charging
+- flexibility and profiled-connection studies
+- EV fleet load modelling
+- building-load and EV-load interaction
+- UK distribution-network impact studies
+- forecasting, optimisation, and control workflows
 
-**Attribution Requirements:**
-When using this dataset, you must provide attribution as follows:
+---
 
-> Source: UK Power Networks, Project Optimise Prime - Commercial Electric Vehicles Trial  
-> Dataset URL: https://ukpowernetworks.opendatasoft.com/explore/dataset/ukpn-optimise-prime/  
-> License: CC BY 4.0  
-> Mirrored from public release, October 2022
+## Limitations
 
-**You are free to:**
-- Share — copy and redistribute the material
-- Adapt — remix, transform, and build upon the material
+This mirror reflects the **public release only**.
 
-**Under the following terms:**
-- Attribution — You must give appropriate credit and indicate if changes were made
-- No additional restrictions
+That means some information used in the original project is **not included** here, especially where data was:
 
-**Full License:** https://creativecommons.org/licenses/by/4.0/
+- commercially confidential
+- potentially personally identifiable
+- licensed from third parties
 
-## Mirror Information
+So this repository is strong for research, but it is not the full private internal project dataset.
 
-- **Mirrored:** 2026-03-25T05:02:18.772957
-- **Mirror source:** Azure Blob Storage public endpoint
-- **This mirror contains:** First 60 GB of the public dataset
-- **Note:** This is a partial mirror. Full dataset available at original source.
+---
+
+## License
+
+**License:** CC BY 4.0  
+**License URL:** `https://creativecommons.org/licenses/by/4.0/`
+
+You may share and adapt the material, provided that proper attribution is given.
+
+### Required Attribution
+
+Please attribute the original source as:
+
+> UK Power Networks, *Project Optimise Prime - Commercial Electric Vehicles Trial*  
+> Original dataset page: `https://ukpowernetworks.opendatasoft.com/explore/dataset/ukpn-optimise-prime/`  
+> License: CC BY 4.0
+
+If you use this mirror in research, papers, reports, or derivative datasets, please also mention that this repository is an **independent mirror of the public release**.
+
+---
 
 ## Citation
 
-If you use this dataset in research, please cite:
+Suggested citation:
 
+```text
+UK Power Networks. Project Optimise Prime - Commercial Electric Vehicles Trial.
+Public dataset release via UK Power Networks Open Data Portal.
+License: CC BY 4.0.
+Mirrored in this repository from the public release.
 ```
-UK Power Networks (2022). Project Optimise Prime - Commercial Electric Vehicles Trial.
-Available at: https://ukpowernetworks.opendatasoft.com/explore/dataset/ukpn-optimise-prime/
-License: CC BY 4.0
-```
 
-## Contact & Questions
+---
+
+## Contact
 
-For questions about the **original dataset**, contact UK Power Networks via their data portal.
+For questions about the **original dataset**, use the UK Power Networks Open Data Portal and its listed contact route.
 
-For questions about **this mirror**, please open an issue on this repository.
+For issues with **this mirror** such as missing files, path errors, or repository organization, please open an issue in this repository.
 
-**Important:** Do not use the UK Power Networks logo. This mirror is not endorsed by UKPN.