From 12393197d29984287e08b803e2e204c381cd3260 Mon Sep 17 00:00:00 2001 From: Chih-Yu Chan Date: Thu, 7 Nov 2024 05:59:37 +0800 Subject: [PATCH] release: v0.1.10 --- .github/workflows/publish.yml | 2 +- README.md | 22 ++++++++++------------ docs/CHANGELOG.md | 12 ++++++++++++ docs/changelog.md | 0 docs/guide/RawDataReader.md | 1 - pyproject.toml | 12 +++++++++++- 6 files changed, 34 insertions(+), 15 deletions(-) create mode 100644 docs/CHANGELOG.md delete mode 100644 docs/changelog.md diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 5762324..99602c0 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -15,7 +15,7 @@ jobs: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} cache: 'pip' diff --git a/README.md b/README.md index a87b0ed..2486ae5 100644 --- a/README.md +++ b/README.md @@ -25,30 +25,27 @@ pip install AeroViz ##
Key Features
-### 📊 Data Reading ▶ `RawDataReader` - -Built-in RawDataReader supporting multiple aerosol instruments: +### 📊 Data Reading ▶ RawDataReader +Built-in `RawDataReader` supporting multiple aerosol instruments: - **Particle Sizers**: SMPS, APS, GRIMM, OPC - **Mass & Optical**: TEOM, NEPH, Aurora, AE33/43, BC1054 - **Chemical Analysis**: OCEC, IGAC, XRF, VOC > 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` +> and usage, check our [RawDataReader Guide](docs/guide/RawDataReader.md). -Advanced aerosol analysis: +### 🔬 Data Processing ▶ DataProcess +Built-in `DataProcess` provides advanced aerosol analysis: - **Size Distribution**: Mode Fitting, Log-Normal Analysis - **Optical Properties**: Mie Theory, SOAP Calculation - **Chemical**: Mass Closure, Source Apportionment - **VOC**: OFP, SOAP -### 📈 Data Visualization ▶ `plot` - -Comprehensive visualization tools: +### 📈 Data Visualization ▶ plot +Comprehensive visualization tools `plot`: - **Time Analysis**: Trends, Diurnal Patterns - **Statistical**: Distributions, Correlations - **Specialized**: Size Contours, Wind Rose, Polar Plots, Hysplit, CBPF @@ -68,7 +65,8 @@ 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](). + +For more detailed usage instructions, please refer to our [User Guide](docs/guide). ##
Documentation
@@ -79,7 +77,7 @@ For detailed documentation, please refer to the `docs` folder, which includes: | Documentation | Description | |--------------------------------|--------------------------| | [User Guide](docs/guide) | Basic usage instructions | -| [Changelog](docs/changelog.md) | List of changes | +| [Changelog](docs/CHANGELOG.md) | List of changes | ##
Contact
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 0000000..a225887 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,12 @@ +## v0.1.9.6 (2024-11-07) + +### Fix + +- set SMPS default size range (11.8, 593.5) + +### Refactor + +- **logger**: enhance progress bar visualization and formatting +- minor syntax improvements + +## v0.1.9.5 (2024-10-24) diff --git a/docs/changelog.md b/docs/changelog.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/guide/RawDataReader.md b/docs/guide/RawDataReader.md index b739727..ec5d393 100644 --- a/docs/guide/RawDataReader.md +++ b/docs/guide/RawDataReader.md @@ -140,7 +140,6 @@ This will display the first few rows of the processed data, including timestamps - `csv_out`: If True, output processed data as CSV # Supported Instruments: Default Time Resolutions and File Types - ### The AeroViz project currently supports data from the following instruments: | Instrument | Time Resolution | File Type | Display Columns | QAQC method | diff --git a/pyproject.toml b/pyproject.toml index a7011b0..a6e126b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "AeroViz" -version = "0.1.9.6" +version = "0.1.10" description = "Aerosol science" authors = [{ name = "alex", email = "alex870521@gmail.com" }] license = { text = "MIT" } @@ -56,6 +56,16 @@ markers = [ "requires_data: marks tests that require actual data files", ] + +[tool.commitizen] +name = "cz_conventional_commits" +tag_format = "v$version" +changelog_file = "docs/CHANGELOG.md" +version_scheme = "pep440" +version_provider = "pep621" +update_changelog_on_bump = true +major_version_zero = true + [project.urls] Homepage = "https://github.com/Alex870521/AeroViz" Repository = "https://github.com/Alex870521/AeroViz"