Browse Source

adapted README

Paul Pfeiffer 3 years ago
parent
commit
20f5afcd41
1 changed files with 23 additions and 10 deletions
  1. 23 10
      README.md

+ 23 - 10
README.md

@@ -21,26 +21,39 @@ conda develop .
 
 ### How to run the simulation
 
-The entire process is split in three main scripts. The simulation is setup and run via
+The entire process is split in three main scripts: run, analysis and plotting. We use [pypet](https://pypet
+.readthedocs.io/en/latest/) to organize our simulations and save intermediate results. 
+
+#### Simulate the spatial networks
+The simulation is setup and run via
 ```bash
-python scripts/spatial_network/perlin_map/run_simulation_perlin_map.py
+cd scripts/spatial_network/perlin_map
+python run_simulation_perlin_map.py
 ```
-Relevant parameters are the range of scale and seed values for the input map generation as explained in the script. 
+This script also contains the relevant parameter settings such as network size or the form of the interneuron
+ axons. To allow exceution of the script in a reasonable time, we reduced the number of input maps that are tested
+ . In the script, you find instructions to make the full run. After the script has successfully finished, you find
+  the output in the `data` folder. 
+
+#### Analysis of the network activity
+
 A preliminary analysis of the simulated data is done by running 
 ```bash
-python scripts/spatial_network/perlin_map/preliminary_analysis_perlin_map.py
+python preliminary_analysis_perlin_map.py
 ```
-The final analysis and figure generation is done by 
+To run both simulation and preliminary analysis 
 ```bash
-python scripts/spatial_network/perlin_map/final_analysis_and_plotting_perlin_map.py
+python run_and_analyze_perlin.py
 ```
-Note, that running the simulation script will overwrite the saved data. 
-The bulk of the runtime lies within the simulation and preliminary analysis which can be executed together via
+
+#### Generate plots
+
+The final analysis and figure generation is done by 
 ```bash
-python scripts/spatial_network/perlin_map/run_and_analyze_perlin.py
+python final_analysis_and_plotting_perlin_map.py
 ```
-after which the figure script can be tweaked and executed without loss of data.
 
+#### Supplemental figure
 For the supplement figure, a pinwheel map is used as an alternative input map. The run, analyse and plot scripts are
  organized in the same manner but found in the folder `scripts/spatial_network/supplement_pinwheel_map`.