Pandas Util filter_by_model_query¶
filter_by_model_query
¶
filter_by_model_query(df: Series | DataFrame, model_df: DataFrame, query: str = None, match_on_level: int | str = None) -> DataFrame | Series
Filter DataFrame or Series based on a query applied to a model DataFrame.
This function filters data by applying a pandas query to a model DataFrame and using the resulting index to filter the target DataFrame or Series. It handles both simple and MultiIndex cases automatically.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
df
|
Series | DataFrame
|
The DataFrame or Series to filter. |
required |
model_df
|
DataFrame
|
The model DataFrame containing metadata used for filtering. Must have an index that can be matched against df's axis. |
required |
query
|
str
|
A pandas query string to apply to model_df. If None or empty, returns df unchanged. Uses pandas query syntax. |
None
|
match_on_level
|
int | str
|
For MultiIndex cases, specifies which level to match on. Can be an integer (level position) or string (level name). |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame | Series
|
Filtered DataFrame or Series with the same type as input df. |
Examples:
>>> generation = dataset.fetch('Generator.Results.generation')
>>> generators = dataset.fetch('Generator.Model')
>>> generators
node fuel capacity
Generator
G1 N1 nuclear 800.0
G2 N1 coal 900.0
G3 N2 gas 1000.0
G4 N2 wind 1100.0
G5 N3 solar 1200.0
>>> renewable = filter_by_model_query(generation, generators, 'fuel in ["wind", "solar"]')
>>> sorted(renewable.columns)
['G4', 'G5']
Source code in src/mesqual/utils/pandas_utils/filter.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | |