Metadata-Version: 2.4
Name: EVENT_PACKAGE
Version: 0.2.1
Home-page: https://github.com/jorelix/Event_analysis_code
Author: Emeka Aniekwensi
Author-email: felixaniekwensi@gmail.com; aniekwen@msu.edu
License: MIT License
        
        Copyright (c) [year] [fullname]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Classifier: Programming Language :: Python
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python

## DRAINAGE DISCHARGE EVENT ANALYSIS

Catches *EVENTS* separating the event flow from base flow

 
## Instructions 

'''
pip install EVENT_PACKAGE - This allows you install the package in shells like anaconda and powershell
'''

There are two such categories to this package

a. You have the daily event data that can be called when the discharge data is in the daily data resolution 'from EVENT_PACKAGE import daily_event'

b. You have the hourly event data that can be called when the discharge data is in the hourly data resolution 'from EVENT_PACKAGE import hourly_event'

## DATA TYPES

This code would require that you input at least Three (3) data sets

## DATA A - Discharge data

The Date in the first column of the CSV file


## DATA B - DATES

The discharge data should be saved in a in the second column of the CSV file


## DATA C - DATES

The concentration on the third column of the CSV file. if you do not have the concentration, fill up the column with '1's.

## Hourly Date Format

hourly data should be of the form mm/dd/yy hh:mm   example: 10/03/2025 2:00 (for October 3rd 2025 second hour (2nd hour)))

Note the time resolution is in the 24 hours scale 0:00 - 23:00


## Daily Date Format

daily date should be in the form dd/mm/yy   example: 10/01/2023 (for 10th January 2023)


## Files names

The program asks for the name of the CSV file. Note!! - the file type ".csv" is important
Example:
if the file name is data.csv the code input should be 'data.csv' (Including the file type)

## DATA ORGANIZATION IN THE CSV FILE

# Daily

for daily data analysis, the data should be arranged in the format  below

| Date | Drainage Discharge | Concentration | Water Table | Water Temp |

Note: You might not input all the date if for example you do not have Water table depth and/or Water Temp. 

However, you must input the first 3 data columns must be filled.

If you do not have the Concentration data, fill up the column with '1'.

Example:
Concentration
1
1
1
...

b. event_data.txt for the daily drainage discharge TXT file

# hourly data

for hourly data analysis, the data should be arranged in the format  below

| Date | Drainage Discharge | Concentration | Water Table | Water Temp |

Note: You might not input all the date if for example you do not have Water table depth and/or Water Temp. 

However, you must input the first 3 data columns must be filled.

If you do not have the Concentration data, fill up the column with '1'.

Example:
Concentration
1
1
1
...

# Location of txt file

The CSV files should be save in the same folder as the code (Running script)

## EXCUTE THE CODE

To excute the code you need to just call the package depending on what data you want to analyse

# For Daily Event Analysis

from EVENT_PACKAGE import daily_event

# hourly Event Analysis

from EVENT_PACKAGE import hourly_event

## NOTES!!!!

1. MISSING DATA DOES NOT AFFECT THE PLOT SO DO NOT WORRY ABOUT CLEANING MISSING DATA
