docs: optimize RawDataReader usage guide

README.md

@@ -1,3 +1,5 @@
+from openpyxl.styles.builtins import output
+
 ## <div align="center">AeroViz for Aerosol Science Visualization</div>
 
 <div align="center">
@@ -60,10 +62,24 @@ from pathlib import Path
 from AeroViz import RawDataReader, DataProcess, plot
 
 # Read data from a supported instrument
-data = RawDataReader('NEPH', Path('/path/to/data'), start=datetime(2024, 2, 1), end=datetime(2024, 4, 30))
+data = RawDataReader(
+    'NEPH',
+    Path('/path/to/data'),
+    start=datetime(2024, 2, 1),
+    end=datetime(2024, 4, 30)
+)
+```
 
-# Create a visualization
-plot.timeseries(data, y='scattering_coefficient')
+```pycon
+> Concole output
+╔════════════════════════════════════════════════════════════════════════════════╗
+║     Reading NEPH RAW DATA from 2024-02-01 00:00:00 to 2024-04-30 23:59:59      ║
+╚════════════════════════════════════════════════════════════════════════════════╝
+▶ Reading NEPH files ━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00 file_name.dat
+		▶ Scatter Coe. (550 nm)
+			├─ Sample Rate    :   100.0%
+			├─ Valid  Rate    :   100.0%
+			└─ Total  Rate    :   100.0%
 ```
 
 For more detailed usage instructions, please refer to our [User Guide](docs/guide).
@@ -82,12 +98,3 @@ For detailed documentation, please refer to the `docs` folder, which includes:
 
 ## <div align="center">Contact</div>
 For bug reports and feature requests please visit [GitHub Issues](https://github.com/Alex870521/DataPlot/issues).
-
-<div align="center">
-
-<a href="https://github.com/Alex870521"><img src="https://github.com/Alex870521/AeroViz/blob/main/assets/media/logo-social-github.png?raw=true" width="3%" alt="Alex870521 GitHub"></a>
-<img src="https://github.com/Alex870521/AeroViz/blob/main/assets/media/logo-transparent.png?raw=true" width="3%">
-<a href="https://www.linkedin.com/in/Alex870521/"><img src="https://github.com/Alex870521/AeroViz/blob/main/assets/media/logo-social-linkedin.png?raw=true" width="3%" alt="Alex870521 LinkedIn"></a>
-<img src="https://github.com/Alex870521/AeroViz/blob/main/assets/media/logo-transparent.png?raw=true" width="3%">
-<a href="https://medium.com/@alex870521"><img src="https://github.com/Alex870521/AeroViz/blob/main/assets/media/logo-social-medium.png?raw=true" width="3%" alt="Alex870521 Medium"></a>
-</div>

docs/api/RawDataReader.md

@@ -61,15 +61,18 @@ def RawDataReader(
 ```python
 from pathlib import Path
 from datetime import datetime
+from AeroViz import RawDataReader
 
 data = RawDataReader(
-    instrument_name='BC1054',
+    instrument_name='AE33',
     path=Path('/path/to/data'),
     start=datetime(2024, 2, 1),
-    end=datetime(2024, 7, 31, 23)
+    end=datetime(2024, 8, 31, 23)
 )
 ```
 
+[]()
+
 ## AbstractReader Class
 
 ### Overview

docs/example/RawDataReader.py

@@ -0,0 +1,47 @@
+"""
+AeroViz Example Usage Guide
+==========================
+
+This script demonstrates basic usage of RawDataReader class with AE33 data.
+Author: Chan Chih Yu
+GitHub: https://github.com/Alex870521/AeroViz
+"""
+
+from datetime import datetime
+from pathlib import Path
+
+from AeroViz import RawDataReader
+
+# Set data path and time range
+data_path = Path('/path/to/your/data')
+start_time = datetime(2024, 2, 1)
+end_time = datetime(2024, 3, 31, 23, 59, 59)
+
+# Read and process AE33 data
+ae33_data = RawDataReader(
+    instrument_name='AE33',
+    path=data_path / 'AE33',
+    reset=True,
+    qc=True,
+    qc_freq='1MS',  # print qc each month
+    rate=True,
+    start=start_time,
+    end=end_time,
+    mean_freq='1h',
+    csv_out=True
+)
+
+# Show processed data
+print("\nProcessed AE33 data:")
+print(ae33_data.head())
+
+print("""
+After processing, six files will be generated in the data directory:
+
+1. _read_AE33_raw.csv: Raw merged data (original 1-min resolution)
+2. _read_AE33_raw.pkl: Raw data in pickle format
+3. _read_AE33.csv: QC processed data (original 1-min resolution)
+4. _read_AE33.pkl: QC data in pickle format
+5. Output_AE33: Final processed data (user-defined resolution)
+6. AE33.log: Processing log file
+""")