Browse Source

Update Readme with install steps

vogdb 5 years ago
parent
commit
df4184710d
1 changed files with 4 additions and 0 deletions
  1. 4 0
      README.md

+ 4 - 0
README.md

@@ -12,6 +12,10 @@ Clonic seizure -
 
 ### Run
 
+#### Install
+You need [Python](https://www.python.org/downloads/) of version 3.6 or higher. Also I highly recommend to use environments for work. [Anaconda](https://www.anaconda.com/distribution/) is a good choice. The required dependencies are:
+    - matplotlib, numpy, scipy, yaml
+
 #### 2D case
 - Adjust params as you need in `params_0d.py` and `params_2d.py`. 
 - Execute `python model_2d_full.py`. It gives 3 files as the result in `results` dir. These files have names: `<YYYY-mm-dd_HH.MM>_plain.npz`, `<YYYY-mm-dd_HH.MM>_points.npz`, `<YYYY-mm-dd_HH.MM>_params.npz` correspondingly, where `<YYYY-mm-dd_HH.MM>` is the date/time when your execution ended.