Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,43 @@
----
-license: mit
----
+# Battery SDU Dataset
+
+This dataset contains processed battery charge/discharge cycle data in SDU (Shandong University) format.
+
+## Dataset Structure
+
+- `processed_primary_use_phase/`: Contains 83 processed battery files from primary use phase
+- `processed_second_life_phase/`: Contains 86 processed battery files from second life phase
+
+## File Format
+
+Each file is a pickle file containing a `BatteryData` object with:
+- Cell ID in format `SDU_Battery_{ID}`
+- Cycle data with voltage, current, time, and capacity measurements
+- Battery metadata and specifications
+
+## Processing
+
+The data has been processed using the SDUPreprocessor which:
+- Calculates charge/discharge capacities from current and time data
+- Organizes cycle indices sequentially
+- Applies median filtering for outlier detection
+- Filters cycles with discharge capacity > 0.1 Ah
+- Maintains compatibility with BatteryML framework
+
+## Usage
+
+```python
+import pickle
+from pathlib import Path
+
+# Load a battery file
+with open('SDU_Battery_1.pkl', 'rb') as f:
+    battery_data = pickle.load(f)
+
+# Access cycle data
+for cycle in battery_data.cycle_data:
+    print(f"Cycle {cycle.cycle_number}: {max(cycle.discharge_capacity_in_Ah):.3f} Ah")
+```
+
+## Citation
+
+If you use this dataset, please cite the original data source and preprocessing methodology.