Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments
9. Howto Cite

About The Project

This project provides the source code of the figures in the publication Spurin et al. Dynamic Mode Decomposition for Analyzing Dynamics in Multi-phase Flow in Porous Media ... paper

(back to top)

Built With

• Readme based on Best Readme Template
• Jupyter notebooks generated from .py files with jupytext

(back to top)

Getting Started

Read the paper to get some background info. Then install your favorite Python distribution of you don't already have one (we used Anaconda), install required libraries, download the code and run the examples.

Prerequisites

The code and examples can be run from most modern Python distributions such as Anaconda. You may want to choose a distribution that has matplotlib, numpy and other standard packages pre-installed. There are a few extra libraries to install:

• pandas (using internally pandas data frames, but also to import/expert data)
• pydmd (the package for DMD analysi)

Installation

1. Clone the repo sh git clone https://github.com/cspurin/dmd.git
2. Install additioal Python libraries
   pandas sh conda install pandas lmfit sh pip install pydmd

Running Examples

We include 2 examples from the paper Spurin et al. Dynamic Mode Decomposition for Analyzing Dynamics in Multi-phase Flow in Porous Media ...

• Fig. 03-05 sh DMD_steady-state_Darcy-scale.py
• Fig. xxx sh xxx.py

The .py files are also available as .ipynb Jupyter notebooks (generated with jupytext). Respective markdown tags are included in the .py files to generate the formatting e.g. headers in the Jupyter notebooks.

(back to top)

Roadmap

• [ ] Add Changelog
• [ ] Add more examples from previous papers
  • [ ] steady-state experiments
  • [ ] matching real data

(back to top)

Contributing

It would be great if you could contribute to this project. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Catherine Spurin - LinkedIn - cspurin@stanford.edu

Steffen Berg - LinkedIn - steffen.berg@shell.com

Project Link: https://github.com/cspurin/dmd/

(back to top)

Acknowledgments

We would like to acknowledge

• James E. McClure
• Ryan T. Armstrong

(back to top)

Howto Cite

1. C. Spurin et al., Spurin et al. Dynamic Mode Decomposition for Analyzing Dynamics in Multi-phase Flow in Porous Media ... to be submitted

(back to top)