PySMEV

PySMEV contains a set of methods to apply the Simplified Metastatistical Extreme Value analysis as presented in:

Francesco Marra. (2020). A Unified Framework for Extreme Sub-daily Precipitation Frequency Analyses based on Ordinary Events - data & codes (Versione v1). Zenodo. https://doi.org/10.5281/zenodo.3971558

The scripts were tested on data coming from:

Dallan, E., & Marra, F. (2022). Enhanced summer convection explains observed trends in extreme subdaily precipitation in the Eastern Italian Alps - Codes & data (Versione v1). Zenodo. https://doi.org/10.5281/zenodo.6088848

Installation

Install using:

Python version required: <3.12

Module required can be found in either requirements.txt or env.yml

For the moment the package is not available on pypi, so you need to install it from the source code. To do so, clone the repository and run the following command in the root folder of the repository:

pip install .

Usage

The package contains a class called SMEV that can be used to apply the Simplified Metastatistical Extreme Value analysis. The class is initialized with the following parameters:

• threshold: the threshold above which the data is considered extreme
• separation: the separation between the data points in the time series
• return_period: the return period for which the analysis is performed
• durations: the durations for which the analysis is performed
• time_resolution: the time resolution of the data

The class contains the following methods:

!! TO COMPLETE !!

The following is an example of how to use the class:

import os
from os.path import dirname, abspath, join
import sys
THIS_DIR = dirname(__file__)
CODE_DIR = abspath(join(THIS_DIR, '/', 'src'))
sys.path.append(CODE_DIR)
import json
import argparse
import numpy as np
import xarray as xr
import pandas as pd
from glob import glob
from tqdm import tqdm
import matplotlib as mpl
import matplotlib.pyplot as plt
from scipy.stats import genextreme as gev

from pysmev import *

file_path_input="res/s0019_v3.parquet"
# Define the file path where you want to save the dictionary
filename_output = file_path_input.split("/")[-1].split(".")[0]

file_path_output = f'out/{filename_output}.json'
TYPE='numpy' # choiches numpy or panda
S=SMEV(
    threshold=0,
    separation=24,
    return_period=get_return_period(),
    durations=[15,30,45,60,120,180,360,720,1440],
    time_resolution=5
)

For a complete example of how to use the class, run the file test_smev.py in the src folder with the following command:

python src/test_smev.py

Development

Please work on a feature branch and create a pull request to the development branch. If necessary to merge manually do so without fast forward:

git merge --no-ff myfeature

To build a development environment run:

python3 -m venv env
source env/bin/activate
pip install -e .
pip install -r requirements.txt

With Conda

conda env create -f env.yml
conda activate env
pip install -e .

Rebuild is done by setup.py inside of new branch. .. code-block:: bash setup.py sdist bdist_wheel

Contributions

## How to Submit an Issue

We welcome your feedback and contributions! If you encounter a bug, have a feature request, or have any other issue you'd like to bring to our attention, please follow the steps below:

1. Check for Existing Issues: Before you submit a new issue, please check if a similar issue already exists in our [issue tracker](https://github.com/luigicesarini/pysmev/issues). If you find an existing issue that matches your concern, you can contribute to the discussion by adding your comments or reactions.
2. Open a New Issue: If you don't find an existing issue that matches your concern, you can open a new one by following these steps: - Go to the [Issues](https://github.com/luigicesarini/pysmev/issues) section of the repository. - Click on the New Issue button. - Select the appropriate issue template, if available. - Fill in the title and description with as much detail as possible. Include steps to reproduce the issue, the expected behavior, and the actual behavior. Providing screenshots or code snippets can be very helpful. - Submit the issue.
3. Follow Up: After you submit the issue, we might need more information from you. Please stay tuned for our comments and respond promptly if we request additional details.

### Issue Submission Guidelines

• Be Clear and Descriptive: Help us understand the issue quickly and thoroughly.
• Provide Context: Describe the problem, including the version of the software, operating system, and any other relevant details.
• Include Screenshots and Logs: If applicable, add any screenshots, logs, or stack traces that can help diagnose the problem.
• Use a Consistent and Descriptive Title: This helps others quickly identify issues that might be similar to theirs.
• Be Respectful and Considerate: Keep in mind that we are all part of a community and we aim to create a positive and collaborative environment.

Thank you for helping us improve!

[Open an Issue](https://github.com/luigicesarini/pysmev/issues/new)

Credits

We wish to thank Yaniv Goldschmidt from Hebrew University yanivfry@gmail.com