System Functions
clear_dir(path)
#
Deletes all files and subdirectories in the specified folder.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
Path to the folder to clear. |
required |
Source code in src/CompNeuroPy/system_functions.py
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 |
|
create_dir(path, print_info=False, clear=False)
#
Creates a directory.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
Path to the directory to create. |
required |
print_info |
bool
|
Whether to print information about the directory creation. Default: False. |
False
|
clear |
bool
|
Whether to clear the directory if it already exists. Default: False. |
False
|
Source code in src/CompNeuroPy/system_functions.py
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 |
|
save_variables(variable_list, name_list, path='./')
#
Parameters:
Name | Type | Description | Default |
---|---|---|---|
variable_list |
list
|
variables to save |
required |
name_list |
list
|
names of the save files of the variables |
required |
path |
str or list
|
save path for all variables, or save path for each variable of the variable_list. Default: "./" |
'./'
|
Examples:
import numpy as np
from CompNeuroPy import save_variables, load_variables
### create variables
var1 = np.random.rand(10)
var2 = np.random.rand(10)
### save variables
save_variables([var1, var2], ["var1_file", "var2_file"], "my_variables_folder")
### load variables
loaded_variables = load_variables(["var1", "var2"], "my_variables_folder")
### use loaded variables
print(loaded_variables["var1_file"])
print(loaded_variables["var2_file"])
Source code in src/CompNeuroPy/system_functions.py
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 |
|
load_variables(name_list, path='./')
#
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name_list |
list
|
names of the save files of the variables |
required |
path |
str or list
|
save path for all variables, or save path for each variable of the variable_list. Default: "./" |
'./'
|
Returns:
Name | Type | Description |
---|---|---|
variable_dict |
dict
|
dictionary with the loaded variables, keys are the names of the files, values are the loaded variables |
Examples:
import numpy as np
from CompNeuroPy import save_variables, load_variables
### create variables
var1 = np.random.rand(10)
var2 = np.random.rand(10)
### save variables
save_variables([var1, var2], ["var1_file", "var2_file"], "my_variables_folder")
### load variables
loaded_variables = load_variables(["var1", "var2"], "my_variables_folder")
### use loaded variables
print(loaded_variables["var1_file"])
print(loaded_variables["var2_file"])
Source code in src/CompNeuroPy/system_functions.py
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
|
timing_decorator(threshold=0.1)
#
Decorator to measure the execution time of a function.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
threshold |
float
|
Threshold in seconds. If the execution time of the function is larger than this threshold, the execution time is printed. Default: 0.1. |
0.1
|
Source code in src/CompNeuroPy/system_functions.py
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
|