Metadata-Version: 2.4
Name: fiberis
Version: 0.3.0
Summary: Fiber Reservoir Integrated Simulator
Author-email: Shenyao Jin <shenyaojin@mines.edu>
License:     DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                           Version 2, December 2004
         
        Copyright (C) 2025 Shenyao Jin <shenyaojin@mines.edu>
        
        Everyone is permitted to copy and distribute verbatim or modified
        copies of this license document, and changing it is allowed as long
        as the name is changed.
         
                   DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
          TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
        
         0. You just DO WHAT THE FUCK YOU WANT TO.
        
Project-URL: Homepage, https://github.com/shenyaojin/fibeRIS
Project-URL: Repository, https://github.com/shenyaojin/fibeRIS
Project-URL: Documentation, https://github.com/shenyaojin/fibeRIS/tree/main/docs
Project-URL: Issues, https://github.com/shenyaojin/fibeRIS/issues
Keywords: fiber optics,reservoir simulation,physics,engineering,numerical simulation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: h5py<4.0,>=3.7
Requires-Dist: matplotlib<4.0,>=3.5
Requires-Dist: numpy<2.0,>=1.22
Requires-Dist: pandas<3.0,>=1.5
Requires-Dist: plotly<6.0,>=5.10
Requires-Dist: python-dateutil<3.0,>=2.8
Requires-Dist: scipy<2.0,>=1.8
Requires-Dist: meshio<6.0,>=5.0
Provides-Extra: dev
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: flake8>=6.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: sphinx>=6.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.0; extra == "docs"
Requires-Dist: mkdocs>=1.5; extra == "docs"
Provides-Extra: all
Requires-Dist: fiberis[dev]; extra == "all"
Requires-Dist: fiberis[docs]; extra == "all"
Dynamic: license-file

# fibeRIS

**fibeRIS: Fiber Optic Reservoir Integrated Simulator**

`fibeRIS` is a Python-based toolkit for the analysis, simulation, and management of data relevant to reservoir engineering, with a particular focus on Distributed Fiber Optic Sensing (DFOS) data. This project provides a suite of modules for handling multi-dimensional datasets, performing signal processing, simulating pressure diffusion, and programmatically controlling the [MOOSE (Multiphysics Object-Oriented Simulation Environment)](https://mooseframework.inl.gov/) framework.

## Functions of fiberis

### Data management
TBD
### Data cleansing
TBD
### Data processing
TBD
### Simulation
I just can't find a phrase like "data xxx" :(

## Installation

To install `fibeRIS` in editable mode, which is recommended during its ongoing development, clone the repository and run:

```bash
pip install -e .
```

## License

This project is licensed under the WTFPL – Do What the Fuck You Want to Public License. See the `LICENSE` file for details.
