https://github.com/lin-jun-xiang/pyfeflow

:ocean:Open Source Package for the FEFLOW-Python
https://github.com/lin-jun-xiang/pyfeflow

feflow groundwater-modelling ifm python simulation

Last synced: about 2 months ago
JSON representation

:ocean:Open Source Package for the FEFLOW-Python

• Host: GitHub
• URL: https://github.com/lin-jun-xiang/pyfeflow
• Owner: Lin-jun-xiang
• License: mit
• Created: 2022-03-22T10:14:47.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-26T09:39:32.000Z (about 1 year ago)
• Last Synced: 2024-10-11T09:35:05.050Z (2 months ago)
• Topics: feflow, groundwater-modelling, ifm, python, simulation
• Language: Python
• Homepage:
• Size: 1.6 MB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## :penguin:FEFLOW-PYTHON-IFM







[English](./README.md) | [中文版說明書](./README_%E4%B8%AD%E6%96%87.md)



    



---

- **Required Software**

    - `FEFLOW`: Groundwater flow numerical simulation (Demo or license version)

    - `Python`





* **Overview of Functions**

    *  - [x] [Introduction to IFM and USER-DATA](./darcyflux-z/)

    *  - [x] [Visualization of Pumping Test Drawdown](./drawdown/)

    *  - [x] [Monte Carlo Numerical Simulation](./mc/)

    *  - [ ] [Markov Chain Monte Carlo Numerical Simulation](./mcmc/)

    *  - [x] [Use *Cache-Optimized* Monte Carlo Simulation](./mc-cache/)

    *  - [x] [Optimization Algorithim (Calibration)](./optimization/)

    *  - [ ] [Discritization Package]()

    *  - [x] [Unsaturation Curve](./water-retention-curve/)

    *  - [x] [Tiff to Excel](./tif-to-excel/)

---

### Introduction

This project develops a package for groundwater flow numerical simulation using `ifm-api-python`.

>What is `ifm-api`?

>Interface Manager is a built-in function (API) in `feflow`. By calling these functions through scripts (e.g., `python`, `c++`), the entire simulation process can be operated to achieve more refined and automated numerical simulation.

>

>For example, if you want to perform tens of thousands of simulations, it is not practical to repeatedly operate through `feflow GUI`, but by scripting, you can write a program to perform tens of thousands of simulations and save the results of each simulation.

>

>`ifm` [docs](http://www.feflow.info/html/help73/feflow/13_Programming/IFM/API/api_index.html)

---

### Instructions

1. Click the :star: `Star` button on this project to support and motivate the developer.

2. Make sure you have `feflow` and `python` installed on your computer.

3. Use the link in the function overview to access detailed information and source code for each function.

    * Each function introduction will first explain whether `feflow` requires a `license`.

    * Each function will have a detailed instruction file (`README.md`).

4. Clone the repository using `git clone https://github.com/Lin-jun-xiang/feflow-python-ifm.git`.

5. Start using the package.

Back to top