jkuhl/corrlib
1
0
Fork 0
Code Issues 11 Pull requests Releases Packages Activity Actions

add docstrings for openQCD filter
Some checks failed
Mypy / mypy (push) Successful in 1m15s
Details
Pytest / pytest (3.12) (push) Successful in 1m21s
Details
Pytest / pytest (3.13) (push) Successful in 1m15s
Details
Pytest / pytest (3.14) (push) Successful in 1m18s
Details
Ruff / ruff (push) Failing after 1m1s
Details

Browse source
This commit is contained in:
Justus Kuhlmann 2026-04-07 11:29:10 +02:00
commit 4673751dc3
Signed by: jkuhl
GPG key ID: 00ED992DD79B85A6
1 changed files with 33 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

33
corrlib/find.py
View file

@ -273,10 +273,43 @@ def sfcf_filter(results: pd.DataFrame, **kwargs: Any) -> pd.DataFrame:
def openQCD_filter(results:pd.DataFrame, **kwargs: Any) -> pd.DataFrame: def openQCD_filter(results:pd.DataFrame, **kwargs: Any) -> pd.DataFrame:
"""
Filter for parameters of openQCD.
Parameters
----------
results: pd.DataFrame
The unfiltered list of results from the database.
Returns
-------
results: pd.DataFrame
The filtered results.
"""
return results return results
def _code_filter(results: pd.DataFrame, code: str, **kwargs: Any) -> pd.DataFrame: def _code_filter(results: pd.DataFrame, code: str, **kwargs: Any) -> pd.DataFrame:
"""
Abstraction of the filters for the different codes that are available.
At the moment, only openQCD and SFCF are known.
The possible key words for the parameters can be seen in the descriptionso f the code-specific filters.
Parameters
----------
results: pd.DataFrame
The unfiltered list of results from the database.
code: str
The name of the code that produced the record at hand.
kwargs:
The keyworkd args that are handed over to the code-specific filters.
Returns
-------
results: pd.DataFrame
The filtered results.
"""
if code == "sfcf": if code == "sfcf":
return sfcf_filter(results, **kwargs) return sfcf_filter(results, **kwargs)
elif code == "openQCD": elif code == "openQCD":