Skip to content

Commit

Permalink
Updated README with acknowledgements
Browse files Browse the repository at this point in the history
  • Loading branch information
lorisercole committed Oct 15, 2018
1 parent e8663bc commit f51005d
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,19 @@ Code to compute thermal conductivity through cepstral analysis of heat flux time
- Ercole, Marcolongo, Baroni, Sci. Rep. 7, 15835 (2017), https://doi.org/10.1038/s41598-017-15843-2
- for the multi-component analysis: Baroni, Bertossa, Ercole, Grasselli, Marcolongo, https://arxiv.org/abs/1802.08006

### usage
**Acknowledgement** The development of this software is part of the scientific program of the EU MaX Centre of Excellence for Supercomputing Applications (Grant No. 676598) and has been partly funded through it.

The file analysis.py is the main program, that can run from the command line with python 2.7.
It executes all the parts of cepstral analysis producing the final result and a number of figures in a pdf output.
### Usage
The code can be used as a **library**, for example in a Jupyter notebook.
In the "example" folder you can find some examples.

Alternatively, you can run the code "analysis.py" from the **command line**.
It can execute most of the cepstral analysis routines, writing the result in a series of data files and PDF plots.
See help (python analysis.py --help) for more informations.

The code can be used as a library, in a jupyter notebook for example, as shown in the example directory.
### Requirements
- Python 2.7
- Numpy
- Scipy
- Matplotlib

0 comments on commit f51005d

Please sign in to comment.