README.md

IHSetHansonKraus1991

Python package to run and calibrate Hanson and Kraus (1991) one-line model.

🏠 Local installation

• Using pip:

pip install git+https://github.com/defreitasL/IHSetHansonKraus1991.git

---

⚡ Main methods

• HansonKraus1991:

# model's it self
hansonKraus1991(yi, dt, dx, hs, tp, dir, depth, doc, kal, X0, Y0, phi, bctype)

• cal_HansonKraus1991:

# class that prepare the simulation framework
cal_HansonKraus1991(path)

📦 Package structures

IHSetHansonKraus1991
|
├── LICENSE
├── README.md
├── build
├── dist
├── IHSetHansonKraus1991
│   ├── calibration.py
│   └── HansonKraus1991.py
└── .gitignore

---

📨 Contact us

🐍 For code-development issues contact 👨‍💻 Lucas de Freitas @ 🏢 IHCantabria

©️ Credits

Developed by 👨‍💻 Lucas de Freitas @ 🏢 IHCantabria.