Browse Source

added full paths to the scripts

Paul Pfeiffer 3 years ago
parent
commit
8a4d192dd5
1 changed files with 8 additions and 21 deletions
  1. 8 21
      README.md

+ 8 - 21
README.md

@@ -1,7 +1,4 @@
-# 
-
-Interneurons in the subiculum have a polarized axonal cloud instead of a circular as found in other brain regions. Additionally, pyramidal neurons in the subiculum lack recurrent connections, but they connect via recurrent inhibition. Therefore, inhibition plays a major role in this circuitry and we pose the question, which function the extraordinary axon morphology serves in this setting.
-
+# Spatially structured perisomatic inhibition organized along polarized fast-spiking interneuron axons
 
 
 ### How to setup the python environment
@@ -22,40 +19,30 @@ To run the scripts, you also need to make the repository folder available in the
 conda develop .
 ```
 
-If you need additional packages, install them via `conda install` and update the environment file via
-
-```bash
-conda env export > environment.yml
-```
-
-To update the existing environment
-```bash
-conda-env update -f environment.yml
-```
-
 ### How to run the simulation
 
-The entire process is split in three main scripts. The simulation is setup and run in
+The entire process is split in three main scripts. The simulation is setup and run via
 ```bash
-run_simulation_perlin_map.py
+python scripts/spatial_network/perlin_map/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. 
 A preliminary analysis of the simulated data is done by running 
 ```bash
-preliminary_analysis_perlin_map.py
+python scripts/spatial_network/perlin_map/preliminary_analysis_perlin_map.py
 ```
 The final analysis and figure generation is done by 
 ```bash
-final_analysis_and_plotting_perlin_map.py
+python scripts/spatial_network/perlin_map/final_analysis_and_plotting_perlin_map.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
 ```bash
-run_and_analyze_perlin.py
+python scripts/spatial_network/perlin_map/run_and_analyze_perlin.py
 ```
 after which the figure script can be tweaked and executed without loss of data.
 
-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 pinwheel_map. 
+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`. 
 
 ### Additional Ressources