diff --git a/run_example.py b/run_example.py index 912ec7eb7ff6920270d9519ec5d0fda1264176ba..40251bf2e45cac06ac20dd1b0d4019116a968897 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 bb9e6307ad9a876a17eeb85c4d9e0fe48d2034ca..4f2e4917859d644a059629b6b24a8080de54ea43 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 4029c3c7a305ed910c7a918a96288212b8319768..54896778244c1a174df743d72f3d34e4caca2140 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