Skip to content

Commit 021b1b6

Browse files
committed
Add requirements.txt file and corresponding description to README; issue #22.
1 parent 7c8ca0e commit 021b1b6

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

Diff for: README.md

+9
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,15 @@ pip3 install git+https://github.com/FlowModelingControl/flowtorch
7272
# to uninstall flowTorch, run
7373
pip3 uninstall flowtorch
7474
```
75+
Alternatively, you can also clone the repository manually by running
76+
```
77+
git clone [email protected]:FlowModelingControl/flowtorch.git
78+
```
79+
and install the dependencies listed in *requirements.txt*:
80+
```
81+
pip3 install -r requirements.txt
82+
```
83+
7584
To get an overview of what *flowTorch* can do for you, have a look at the [online documentation](https://flowmodelingcontrol.github.io/flowtorch-docs/1.0/index.html). The examples presented in the online documentation are also contained in this repository. In fact, the documentation is a static version of several [Jupyter labs](https://jupyter.org/) with start-to-end analyses. If you are interested in an interactive version of one particular example, navigate to `./docs/source/notebooks` and run `jupyter lab`. Note that to execute some of the notebooks, the **corresponding datasets are required**. The datasets can be downloaded [here](https://cloudstorage.tu-braunschweig.de/getlink/fiYBqV7Qq1cAxLBsxQpPBvsw/datasets_15_10_2021.tar.gz) (~2.5GB). Download the data into a directory of your choice and navigate into that directory. To extract the archive, run:
7685
```
7786
tar xzf datasets_15_10_2021.tar.gz

Diff for: requirements.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
h5py
2+
netCDF4
3+
matplotlib
4+
numpy
5+
numpy-stl
6+
pandas
7+
plotly
8+
torch >= 1.9
9+
jupyterlab
10+
scikit-learn
11+
vtk

Diff for: setup.py

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@
4242
"pandas",
4343
"plotly",
4444
"torch >= 1.9",
45+
"jupyterlab",
46+
"scikit-learn",
4547
"vtk"
4648
]
4749
)

0 commit comments

Comments
 (0)