Metadata-Version: 2.1
Name: WES-Calculation
Version: 1.0.10
Summary: Mini Package for Waterfront Engineering Studio(WES) Calculation model, Currently include Greenampt, Gumbel Model Calculation
Home-page: https://github.com/bdfd/5.2-PyPi-WES_Calculation
Author: BDFD
Author-email: bdfd2005@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/bdfd/5.2-PyPi-WES_Calculation/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

<!--
 * @Author: BDFD
 * @Date: 2021-10-27 18:39:19
 * @LastEditTime: 2022-03-02 13:26:28
 * @LastEditors: BDFD
 * @Description: In User Settings Edit
 * @FilePath: \5.2-PyPi-WES_Calculation\README.md
-->

# Package Name

Package function description

## Installation

`pip install WES-Calculation`

## Function and Requirements

`import WES_Calculation as wes`

### Gumbel Function Usage

> Gumbel Model Necessary Input Parameter

`wes.gumbel(datao, unitx, unitt, i1, i2)`

- datao: 样本数据 <br>

  > Input Type: list type
  > Demo Input: '1.55, 1.4, 1.35, 1.26, 1.2, 1.16, 1.1, 1.05, 1.01, 0.97, 0.88, 0.86, 0.82, 0.8, 0.75'

- unitx: 物理量单位<br>

  > Input Type: string type
  > Demo Input: 'Inch','inch'

- unitt: 样本数据的时间间隔<br>

  > Input Type: string type
  > Demo Input: 'Year','year'

- i1: 概率分析的类型 <br>

  > Input Type: Int type
  > Explaination:
  > &ensp;&ensp;1 for 极大值
  > &ensp;&ensp;2 for 极小值(Only Two Valid Input)
  > Demo Input: 1

<!-- - i2 概率空间是否截尾 <br>

  > Input Type: Int type
  > Explaination: 1 for 否, 2 for 是(Only Two Valid Input)
  > Demo Input: 1 -->

- i2: 经验估计频率模型 <br>

  > Input Type: Int type
  > Explaination:
  > &ensp;&ensp;1 for Weibull
  > &ensp;&ensp;2 for 中值
  > &ensp;&ensp;3 for Gringorton(Only Three Valid Input)
  > Demo Input: 3

- Output <br>

  > Result: list type
  > Explaination:  
  > &ensp;&ensp;plot_url: result graph for input
  > &ensp;&ensp;data: result data for table value
  > Demo Output:
  > &ensp;&ensp;result = wes.gumbel(datao, unitx, unitt, i1, i2)
  > &ensp;&ensp;plot_url = result[0]
  > &ensp;&ensp;data = result[0]

## License

copyright @ 2021 BDFD

This repository is licensed under the MIT license. See LICENSE for details.

### References

https://github.com/bdfd/5.2-PyPi-WES_Calculation


