File: build_examples.py

package info (click to toggle)
pynn 0.10.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,156 kB
  • sloc: python: 25,612; cpp: 320; makefile: 117; sh: 80
file content (138 lines) | stat: -rw-r--r-- 3,862 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
"""


"""

import os
import tempfile
import shutil
import subprocess
from itertools import cycle
from datetime import datetime

simulators = cycle(["nest", "neuron"])

examples = (
    # "HH_cond_exp2.py",
    "Izhikevich.py",
    "current_injection.py",
    # "VAbenchmarks.py",
    # "brunel.py",
    "cell_type_demonstration.py",
    # "connections.py",
    # "distrib_example.py",
    # "inhomogeneous_network.py",
    # "nineml_neuron.py",
    # "parameter_changes.py",
    "random_numbers.py",
    "random_distributions.py",
    # "simpleRandomNetwork.py",
    # "simpleRandomNetwork_csa.py",
    "simple_STDP.py",
    "small_network.py",
    # "specific_network.py",
    # "stdp_network.py",
    "synaptic_input.py",
    "tsodyksmarkram.py",
    "varying_poisson.py",
    "stochastic_synapses.py",
    "stochastic_deterministic_comparison.py"
)

# todo: add line numbering to code examples

template = """{title}
{underline}

.. image:: ../images/examples/{img_file}

.. literalinclude:: ../../examples/{example}

"""

example_index = """========
Examples
========

.. toctree::
   :maxdepth: 2

"""

image_dir = "images/examples"
examples_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), os.path.pardir, "examples")
tmp_dir = tempfile.mkdtemp()
results_dir = os.path.join(tmp_dir, "Results")

for dir_name in (image_dir, results_dir):
    if not os.path.exists(dir_name):
        os.makedirs(dir_name)


def run(python_script, simulator, *extra_args):
    files_initial = list_files(".png")
    args = " ".join(extra_args)
    p = subprocess.Popen("python %s/%s --plot-figure %s %s" % (examples_dir, python_script, simulator, args),
                         shell=True, cwd=tmp_dir)
    p.wait()
    new_files = list_files(".png").difference(files_initial)
    return new_files


def get_title(python_script):
    with open(os.path.join(examples_dir, python_script), "r") as fp:
        while True:
            line = fp.readline()
            if line[:3] == '"""':
                title = fp.readline().strip().strip(".")
                break
    return title


def list_files(filter):
    return set([os.path.join(x[0], filename)
                for x in os.walk(results_dir)
                for filename in x[2]
                if filter in filename])


print("Running examples in {}".format(tmp_dir))
for example in examples:
    new_files = run(example, next(simulators))
    if len(new_files) > 1:
        raise Exception("Multiple image files")
    img_path, = new_files
    shutil.copy(img_path, image_dir)
    img_file = os.path.basename(img_path)
    title = get_title(example)
    underline = "=" * len(title)
    with open(os.path.join("examples", example.replace(".py", ".txt")), "w") as fp:
        fp.write(template.format(**locals()))
    example_index += "   examples/{}\n".format(example.replace(".py", ""))

# handle VAbenchmarks separately
example = "VAbenchmarks.py"
cell_type = "CUBA"
files_initial = list_files("VAbenchmarks")
run(example, "nest", cell_type)
run(example, "neuron", cell_type)
new_files = list_files("VAbenchmarks").difference(files_initial)
files_initial = list_files(".png")
timestamp = datetime.now().strftime("%Y%m%d-%H%M%S")
p = subprocess.Popen("python %s/tools/VAbenchmark_graphs.py -o Results/VAbenchmarks_%s_%s.png %s" % (
    examples_dir, cell_type, timestamp, " ".join(new_files)),
    shell=True, cwd=tmp_dir)
p.wait()
img_path, = list_files(".png").difference(files_initial)
shutil.copy(img_path, image_dir)
img_file = os.path.basename(img_path)
title = get_title(example)
underline = "=" * len(title)
with open(os.path.join("examples", example.replace(".py", ".txt")), "w") as fp:
    fp.write(template.format(**locals()))
example_index += "   examples/{}\n".format(example.replace(".py", ""))

with open("examples.txt", "w") as fp:
    fp.write(example_index)

shutil.rmtree(tmp_dir)