Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
ecalc run",id:"ecalc-run",level:2},{value:"ecalc selftest",id:"ecalc-selftest",level:2},{value:"ecalc show",id:"ecalc-show",level:2},{value:"ecalc show results",id:"ecalc-show-results",level:3},{value:"ecalc show yaml",id:"ecalc-show-yaml",level:3}];function a(e){const s={code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(s.h1,{id:"ecalc",children:(0,l.jsx)(s.code,{children:"ecalc"})}),"\n",(0,l.jsx)(s.p,{children:"Args: log_level: Log level of the CLI logger, defaults to INFO log_folder: Path to location of log files version: Option to show libecalc version."}),"\n",(0,l.jsx)(s.p,{children:"Returns:"}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Usage"}),":"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{className:"language-console",children:"$ ecalc [OPTIONS] COMMAND [ARGS]...\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Options"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--log [CRITICAL|FATAL|ERROR|WARNING|INFO|DEBUG|NOTSET]"}),": Set the loglevel. [default: INFO]"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--log-folder PATH"}),": Store log files in a folder"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--version"}),": Show current eCalc\u2122 version."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--install-completion"}),": Install completion for the current shell."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--show-completion"}),": Show completion for the current shell, to copy it or customize the installation."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--help"}),": Show this message and exit."]}),"\n"]}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Commands"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:(0,l.jsx)(s.code,{children:"run"})}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"selftest"}),": Test that eCalc has been successfully..."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"show"}),": Command to show information in the model..."]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"ecalc-run",children:(0,l.jsx)(s.code,{children:"ecalc run"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Usage"}),":"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{className:"language-console",children:"$ ecalc run [OPTIONS] MODEL_FILE\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Arguments"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"MODEL_FILE"}),": The Model YAML-file specifying time series inputs, facility inputs and the relationship between energy consumers. [required]"]}),"\n"]}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Options"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"-f, --output-frequency, --outputfrequency [NONE|YEAR|MONTH|DAY]"}),": Frequency of output. Options are DAY, MONTH, YEAR. If not specified, it will give time steps equal to the union of all input given with INFLUENCE_TIME_VECTOR set to True. Down-sampling the result may lead to loss of data, and rates such as MW may not add up to cumulative values [default: NONE]"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"-c, --csv"}),": Toggle output of csv data. [default: True]"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--json"}),": Toggle output of json output."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"-o, --output-folder, --outputfolder PATH"}),": Outputfolder. Defaults to output/ relative to the yml setup file"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"-n, --name-prefix, --nameprefix TEXT"}),": Name prefix for output data. Defaults to name of setup file."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--ltp-export"}),": In addition to standard output, a specific Long Term Prognosis (LTP) file will be provided for simple export of LTP relevant data (Tabular Separated Values)."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--stp-export"}),": In addition to standard output, a specific Short Term Prognosis (STP) file will be provided for simple export of STP relevant data (Tabular Separated Values)."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--flow-diagram"}),": Output the input model formatted to be displayed in a custom flow diagram format in JSON"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--detailed-output, --detailedoutput"}),": Output detailed output. When False you will get basic results such as energy usage, power, time vector."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--date-format-option [0|1|2]"}),': Date format option. 0: "YYYY-MM-DD HH:MM',":SS",'" (Accepted variant of ISO8601), 1: "YYYYMMDD HH:MM',":SS",'" (ISO8601), 2: "DD.MM.YYYY HH:MM',":SS",'". Default 0 (ISO 8601) [default: 0]']}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--help"}),": Show this message and exit."]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"ecalc-selftest",children:(0,l.jsx)(s.code,{children:"ecalc selftest"})}),"\n",(0,l.jsx)(s.p,{children:"Test that eCalc has been successfully installed"}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Usage"}),":"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{className:"language-console",children:"$ ecalc selftest [OPTIONS]\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Options"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--help"}),": Show this message and exit."]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"ecalc-show",children:(0,l.jsx)(s.code,{children:"ecalc show"})}),"\n",(0,l.jsx)(s.p,{children:"Command to show information in the model or results."}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Usage"}),":"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{className:"language-console",children:"$ ecalc show [OPTIONS] COMMAND [ARGS]...\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Options"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--help"}),": Show this message and exit."]}),"\n"]}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Commands"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"results"}),": Show results."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"yaml"}),": Show yaml model."]}),"\n"]}),"\n",(0,l.jsx)(s.h3,{id:"ecalc-show-results",children:(0,l.jsx)(s.code,{children:"ecalc show results"})}),"\n",(0,l.jsx)(s.p,{children:"Show results. You need to run eCalc\u2122 before this will be available."}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Usage"}),":"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{className:"language-console",children:"$ ecalc show results [OPTIONS]\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Options"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"-n, --name TEXT"}),": Filter the results to only show the component with this name"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--output-format [csv|json]"}),": Show the data in this format. [default: json]"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--file PATH"}),": Write the data to a file with the specified name."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--output-folder PATH"}),": Output folder. Defaults to current working directory"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--detailed-output"}),": Output detailed output. When False you will get basic energy usage and emissions results"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--date-format-option [0|1|2]"}),': Date format option. 0: "YYYY-MM-DD HH:MM',":SS",'" (Accepted variant of ISO8601), 1: "YYYYMMDD HH:MM',":SS",'" (ISO8601), 2: "DD.MM.YYYY HH:MM',":SS",'". Default 0 (ISO 8601) [default: 0]']}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"-f, --output-frequency [NONE|YEAR|MONTH|DAY]"}),": Frequency of output. Options are DAY, MONTH, YEAR. If not specified, it will give time steps equal to the union of all input given with INFLUENCE_TIME_VECTOR set to True. Down-sampling the result may lead to loss of data, and rates such as MW may not add up to cumulative values [default: NONE]"]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--help"}),": Show this message and exit."]}),"\n"]}),"\n",(0,l.jsx)(s.h3,{id:"ecalc-show-yaml",children:(0,l.jsx)(s.code,{children:"ecalc show yaml"})}),"\n",(0,l.jsx)(s.p,{children:"Show yaml model. This will show the yaml after processing !include."}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Usage"}),":"]}),"\n",(0,l.jsx)(s.pre,{children:(0,l.jsx)(s.code,{className:"language-console",children:"$ ecalc show yaml [OPTIONS] MODEL_FILE\n"})}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Arguments"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"MODEL_FILE"}),": YAML file specifying time series inputs, facility inputs and the relationship between energy consumers. [required]"]}),"\n"]}),"\n",(0,l.jsxs)(s.p,{children:[(0,l.jsx)(s.strong,{children:"Options"}),":"]}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--file PATH"}),": Write the data to a file with the specified name."]}),"\n",(0,l.jsxs)(s.li,{children:[(0,l.jsx)(s.code,{children:"--help"}),": Show this message and exit."]}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},28453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var l=n(96540);const t={},i=l.createContext(t);function c(e){const s=l.useContext(i);return l.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),l.createElement(i.Provider,{value:s},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/1169.f5af047e.js b/assets/js/1169.f5af047e.js
new file mode 100644
index 0000000000..36f32d8037
--- /dev/null
+++ b/assets/js/1169.f5af047e.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocumentation=self.webpackChunkdocumentation||[]).push([[1169],{73046:(t,e,n)=>{n.d(e,{T:()=>k});var r=n(48585),o=n(39142),i=n(89610),s=n(27422),u=n(11662),c=n(66401),a=n(8058),f=n(69592),h=n(13588),A=n(24326),d=n(62062),l=n(25707);const v=function(t){return t!=t};const b=function(t,e,n){for(var r=n-1,o=t.length;++r