From de97754fdbe085ef7c513dbe70274bbbcf80024e Mon Sep 17 00:00:00 2001
From: Maximilian Schmidt <max.schmidt@fz-juelich.de>
Date: Fri, 30 Mar 2018 17:21:08 +0900
Subject: [PATCH] Add documentation to run_simulation.py, fix typos and bug in
run_example.py
---
run_example.py | 2 +-
run_simulation.py | 13 +++++++++++++
start_jobs.py | 2 +-
3 files changed, 15 insertions(+), 2 deletions(-)
diff --git a/run_example.py b/run_example.py
index 912ec7e..40251bf 100644
--- a/run_example.py
+++ b/run_example.py
@@ -1,4 +1,4 @@
-From multiarea_model import MultiAreaModel
+from multiarea_model import MultiAreaModel
from start_jobs import start_job
from config import submit_cmd, jobscript_template
diff --git a/run_simulation.py b/run_simulation.py
index bb9e630..4f2e491 100644
--- a/run_simulation.py
+++ b/run_simulation.py
@@ -1,3 +1,16 @@
+"""
+This script is used to run a simulation from the given command-line
+arguments:
+1. Label of the simulation
+2. Label of the network to be simulated
+
+It initializes the network class and then runs the simulate method of
+the simulation class instance.
+
+This script should be used in the `jobscript_template` defined in the
+config.py file. See config_template.py.
+"""
+
import json
import nest
import os
diff --git a/start_jobs.py b/start_jobs.py
index 4029c3c..5489677 100644
--- a/start_jobs.py
+++ b/start_jobs.py
@@ -24,7 +24,7 @@ def start_job(label, submit_cmd, jobscript_template, sumatra=False, reason=None,
identified by the label.
submit_cmd : str
Submit command of the queueing system used.
- job_script_template : formatted str
+ jobscript_template : formatted str
Formatted string defining the template for the job script.
Can include the following keyword arguments:
sim_dir : str
--
GitLab