AeroViz 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

AeroViz/process/script/IMPACT.py

@@ -7,43 +7,43 @@ from AeroViz.tools.datareader import DataReader
 
 
 class ImpactProc(DataProc):
-	"""
-	A class for processing impact data.
-
-	Parameters:
-	-----------
-	reset : bool, optional
-		If True, resets the processing. Default is False.
-	save_filename : str or Path, optional
-		The name or path to save the processed data. Default is 'IMPACT.csv'.
-
-	Methods:
-	--------
-	process_data(reset: bool = False, save_filename: str | Path = 'IMPACT.csv') -> DataFrame:
-		Process data and save the result.
-
-	save_data(data: DataFrame, save_filename: str | Path):
-		Save processed data to a file.
-
-	Attributes:
-	-----------
-	DEFAULT_PATH : Path
-		The default path for data files.
-
-	Examples:
-	---------
-	>>> df_custom = ImpactProc().process_data(reset=True, save_filename='custom_file.csv')
-	"""
-
-	def __init__(self, file_paths: list[Path | str] = None):
-		super().__init__()
-		self.file_paths = [Path(fp) for fp in file_paths]
-
-	def process_data(self, reset: bool = False, save_file: Path | str = None) -> DataFrame:
-		save_file = Path(save_file)
-		if save_file.exists() and not reset:
-			return read_csv(save_file, parse_dates=['Time'], index_col='Time')
-		else:
-			_df = concat([DataReader(file) for file in self.file_paths], axis=1)
-			_df.to_csv(save_file)
-			return _df
+    """
+    A class for processing impact data.
+
+    Parameters:
+    -----------
+    reset : bool, optional
+        If True, resets the processing. Default is False.
+    save_filename : str or Path, optional
+        The name or path to save the processed data. Default is 'IMPACT.csv'.
+
+    Methods:
+    --------
+    process_data(reset: bool = False, save_filename: str | Path = 'IMPACT.csv') -> DataFrame:
+        Process data and save the result.
+
+    save_data(data: DataFrame, save_filename: str | Path):
+        Save processed data to a file.
+
+    Attributes:
+    -----------
+    DEFAULT_PATH : Path
+        The default path for data files.
+
+    Examples:
+    ---------
+    >>> df_custom = ImpactProc().process_data(reset=True, save_filename='custom_file.csv')
+    """
+
+    def __init__(self, file_paths: list[Path | str] = None):
+        super().__init__()
+        self.file_paths = [Path(fp) for fp in file_paths]
+
+    def process_data(self, reset: bool = False, save_file: Path | str = None) -> DataFrame:
+        save_file = Path(save_file)
+        if save_file.exists() and not reset:
+            return read_csv(save_file, parse_dates=['Time'], index_col='Time')
+        else:
+            _df = concat([DataReader(file) for file in self.file_paths], axis=1)
+            _df.to_csv(save_file)
+            return _df

AeroViz/process/script/IMPROVE.py

@@ -1,6 +1,6 @@
+from pathlib import Path
 from typing import Literal
 
-from pathlib import Path
 from pandas import read_csv, concat, read_json
 
 from AeroViz.process.core import DataProc
@@ -8,154 +8,154 @@ from AeroViz.tools.datareader import DataReader
 
 
 class ImproveProc(DataProc):
-	"""
-	A class for process improved chemical data.
-
-	Parameters:
-	-----------
-	reset : bool, optional
-		If True, resets the process. Default is False.
-	filename : str, optional
-		The name of the file to process. Default is None.
-	version : str, optional
-		The version of the data process. Should be one of 'revised' or 'modified'.
-		Default is None.
-
-	Methods:
-	--------
-	revised(_df):
-		Calculate revised version of particle contribution.
-
-	modified(_df):
-		Calculate modified version of particle contribution.
-
-	gas(_df):
-		Calculate gas contribution.
-
-	frh(_RH, version=None):
-		Helper function to get frh values based on relative humidity (RH) and version.
-
-	process_data():
-		Process data and save the result.
-
-	Attributes:
-	-----------
-	DEFAULT_PATH : Path
-		The default path for data files.
-
-	Examples:
-	---------
-	>>> df = ImproveProc(reset=True, filename='revised_IMPROVE.csv', version='revised').process_data()
-
-	"""
-
-	def __init__(self, file_paths: list[Path | str] = None):
-		super().__init__()
-		self.file_paths = [Path(fp) for fp in file_paths]
-
-	@staticmethod
-	def frh(_RH):
-		_frh = read_json(Path(__file__).parent.parent.parent / 'plot' / 'utils' / 'fRH.json')
-		if _RH is not None:
-			if _RH > 95:
-				_RH = 95
-			_RH = round(_RH)
-			return _frh.loc[_RH].values.T
-
-		return 1, 1, 1, 1
-
-	def revised(self, _df):
-		def mode(Mass):
-			L_mode = Mass ** 2 / 20 if Mass < 20 else Mass
-			S_mode = Mass - L_mode if Mass < 20 else 0
-
-			return L_mode, S_mode
-
-		_frh, _frhss, _frhs, _frhl = self.frh(_df['RH'])
-
-		L_AS, S_AS = mode(_df['AS'])
-		L_AN, S_AN = mode(_df['AN'])
-		L_OM, S_OM = mode(_df['OM'])
-
-		_df['AS_ext_dry'] = 2.2 * 1 * S_AS + 4.8 * 1 * L_AS
-		_df['AN_ext_dry'] = 2.4 * 1 * S_AN + 5.1 * 1 * L_AN
-		_df['OM_ext_dry'] = 2.8 * S_OM + 6.1 * L_OM
-		_df['Soil_ext_dry'] = 1 * _df['Soil']
-		_df['SS_ext_dry'] = 1.7 * 1 * _df['SS']
-		_df['EC_ext_dry'] = 10 * _df['EC']
-		_df['total_ext_dry'] = sum(_df['AS_ext_dry':'EC_ext_dry'])
-
-		_df['AS_ext'] = (2.2 * _frhs * S_AS) + (4.8 * _frhl * L_AS)
-		_df['AN_ext'] = (2.4 * _frhs * S_AN) + (5.1 * _frhl * L_AN)
-		_df['OM_ext'] = (2.8 * S_OM) + (6.1 * L_OM)
-		_df['Soil_ext'] = (1 * _df['Soil'])
-		_df['SS_ext'] = (1.7 * _frhss * _df['SS'])
-		_df['EC_ext'] = (10 * _df['EC'])
-		_df['total_ext'] = sum(_df['AS_ext':'EC_ext'])
-
-		_df['ALWC_AS_ext'] = _df['AS_ext'] - _df['AS_ext_dry']
-		_df['ALWC_AN_ext'] = _df['AN_ext'] - _df['AN_ext_dry']
-		_df['ALWC_SS_ext'] = _df['SS_ext'] - _df['SS_ext_dry']
-		_df['ALWC_ext'] = _df['total_ext'] - _df['total_ext_dry']
-
-		_df['fRH_IMPR'] = _df['total_ext'] / _df['total_ext_dry']
-
-		return _df['AS_ext_dry':]
-
-	def modified(self, _df):
-		_frh, _frhss, _frhs, _frhl = self.frh(_df['RH'])
-
-		_df['AS_ext_dry'] = 3 * 1 * _df['AS']
-		_df['AN_ext_dry'] = 3 * 1 * _df['AN']
-		_df['OM_ext_dry'] = 4 * _df['OM']
-		_df['Soil_ext_dry'] = 1 * _df['Soil']
-		_df['SS_ext_dry'] = 1.7 * 1 * _df['SS']
-		_df['EC_ext_dry'] = 10 * _df['EC']
-		_df['total_ext_dry'] = sum(_df['AS_ext_dry':'EC_ext_dry'])
-
-		_df['AS_ext'] = (3 * _frh * _df['AS'])
-		_df['AN_ext'] = (3 * _frh * _df['AN'])
-		_df['OM_ext'] = (4 * _df['OM'])
-		_df['Soil_ext'] = (1 * _df['Soil'])
-		_df['SS_ext'] = (1.7 * _frhss * _df['SS'])
-		_df['EC_ext'] = (10 * _df['EC'])
-		_df['total_ext'] = sum(_df['AS_ext':'EC_ext'])
-
-		_df['ALWC_AS_ext'] = _df['AS_ext'] - _df['AS_ext_dry']
-		_df['ALWC_AN_ext'] = _df['AN_ext'] - _df['AN_ext_dry']
-		_df['ALWC_SS_ext'] = _df['SS_ext'] - _df['SS_ext_dry']
-		_df['ALWC_ext'] = _df['total_ext'] - _df['total_ext_dry']
-
-		_df['fRH_IMPR'] = _df['total_ext'] / _df['total_ext_dry']
-
-		return _df['AS_ext_dry':]
-
-	@staticmethod
-	def gas(_df):
-		_df['ScatteringByGas'] = (11.4 * 293 / (273 + _df['AT']))
-		_df['AbsorptionByGas'] = (0.33 * _df['NO2'])
-		_df['ExtinctionByGas'] = _df['ScatteringByGas'] + _df['AbsorptionByGas']
-		return _df['ScatteringByGas':]
-
-	def process_data(self, reset: bool = False, save_file: Path | str = None,
-					 version: Literal["revised", "modified"] = "revised"):
-		save_file = Path(save_file)
-		if save_file.exists() and not reset:
-			return read_csv(save_file, parse_dates=['Time'], index_col='Time')
-		else:
-			# data_files = ['EPB.csv', 'IMPACT.csv', 'chemical.csv']
-			df = concat([DataReader(file) for file in self.file_paths], axis=1)
-
-			# particle contribution '銨不足不納入計算'
-			improve_input_df = df.loc[df['NH4_status'] != 'Deficiency', ['AS', 'AN', 'OM', 'Soil', 'SS', 'EC', 'RH']]
-
-			df_improve = improve_input_df.dropna().copy().apply(self.revised if version == 'revised' else self.modified,
-																axis=1)
-
-			# gas contribution
-			df_ext_gas = df[['NO2', 'AT']].dropna().copy().apply(self.gas, axis=1)
-
-			_df = concat([df_improve, df_ext_gas], axis=1).reindex(df.index.copy())
-			_df.to_csv(save_file)
-
-			return _df
+    """
+    A class for process improved chemical data.
+
+    Parameters:
+    -----------
+    reset : bool, optional
+        If True, resets the process. Default is False.
+    filename : str, optional
+        The name of the file to process. Default is None.
+    version : str, optional
+        The version of the data process. Should be one of 'revised' or 'modified'.
+        Default is None.
+
+    Methods:
+    --------
+    revised(_df):
+        Calculate revised version of particle contribution.
+
+    modified(_df):
+        Calculate modified version of particle contribution.
+
+    gas(_df):
+        Calculate gas contribution.
+
+    frh(_RH, version=None):
+        Helper function to get frh values based on relative humidity (RH) and version.
+
+    process_data():
+        Process data and save the result.
+
+    Attributes:
+    -----------
+    DEFAULT_PATH : Path
+        The default path for data files.
+
+    Examples:
+    ---------
+    >>> df = ImproveProc(reset=True, filename='revised_IMPROVE.csv', version='revised').process_data()
+
+    """
+
+    def __init__(self, file_paths: list[Path | str] = None):
+        super().__init__()
+        self.file_paths = [Path(fp) for fp in file_paths]
+
+    @staticmethod
+    def frh(_RH):
+        _frh = read_json(Path(__file__).parent.parent.parent / 'plot' / 'utils' / 'fRH.json')
+        if _RH is not None:
+            if _RH > 95:
+                _RH = 95
+            _RH = round(_RH)
+            return _frh.loc[_RH].values.T
+
+        return 1, 1, 1, 1
+
+    def revised(self, _df):
+        def mode(Mass):
+            L_mode = Mass ** 2 / 20 if Mass < 20 else Mass
+            S_mode = Mass - L_mode if Mass < 20 else 0
+
+            return L_mode, S_mode
+
+        _frh, _frhss, _frhs, _frhl = self.frh(_df['RH'])
+
+        L_AS, S_AS = mode(_df['AS'])
+        L_AN, S_AN = mode(_df['AN'])
+        L_OM, S_OM = mode(_df['OM'])
+
+        _df['AS_ext_dry'] = 2.2 * 1 * S_AS + 4.8 * 1 * L_AS
+        _df['AN_ext_dry'] = 2.4 * 1 * S_AN + 5.1 * 1 * L_AN
+        _df['OM_ext_dry'] = 2.8 * S_OM + 6.1 * L_OM
+        _df['Soil_ext_dry'] = 1 * _df['Soil']
+        _df['SS_ext_dry'] = 1.7 * 1 * _df['SS']
+        _df['EC_ext_dry'] = 10 * _df['EC']
+        _df['total_ext_dry'] = sum(_df['AS_ext_dry':'EC_ext_dry'])
+
+        _df['AS_ext'] = (2.2 * _frhs * S_AS) + (4.8 * _frhl * L_AS)
+        _df['AN_ext'] = (2.4 * _frhs * S_AN) + (5.1 * _frhl * L_AN)
+        _df['OM_ext'] = (2.8 * S_OM) + (6.1 * L_OM)
+        _df['Soil_ext'] = (1 * _df['Soil'])
+        _df['SS_ext'] = (1.7 * _frhss * _df['SS'])
+        _df['EC_ext'] = (10 * _df['EC'])
+        _df['total_ext'] = sum(_df['AS_ext':'EC_ext'])
+
+        _df['ALWC_AS_ext'] = _df['AS_ext'] - _df['AS_ext_dry']
+        _df['ALWC_AN_ext'] = _df['AN_ext'] - _df['AN_ext_dry']
+        _df['ALWC_SS_ext'] = _df['SS_ext'] - _df['SS_ext_dry']
+        _df['ALWC_ext'] = _df['total_ext'] - _df['total_ext_dry']
+
+        _df['fRH_IMPR'] = _df['total_ext'] / _df['total_ext_dry']
+
+        return _df['AS_ext_dry':]
+
+    def modified(self, _df):
+        _frh, _frhss, _frhs, _frhl = self.frh(_df['RH'])
+
+        _df['AS_ext_dry'] = 3 * 1 * _df['AS']
+        _df['AN_ext_dry'] = 3 * 1 * _df['AN']
+        _df['OM_ext_dry'] = 4 * _df['OM']
+        _df['Soil_ext_dry'] = 1 * _df['Soil']
+        _df['SS_ext_dry'] = 1.7 * 1 * _df['SS']
+        _df['EC_ext_dry'] = 10 * _df['EC']
+        _df['total_ext_dry'] = sum(_df['AS_ext_dry':'EC_ext_dry'])
+
+        _df['AS_ext'] = (3 * _frh * _df['AS'])
+        _df['AN_ext'] = (3 * _frh * _df['AN'])
+        _df['OM_ext'] = (4 * _df['OM'])
+        _df['Soil_ext'] = (1 * _df['Soil'])
+        _df['SS_ext'] = (1.7 * _frhss * _df['SS'])
+        _df['EC_ext'] = (10 * _df['EC'])
+        _df['total_ext'] = sum(_df['AS_ext':'EC_ext'])
+
+        _df['ALWC_AS_ext'] = _df['AS_ext'] - _df['AS_ext_dry']
+        _df['ALWC_AN_ext'] = _df['AN_ext'] - _df['AN_ext_dry']
+        _df['ALWC_SS_ext'] = _df['SS_ext'] - _df['SS_ext_dry']
+        _df['ALWC_ext'] = _df['total_ext'] - _df['total_ext_dry']
+
+        _df['fRH_IMPR'] = _df['total_ext'] / _df['total_ext_dry']
+
+        return _df['AS_ext_dry':]
+
+    @staticmethod
+    def gas(_df):
+        _df['ScatteringByGas'] = (11.4 * 293 / (273 + _df['AT']))
+        _df['AbsorptionByGas'] = (0.33 * _df['NO2'])
+        _df['ExtinctionByGas'] = _df['ScatteringByGas'] + _df['AbsorptionByGas']
+        return _df['ScatteringByGas':]
+
+    def process_data(self, reset: bool = False, save_file: Path | str = None,
+                     version: Literal["revised", "modified"] = "revised"):
+        save_file = Path(save_file)
+        if save_file.exists() and not reset:
+            return read_csv(save_file, parse_dates=['Time'], index_col='Time')
+        else:
+            # data_files = ['EPB.csv', 'IMPACT.csv', 'chemical.csv']
+            df = concat([DataReader(file) for file in self.file_paths], axis=1)
+
+            # particle contribution '銨不足不納入計算'
+            improve_input_df = df.loc[df['NH4_status'] != 'Deficiency', ['AS', 'AN', 'OM', 'Soil', 'SS', 'EC', 'RH']]
+
+            df_improve = improve_input_df.dropna().copy().apply(self.revised if version == 'revised' else self.modified,
+                                                                axis=1)
+
+            # gas contribution
+            df_ext_gas = df[['NO2', 'AT']].dropna().copy().apply(self.gas, axis=1)
+
+            _df = concat([df_improve, df_ext_gas], axis=1).reindex(df.index.copy())
+            _df.to_csv(save_file)
+
+            return _df

AeroViz/process/script/Others.py

@@ -8,58 +8,58 @@ from AeroViz.tools.datareader import DataReader
 
 
 class OthersProc(DataProc):
-	"""
-	A class for process impact data.
+    """
+    A class for process impact data.
 
-	Parameters:
-	-----------
-	reset : bool, optional
-		If True, resets the process. Default is False.
-	filename : str, optional
-		The name of the file to process. Default is None.
+    Parameters:
+    -----------
+    reset : bool, optional
+        If True, resets the process. Default is False.
+    filename : str, optional
+        The name of the file to process. Default is None.
 
-	Methods:
-	--------
-	process_data():
-		Process data and save the result.
+    Methods:
+    --------
+    process_data():
+        Process data and save the result.
 
-	Attributes:
-	-----------
-	DEFAULT_PATH : Path
-		The default path for data files.
+    Attributes:
+    -----------
+    DEFAULT_PATH : Path
+        The default path for data files.
 
-	Examples:
-	---------
-	>>> df = OthersProc().process_data(reset=True, filename=None)
+    Examples:
+    ---------
+    >>> df = OthersProc().process_data(reset=True, filename=None)
 
-	"""
+    """
 
-	def __init__(self, file_paths: Path | list[Path | str] = None):
-		super().__init__()
-		self.file_paths = [Path(fp) for fp in file_paths]
+    def __init__(self, file_paths: Path | list[Path | str] = None):
+        super().__init__()
+        self.file_paths = [Path(fp) for fp in file_paths]
 
-	def process_data(self, reset: bool = False, save_file: Path | str = None) -> DataFrame:
-		save_file = Path(save_file)
-		if save_file.exists() and not reset:
-			return read_csv(save_file, parse_dates=['Time'], index_col='Time')
-		else:
-			df = concat([DataReader(file) for file in self.file_paths], axis=1)
+    def process_data(self, reset: bool = False, save_file: Path | str = None) -> DataFrame:
+        save_file = Path(save_file)
+        if save_file.exists() and not reset:
+            return read_csv(save_file, parse_dates=['Time'], index_col='Time')
+        else:
+            df = concat([DataReader(file) for file in self.file_paths], axis=1)
 
-			results = DataFrame(index=df.index)
+            results = DataFrame(index=df.index)
 
-			results['PG'] = df[
-				['Scattering', 'Absorption', 'ScatteringByGas', 'AbsorptionByGas']].dropna().copy().apply(np.sum,
-																										  axis=1)
-			results['MAC'] = df['Absorption'] / df['T_EC']
-			results['Ox'] = df['NO2'] + df['O3']
-			results['N2O5_tracer'] = df['NO2'] * df['O3']
-			results['Vis_cal'] = 1096 / df['Extinction']
-			# results['fRH_Mix'] = df['Bext'] / df['Extinction']
-			# results['fRH_PNSD'] = df['Bext_internal'] / df['Bext_dry']
-			results['fRH_IMPR'] = df['total_ext'] / df['total_ext_dry']
-			results['OCEC_ratio'] = df['O_OC'] / df['O_EC']
-			results['PM1/PM25'] = np.where(df['PM1'] / df['PM25'] < 1, df['PM1'] / df['PM25'], np.nan)
-			# results['MEE_PNSD'] = df['Bext_internal'] / df['PM25']
-			# results['MEE_dry_PNSD'] = df['Bext_dry'] / df['PM25']
+            results['PG'] = df[
+                ['Scattering', 'Absorption', 'ScatteringByGas', 'AbsorptionByGas']].dropna().copy().apply(np.sum,
+                                                                                                          axis=1)
+            results['MAC'] = df['Absorption'] / df['T_EC']
+            results['Ox'] = df['NO2'] + df['O3']
+            results['N2O5_tracer'] = df['NO2'] * df['O3']
+            results['Vis_cal'] = 1096 / df['Extinction']
+            # results['fRH_Mix'] = df['Bext'] / df['Extinction']
+            # results['fRH_PNSD'] = df['Bext_internal'] / df['Bext_dry']
+            results['fRH_IMPR'] = df['total_ext'] / df['total_ext_dry']
+            results['OCEC_ratio'] = df['O_OC'] / df['O_EC']
+            results['PM1/PM25'] = np.where(df['PM1'] / df['PM2.5'] < 1, df['PM1'] / df['PM2.5'], np.nan)
+            # results['MEE_PNSD'] = df['Bext_internal'] / df['PM25']
+            # results['MEE_dry_PNSD'] = df['Bext_dry'] / df['PM25']
 
-			return results
+            return results

AeroViz/process/script/PSD.py

@@ -9,32 +9,32 @@ from AeroViz.process.script.AbstractDistCalc import DistributionCalculator
 
 class ParticleSizeDistProc(DataProc):
 	"""
-	A class for process particle size distribution (PSD) data.
-
-	Parameters
-	----------
-	filename : str, optional
-		The name of the PSD data file.
-		Defaults to 'PNSD_dNdlogdp.csv' in the default path.
-
-	Attributes
-	----------
-	file_path : Path
-		The directory path where the PSD data file is located.
-
-	psd : SizeDist
-		The SizeDist object.
-
-	Methods
-	-------
-	process_data(filename='PSD.csv')
-		Process and save overall PSD properties.
-
-	Examples
-	--------
-	Example 1: Use default path and filename
-	>>> psd_data = ParticleSizeDistProc(filename='PNSD_dNdlogdp.csv').process_data(reset=True)
-	"""
+    A class for process particle size distribution (PSD) data.
+
+    Parameters
+    ----------
+    filename : str, optional
+        The name of the PSD data file.
+        Defaults to 'PNSD_dNdlogdp.csv' in the default path.
+
+    Attributes
+    ----------
+    file_path : Path
+        The directory path where the PSD data file is located.
+
+    psd : SizeDist
+        The SizeDist object.
+
+    Methods
+    -------
+    process_data(filename='PSD.csv')
+        Process and save overall PSD properties.
+
+    Examples
+    --------
+    Example 1: Use default path and filename
+    >>> psd_data = ParticleSizeDistProc(filename='PNSD_dNdlogdp.csv').process_data(reset=True)
+    """
 
 	def __init__(self, file_path: Path | str = None):
 		super().__init__()