docs: update

Alex870521 · Nov 6, 2024 · e7ca34a · e7ca34a
1 parent 8dea894
commit e7ca34a
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 93 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
 ## <div align="center">AeroViz for Aerosol Science Visualization</div>
 
-<p align="center">
+<div align="center">
 
-  <img alt="Static Badge" src="https://img.shields.io/badge/python-3.12-blue?logo=python">
-  <img alt="Static Badge" src="https://img.shields.io/badge/License-MIT-yellow">
-  <img alt="Static Badge" src="https://img.shields.io/badge/github-updating-red?logo=github">
-  <img alt="Static Badge" src="https://img.shields.io/badge/testing-green?logo=Pytest&logoColor=blue">
+![Python](https://img.shields.io/pypi/pyversions/aeroviz?logo=python)
+![PyPI](https://img.shields.io/pypi/v/aeroviz?logo=pypi)
+![Pytest](https://img.shields.io/github/actions/workflow/status/Alex870521/aeroviz/pytest.yml?logo=pytest&label=pytest)
+![GitHub last commit](https://img.shields.io/github/last-commit/Alex870521/aeroviz?logo=github)
 
-</p>
+</div>
 
 <div align="center">
 
@@ -16,26 +16,44 @@
 <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>
 
+## <div align="center">Installation</div>
+```bash
+pip install AeroViz
+```
+
 ## <div align="center">Key Features</div>
 
-* Data Reading: Supports reading multiple aerosol data formats.
-* Data Visualization: Offers various charts and graphs, including time series plots, distribution plots, and correlation
-  matrices.
-* Data Processing: Includes multiple data processing tools, such as linear regression and Mie theory calculations.
+### 📊 Data Reading ▶ `RawDataReader`
 
+Built-in RawDataReader supporting multiple aerosol instruments:
 
-## <div align="center">Installation</div>
+- **Particle Sizers**: SMPS, APS, GRIMM, OPC
+- **Mass & Optical**: TEOM, NEPH, Aurora, AE33/43, BC1054
+- **Chemical Analysis**: OCEC, IGAC, XRF, VOC
 
-```bash
-pip install AeroViz
-```
+> Features include quality control, data filtering, flexible resampling, and CSV export. For detailed instrument support
+> and usage, check our [RawDataReader Guide](docs/guide/RawDataReader).
+
+### 🔬 Data Processing ▶ `DataProcess`
+
+Advanced aerosol analysis:
 
-For Windows users: Run `install_windows.bat`
+- **Size Distribution**: Mode Fitting, Log-Normal Analysis
+- **Optical Properties**: Mie Theory, SOAP Calculation
+- **Chemical**: Mass Closure, Source Apportionment
+- **VOC**: OFP, SOAP
 
-For Linux and Mac users: Run `install_unix.bat`
+### 📈 Data Visualization ▶ `plot`
+
+Comprehensive visualization tools:
+
+- **Time Analysis**: Trends, Diurnal Patterns
+- **Statistical**: Distributions, Correlations
+- **Specialized**: Size Contours, Wind Rose, Polar Plots, Hysplit, CBPF
+
+> **Note:** We are continuously adding support for more instruments and features. Contributions are welcome!
 
 ## <div align="center">Quick Start</div>
 
@@ -50,57 +68,10 @@ data = RawDataReader('NEPH', Path('/path/to/data'), start=datetime(2024, 2, 1),
 # Create a visualization
 plot.timeseries(data, y='scattering_coefficient')
 ```
-
 For more detailed usage instructions, please refer to our [User Guide]().
 
-## <div align="center"> RawDataReader
-
-RawDataReader supports a wide range of aerosol instruments, including NEPH, SMPS, AE33, and many more. It handles
-various file types and time resolutions, making data processing efficient and standardized.
-
-For a detailed list of supported instruments, file types, and data columns, please refer to
-our [RawDataReader Usage Guide](docs/guide/RawDataReader) in the `docs` folder.
-
-### Key Features:
-
-- Supports multiple aerosol instruments
-- Applies customizable quality control measures
-- Offers flexible data filtering and resampling options
-- Enables easy data export to CSV format
-
-### Supported Instruments
-
-The AeroViz project currently supports data from the following instruments:
-
-- SMPS (Scanning Mobility Particle Sizer)
-- APS (Aerodynamic Particle Sizer)
-- GRIMM (GRIMM Aerosol Technik)
-- TEOM (Continuous Ambient Particulate Monitor)
-- NEPH (Nephelometer)
-- Aurora (Nephelometer)
-- AE33 (Aethalometer Model 33)
-- AE43 (Aethalometer Model 43)
-- BC1054 (Black Carbon Monitor 1054)
-- MA350 (MicroAeth MA350)
-- OCEC (Organic Carbon Elemental Carbon Analyzer)
-- IGAC (In-situ Gas and Aerosol Compositions monitor)
-- XRF (X-ray Fluorescence Spectrometer)
-- VOC (Volatile Organic Compounds Monitor)
-
-> **Note:** We are continuously working to support more instruments. Please check back for updates or contribute to our
-> project on GitHub.
-
-## <div align="center">DataProcess</div>
-
-The AeroViz project currently supports the following processing methods:
-
-- **Chemistry**:
-- **Optical**
-- **SizeDistr**
-- **VOC**
 
 ## <div align="center">Documentation</div>
-
 For detailed documentation, please refer to the `docs` folder, which includes:
 
 <div align="center">
@@ -109,17 +80,9 @@ For detailed documentation, please refer to the `docs` folder, which includes:
 |--------------------------------|--------------------------|
 | [User Guide](docs/guide)       | Basic usage instructions |
 | [Changelog](docs/changelog.md) | List of changes          |
-
 </div>
 
-## <div align="center">Related Source</div>
-
-* #### [PyMieScatt](https://github.com/bsumlin/PyMieScatt.git)
-* #### [py-smps](https://github.com/quant-aq/py-smps.git)
-* #### [ContainerHandle](https://github.com/yrr-Su/ContainerHandle.git)
-
 ## <div align="center">Contact</div>
-
 For bug reports and feature requests please visit [GitHub Issues](https://github.com/Alex870521/DataPlot/issues).
 
 <div align="center">
@@ -129,6 +92,4 @@ For bug reports and feature requests please visit [GitHub Issues](https://github
 <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>
diff --git a/docs/guide/RawDataReader.md b/docs/guide/RawDataReader.md
@@ -141,24 +141,26 @@ This will display the first few rows of the processed data, including timestamps
 
 # Supported Instruments: Default Time Resolutions and File Types
 
-| Instrument | Time Resolution | File Type   | Display Columns                                       | QAQC method |
-|:----------:|:---------------:|:------------|-------------------------------------------------------|:-----------:|
-|    NEPH    |      5min       | .dat        | G                                                     |   default   |
-|   Aurora   |      1min       | .csv        | G                                                     |   default   |
-|    SMPS    |      6min       | .txt, .csv  | all                                                   |   default   |
-|   GRIMM    |      6min       | .dat        | all                                                   |   default   |
-|  APS_3321  |      6min       | .txt        | all                                                   |   default   |
-|    AE33    |      1min       | .dat        | BC6                                                   |   default   |
-|    AE43    |      1min       | .dat        | BC6                                                   |   default   |
-|   BC1054   |      1min       | .csv        | BC9                                                   |   default   |
-|   MA350    |      1min       | .csv        | BC5                                                   |   default   |
-|    TEOM    |      6min       | .csv        | PM_Total, PM_NV                                       |   default   |
-|    OCEC    |       1h        | *LCRes.csv  | Thermal_OC, Thermal_EC, Optical_OC, Optical_EC        |   default   |
-|    IGAC    |       1h        | .csv        | Na+, NH4+, K+, Mg2+, Ca2+, Cl-, NO2-, NO3-, SO42-     |   default   |
-|    XRF     |       1h        | .csv        | Al, Si, P, S, Cl, K, Ca, Ti, V, Cr, Mn, Fe, Ni, Cu... |   default   |
-|    VOC     |       1h        | .csv        | voc                                                   |   default   |
-|    EPA     |       1h        | .csv        | all                                                   |   default   |
-|   Minion   |       1h        | .csv, .xlsx | Na+, NH4+, Cl-, NO3-, SO42-, Al, Ti, V, Cr, Mn, Fe    |   default   |
+### The AeroViz project currently supports data from the following instruments:
+
+|                       Instrument                       | Time Resolution | File Type   | Display Columns                                       | QAQC method |
+|:------------------------------------------------------:|:---------------:|:------------|-------------------------------------------------------|:-----------:|
+|                  NEPH (Nephelometer)                   |      5min       | .dat        | G                                                     |   default   |
+|                 Aurora (Nephelometer)                  |      1min       | .csv        | G                                                     |   default   |
+|        SMPS (Scanning Mobility Particle Sizer)         |      6min       | .txt, .csv  | all                                                   |   default   |
+|             GRIMM (GRIMM Aerosol Technik)              |      6min       | .dat        | all                                                   |   default   |
+|         APS_3321 (Aerodynamic Particle Sizer)          |      6min       | .txt        | all                                                   |   default   |
+|              AE33 (Aethalometer Model 33)              |      1min       | .dat        | BC6                                                   |   default   |
+|              AE43 (Aethalometer Model 43)              |      1min       | .dat        | BC6                                                   |   default   |
+|           BC1054 (Black Carbon Monitor 1054)           |      1min       | .csv        | BC9                                                   |   default   |
+|                MA350 (MicroAeth MA350)                 |      1min       | .csv        | BC5                                                   |   default   |
+|     TEOM (Continuous Ambient Particulate Monitor)      |      6min       | .csv        | PM_Total, PM_NV                                       |   default   |
+| OCEC (Sunset Organic Carbon Elemental Carbon Analyzer) |       1h        | *LCRes.csv  | Thermal_OC, Thermal_EC, Optical_OC, Optical_EC        |   default   |
+|  IGAC (In-situ Gas and Aerosol Compositions monitor)   |       1h        | .csv        | Na+, NH4+, K+, Mg2+, Ca2+, Cl-, NO2-, NO3-, SO42-     |   default   |
+|         XRF (X-ray Fluorescence Spectrometer)          |       1h        | .csv        | Al, Si, P, S, Cl, K, Ca, Ti, V, Cr, Mn, Fe, Ni, Cu... |   default   |
+|        VOC (Volatile Organic Compounds Monitor)        |       1h        | .csv        | voc                                                   |   default   |
+|                          EPA                           |       1h        | .csv        | all                                                   |   default   |
+|                         Minion                         |       1h        | .csv, .xlsx | Na+, NH4+, Cl-, NO3-, SO42-, Al, Ti, V, Cr, Mn, Fe    |   default   |
 
 ```{note}
 Notes:

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "AeroViz"
-version = "0.1.9.5"
+version = "0.1.9.6"
 description = "Aerosol science"
 authors = [{ name = "alex", email = "[email protected]" }]
 license = { text = "MIT" }