Skip to content
This repository has been archived by the owner on Jul 6, 2023. It is now read-only.

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicholas Geneva committed Nov 30, 2020
1 parent 2e8f93a commit 4c89ab1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,21 @@ Multi-fidelity Generative Deep Learning Turbulent Flows [[FoDS]()][[ArXiv](https

A novel multi-fidelity deep generative model is introduced for the surrogate modeling of high-fidelity turbulent flow fields given the solution of a computationally inexpensive but inaccurate low-fidelity solver.

- Getting Started
- Documentation
- Data Repository
- [Getting Started](https://deep-turbulence.readthedocs.io/en/latest/start.html)
- [Documentation](https://deep-turbulence.readthedocs.io/en/latest/index.html)
- [Data Repository](https://doi.org/10.5281/zenodo.4298896)

### Core Dependencies
* Python 3.6.5
* [PyTorch](https://pytorch.org/) 1.6.0
* [Matplotlib](https://matplotlib.org/) 3.1.1
* [SciPy](https://www.scipy.org/) 1.5.2
* [Dataclasses](https://docs.python.org/3/library/dataclasses.html) 0.7.0

See requirements.txt for full dependency list.

## Citation
Cite us with:
Find this useful or like this work? Cite us with:
```latex
@article{geneva2020multi,
title={Multi-fidelity Generative Deep Learning Turbulent Flows},
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../tmglow'))
sys.path.insert(0, os.path.abspath('../../tmglow'))

from sphinx.ext.autodoc import between
Expand Down

0 comments on commit 4c89ab1

Please sign in to comment.