adiciona exemplos

deploy-requirements.txt

@@ -7,6 +7,7 @@ mypy
 sphinx
 sphinx-gallery
 sphinx-rtd-theme
+plotly
 nb2plots
 numpydoc
 black

docs/_downloads/1f37a59d7c085be6c7e11dfa594dbc69/plot_dadger.ipynb

@@ -0,0 +1,97 @@
+{
+  "cells": [
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "%matplotlib inline"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "\n# dadger.rv0\n"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "O primeiro passo para realizar o processamento do arquivo, assim como os\ndemais arquivos de sa\u00edda, \u00e9 a leitura. A fun\u00e7\u00e3o de leitura recebe dois argumentos,\nsendo que o segundo \u00e9 opcional.\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "from idecomp.decomp import Dadger\n\narq = Dadger.le_arquivo(\".\", nome_arquivo=\"dadger.rv0\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "O dadger, sendo um arquivo que se organiza por meio da declara\u00e7\u00e3o de registros, n\u00e3o\npossui, atualmente, uma interface que seja tabular. Desta forma, os m\u00e9todos existentes\nretornam nenhum, um ou uma lista de objetos do registro espec\u00edfico solicitado.\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "termicas_semana1 = arq.ct(estagio=1)\nprint(len(termicas_semana1))"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Mesmo sem uma interface expl\u00edcita para dados tabulares, os registros foram constru\u00eddos\ncom o uso de propriedades que devem facilitar o p\u00f3s-processamento pelo usu\u00e1rio. Por exemplo,\npara gerar um gr\u00e1fico comparativo de GT em rela\u00e7\u00e3o ao CVU:\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "import plotly.express as px\nimport pandas as pd\n\ngtmin_pat1 = [t.inflexibilidades[0] for t in termicas_semana1]\ngtmax_pat1 = [t.disponibilidades[0] for t in termicas_semana1]\ncvus_pat1 = [t.cvus[0] for t in termicas_semana1]\ndf = pd.DataFrame(data={\"cvu\": cvus_pat1, \"gt\": gtmax_pat1})\ndf.sort_values(\"cvu\", inplace=True)\ndf[\"gt\"] = df[\"gt\"].cumsum()\ndf[\"gt\"] += sum(gtmin_pat1)\n\n# sphinx_gallery_thumbnail_number = 1\nfig = px.line(\n    df,\n    x=\"gt\",\n    y=\"cvu\",\n    line_shape=\"hv\",\n)\nfig"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": "Python 3",
+      "language": "python",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.10.9"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}

docs/_downloads/73317648e2f861c796990479e47c9b44/plot_dec_oper_sist.ipynb

@@ -0,0 +1,97 @@
+{
+  "cells": [
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "%matplotlib inline"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "\n# dec_oper_sist.csv\n"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "O primeiro passo para realizar o processamento do arquivo, assim como os\ndemais arquivos .csv, \u00e9 a leitura. A fun\u00e7\u00e3o de leitura recebe dois argumentos,\nsendo que o segundo \u00e9 opcional. Tendo lido o arquivo, \u00e9 poss\u00edvel recuperar\na vers\u00e3o em que o modelo foi executado.\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "from idecomp.decomp import DecOperSist\n\narq = DecOperSist.le_arquivo(\".\")\nprint(arq.versao)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "A tabela de informa\u00e7\u00f5es \u00e9 fornecida como um dataframe, onde os nomes das colunas geralmente\nremetem aos nomes originais das colunas do arquivo .csv, por\u00e9m em camelCase.\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "df = arq.tabela\nprint(df.columns)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "A partir deste dataframe \u00e9 poss\u00edvel realizar an\u00e1lises e produzir visualiza\u00e7\u00f5es. Por exemplo,\nutilizando o m\u00f3dulo plotly. Deste ponto em diante, n\u00e3o \u00e9 mais necess\u00e1rio o conhecimento\nespec\u00edfico do arquivo ou da idecomp.\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "import plotly.express as px\n\nestagio_mensal = df[\"periodo\"].max()\n# sphinx_gallery_thumbnail_number = 1\nfig = px.box(\n    df.loc[df[\"periodo\"] == estagio_mensal],\n    x=\"nomeSubmercado\",\n    y=\"geracaoTermicaMW\",\n)\nfig"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": "Python 3",
+      "language": "python",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.10.9"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}

docs/_downloads/819934491034f27e0bec3d451fbbaff0/plot_dec_oper_sist.py

@@ -0,0 +1,38 @@
+"""
+========================================
+dec_oper_sist.csv
+========================================
+"""
+
+#%%
+# O primeiro passo para realizar o processamento do arquivo, assim como os
+# demais arquivos .csv, é a leitura. A função de leitura recebe dois argumentos,
+# sendo que o segundo é opcional. Tendo lido o arquivo, é possível recuperar
+# a versão em que o modelo foi executado.
+from idecomp.decomp import DecOperSist
+
+arq = DecOperSist.le_arquivo(".")
+print(arq.versao)
+
+
+#%%
+# A tabela de informações é fornecida como um dataframe, onde os nomes das colunas geralmente
+# remetem aos nomes originais das colunas do arquivo .csv, porém em camelCase.
+df = arq.tabela
+print(df.columns)
+
+
+#%%
+# A partir deste dataframe é possível realizar análises e produzir visualizações. Por exemplo,
+# utilizando o módulo plotly. Deste ponto em diante, não é mais necessário o conhecimento
+# específico do arquivo ou da idecomp.
+import plotly.express as px
+
+estagio_mensal = df["periodo"].max()
+# sphinx_gallery_thumbnail_number = 1
+fig = px.box(
+    df.loc[df["periodo"] == estagio_mensal],
+    x="nomeSubmercado",
+    y="geracaoTermicaMW",
+)
+fig

docs/_downloads/a15c335c7dbe0023444e9b583ccb29b5/plot_vazoes.py

@@ -0,0 +1,32 @@
+"""
+========================================
+vazoes.dat
+========================================
+"""
+
+#%%
+# O primeiro passo para realizar o processamento do arquivo, assim como os
+# demais arquivos de saída, é a leitura. A função de leitura recebe dois argumentos,
+# sendo que o segundo é opcional.
+from idecomp.decomp import Vazoes
+
+arq = Vazoes.le_arquivo(".", nome_arquivo="vazoes.rv0")
+
+
+#%%
+# O arquivo de vazões contém informações do histórico de vazões por posto de medição, servindo
+# de entrada para os modelos de planejamento.
+df = arq.vazoes
+print(df)
+
+
+#%%
+# A partir deste dataframe é possível realizar análises e produzir visualizações. Por exemplo,
+# utilizando o módulo plotly. Deste ponto em diante, não é mais necessário o conhecimento
+# específico do arquivo ou da idecomp.
+import plotly.graph_objects as go
+
+# sphinx_gallery_thumbnail_number = 1
+fig = go.Figure()
+fig.add_trace(go.Scatter(x=df.index, y=[df["66"]], name="Vazao Posto 66"))
+fig

docs/_downloads/af4b9700711aa61c2d1ffb85e634f20b/plot_relato.py

@@ -0,0 +1,32 @@
+"""
+========================================
+relato.rv0
+========================================
+"""
+
+#%%
+# O primeiro passo para realizar o processamento do arquivo, assim como os
+# demais arquivos de saída, é a leitura. A função de leitura recebe dois argumentos,
+# sendo que o segundo é opcional.
+from idecomp.decomp import Relato
+
+arq = Relato.le_arquivo(".", nome_arquivo="relato.rv0")
+
+
+#%%
+# Existem diversas propriedades, uma para cada tipo de dados do Relato, e que estão disponíveis
+# em datalhes na seção de Referência. Uma destas é o balanco da operação energética. Assim como
+# a maioria das propriedades que são tabulares, esta é processada na forma de um dataframe para o usuário.
+df = arq.balanco_energetico
+print(df.columns)
+
+
+#%%
+# A partir deste dataframe é possível realizar análises e produzir visualizações. Por exemplo,
+# utilizando o módulo plotly. Deste ponto em diante, não é mais necessário o conhecimento
+# específico do arquivo ou da idecomp.
+import plotly.express as px
+
+# sphinx_gallery_thumbnail_number = 1
+fig = px.line(df, x="Estágio", y="Earm Final Percentual", color="Subsistema")
+fig