loadshape/manifest.json at main · openfido/loadshape · GitHub

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
{
  "name" : "Loadshape analysis",
  "description" : "Loadshape analysis pipeline",
  "docker" : "debian:11",
  "git" : "https://github.com/openfido/loadshape.git",
  "branch" : "main",
  "script" : "openfido.sh",
  "manual" : {
    "config" : "csv"
  },
  "config" : {

    "Input" : { "input_type" : "title" },
    "INPUT_CSV" : {
      "prompt" : "AMI data file",
      "description" : "Data file as CSV (compressed ok).",
      "default" : "",
      "input_type" : "upload required"
    },

    "CSV format" : { "input_type" : "title" },
    "DATETIME_COLUMN" :
    {
      "prompt" : "Date/time column(s)",
      "description" : "Column number(s) for date/time values. If time column is separate from date column use comma to the column numbers.",
      "default" : "timestamp",
      "input_type" : "str required"
    },
    "ID_COLUMN" :
    {
      "prompt" : "Meter ID column",
      "description" : "Column number for the meter ID",
      "default" : "meter_id",
      "input_type" : "str required"
    },
    "DATA_COLUMN" :
    {
      "prompt" : "Value column",
      "description" : "Column number for meter values.",
      "default" : "power",
      "input_type" : "str required"
    },
    "TIMEZONE_COLUMN" :
    {
      "prompt" : "Timezone column",
      "description" : "Column number for timezone offsets.",
      "default" : "timezone",
      "input_type" : "str required"
    },
    "DATETIME_FORMAT" :
    {
      "prompt" : "Date/time format",
      "description" : "Format of date/time values. Uses strftime specification.",
      "default" : "%Y-%m-%d %H:%M:%S",
      "input_type" : "str required"
    },

    "Analysis" : { "input_type" : "title" },
    "GROUP_COUNT" : {
      "prompt" : "Group count",
      "description" : "The number of loadshapes to generate (must be positive).",
      "default" : "4",
      "input_type" : "int required"
    },

    "Output" : { "input_type" : "title" },
    "LOADSHAPES_CSV" : {
      "prompt" : "Output loadshape CSV filename",
      "description" : "The CSV file name in which loadshape data is output.",
      "default" : "loadshapes.csv",
      "input_type" : "str"
    },

    "Plots" : { "input_type" : "title" },
    "OUTPUT_PNG" : {
      "prompt" : "Plot filename",
      "description" : "Output PNG plot file name",
      "default" : "loadshapes.png",
      "input_type" : "str"
    },

    "GridLAB-D" : { "input_type" : "title" },
    "LOADS_CSV" : {
      "prompt" : "Load map input CSV",
      "description" : "The CSV input file containing the load mapping to meter objects.",
      "default" : "",
      "input_type" : "upload"
    },
    "CLOCK_GLM" : {
      "prompt" : "GLM clock output",
      "description" : "The GLM file to which the GridLAB-D clock is output.",
      "default" : "clock.glm",
      "input_type" : "str"
    },
    "LOADS_GLM" : {
      "prompt" : "GLM loads output",
      "description" : "The CSV file name in which loadshape data is output (requires load map input CSV).",
      "default" : "loads.glm",
      "input_type" : "str"
    },
    "SCHEDULES_GLM" : {
      "prompt" : "GLM schedules",
      "description" : "The GLM file name in which loadshape schedule data is output.",
      "default" : "loadshapes.glm",
      "input_type" : "str"
    },
    "LOAD_SCALE" : {
      "prompt" : "Load scale",
      "description" : "Scaling of schedule load data",
      "default" : "1000.0",
      "input_type" : "float required"
    },

    "Options" : { "input_type" : "title" },
    "VERBOSE" : {
      "prompt" : "Enable verbose output",
      "description" : "Enable verbose output during processing",
      "default" : "false",
      "input_type" : "boolean"
    },
    "DEBUG" : {
      "prompt" : "Enable debug output",
      "description" : "Enable debugging output during processing",
      "default" : "false",
      "input_type" : "boolean"
    }
  }
}