Skip to content

Commit 9bbda64

Browse files
authored
Update README.md
1 parent 948e29e commit 9bbda64

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
# dalesview
22
A python package for visualization of DALES input/output data. DALES is the Dutch Atmospheric Large Eddy Simulation program (https://github.com/dalesteam/dales) and its input ASCII files and output NetCDF files can be quickly inspected with this library.
3+
4+
### Installation
5+
Clone the repository, activate your appropriate python environment, and in the root directory of this repo type
6+
```
7+
pip install .
8+
```
9+
or `python setup.py install`. It should automatically install the dependencies numpy, matplotlib and netCDF4 as well.
10+
11+
### Usage
12+
For testing execute the example.py script on the test data. The package allows you to access the input and output data through python objects and plot them easily. E.g. if your run directory is `<rundir>` and experiment number is `<exp>`, you should be able to run
13+
```
14+
$ python
15+
>>> from dalesdata import dalesdata
16+
>>> data = dalesdata.dalesdata(<rundir>,<exp>)
17+
>>> print data # lists all available variables
18+
>>> from dalesview import dalesview
19+
>>> view = dalesview.dalesview(data)
20+
>>> view.plot(data.input)
21+
>>> view.plot("thl","tke")
22+
>>> # etc.
23+
```

0 commit comments

Comments
 (0)