inewave 1.7.3__tar.gz → 1.7.5__tar.gz

inewave-1.7.5/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.1
+Name: inewave
+Version: 1.7.5
+Summary: Interface para arquivos do NEWAVE
+Home-page: https://github.com/rjmalves/inewave
+Author: Rogerio Alves
+Author-email: rogerioalves.ee@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: cfinterface>=1.6.0
+
+# inewave
+
+![tests](https://github.com/rjmalves/inewave/workflows/tests/badge.svg)  
+[![codecov](https://codecov.io/gh/rjmalves/inewave/branch/main/graph/badge.svg?token=R9WPQHQGKF)](https://codecov.io/gh/rjmalves/inewave)
+
+O `inewave` é um pacote Python para manipulação dos arquivos de entrada e saída do programa [NEWAVE](http://www.cepel.br/pt_br/produtos/newave-modelo-de-planejamento-da-operacao-de-sistemas-hidrotermicos-interligados-de-longo-e-medio-prazo.htm). O NEWAVE é desenvolvido pelo [CEPEL](http://www.cepel.br) e utilizado para os estudos de planejamento e operação do Sistema Interligado Nacional (SIN).
+
+O inewave oferece:
+
+- Meios para leitura dos arquivos de entrada e saída do NEWAVE e programas associados: NWLISTCF e NWLISTOP
+
+- Facilidades para estudo e análise dos dados utilizando DataFrames do pandas
+
+- Dados estruturados em modelos com o uso do paradigma de orientação a objetos (OOP)
+
+
+## Instalação
+
+O inewave é compatível com versões de Python >= 3.8.
+
+É possível instalar a versão distribuída oficialmente com pip:
+
+```
+python -m pip install inewave
+```
+
+É possível realizar a instalação da versão de desenvolvimento fazendo o uso do Git.
+
+```
+pip install git+https://github.com/rjmalves/inewave
+```
+
+## Documentação
+
+Guias, tutoriais e as referências podem ser encontrados no site oficial do pacote: https://rjmalves.github.io/inewave

inewave-1.7.5/inewave/__init__.py

@@ -0,0 +1,13 @@
+"""
+inewave
+=======
+
+inewave é um módulo em Python para manipulação dos arquivos de entrada
+e saída do NEWAVE.
+"""
+
+__version__ = "1.7.5"
+
+from . import newave  # noqa
+from . import nwlistcf  # noqa
+from . import nwlistop  # noqa

inewave-1.7.5/inewave/newave/modelos/adterm.py

@@ -0,0 +1,150 @@
+from inewave.config import MAX_LAG_ADTERM, MAX_UTES
+
+from cfinterface.components.section import Section
+from cfinterface.components.line import Line
+from cfinterface.components.integerfield import IntegerField
+from cfinterface.components.literalfield import LiteralField
+from cfinterface.components.floatfield import FloatField
+from typing import List, IO
+import numpy as np  # type: ignore
+import pandas as pd  # type: ignore
+from inewave._utils.formatacao import (
+    repete_vetor,
+)
+
+
+class BlocoUTEAdTerm(Section):
+    """
+    Bloco com os despachos antecipados das UTEs por patamar.
+    """
+
+    __slots__ = [
+        "__linha_ute",
+        "__linha_despachos",
+        "__cabecalhos",
+        "__numero_patamares",
+    ]
+
+    FIM_BLOCO = " 9999"
+
+    def __init__(self, previous=None, next=None, data=None) -> None:
+        super().__init__(previous, next, data)
+        self.__linha_ute = Line(
+            [IntegerField(4, 1), LiteralField(12, 7), IntegerField(1, 21)]
+        )
+        self.__linha_despachos = Line([])
+        self.__cabecalhos: List[str] = []
+
+    def __eq__(self, o: object) -> bool:
+        if not isinstance(o, BlocoUTEAdTerm):
+            return False
+        bloco: BlocoUTEAdTerm = o
+        if not all(
+            [
+                isinstance(self.data, pd.DataFrame),
+                isinstance(o.data, pd.DataFrame),
+            ]
+        ):
+            return False
+        else:
+            return self.data.equals(bloco.data)
+
+    # Override
+    def read(self, file: IO, numero_patamares: int = 3, *args, **kwargs):
+        def converte_tabela_em_df():
+            df = pd.DataFrame(
+                data={
+                    "codigo_usina": repete_vetor(
+                        codigo_utes, self.__numero_patamares
+                    ),
+                    "nome_usina": repete_vetor(
+                        nome_utes, self.__numero_patamares
+                    ),
+                    "lag": repete_vetor(lag_utes, self.__numero_patamares),
+                    "patamar": np.tile(
+                        np.arange(1, self.__numero_patamares + 1),
+                        len(codigo_utes),
+                    ),
+                    "valor": tabela.flatten(),
+                }
+            )
+            return df
+
+        # Salta as linhas adicionais
+        for _ in range(2):
+            self.__cabecalhos.append(file.readline())
+
+        self.__numero_patamares = numero_patamares
+        self.__linha_despachos = Line(
+            [
+                FloatField(12, 22 + 12 * i, 2)
+                for i in range(self.__numero_patamares)
+            ]
+        )
+
+        # Variáveis auxiliares
+        codigo_utes: List[int] = []
+        nome_utes: List[str] = []
+        lag_utes: List[int] = []
+        codigo_atual = 0
+        nome_atual = ""
+        lag_atual = 0
+        tabela = np.zeros((MAX_UTES * MAX_LAG_ADTERM, self.__numero_patamares))
+        i = 0
+        while True:
+            linha = file.readline()
+            # Confere se acabou
+            if len(linha) < 3:
+                break
+            if BlocoUTEAdTerm.FIM_BLOCO in linha:
+                tabela = tabela[:i, :]
+                self.data = converte_tabela_em_df()
+                break
+            # Senão, confere se é uma linha de UTE ou despacho
+            if len(linha[:5].strip()) > 0:
+                codigo_atual, nome_atual, lag_atual = self.__linha_ute.read(
+                    linha
+                )
+                lag_atual = 0
+            else:
+                lag_atual += 1
+                tabela[i, :] = self.__linha_despachos.read(linha)
+                codigo_utes.append(codigo_atual)
+                nome_utes.append(nome_atual)
+                lag_utes.append(lag_atual)
+                i += 1
+
+    # Override
+    def write(self, file: IO, *args, **kwargs):
+        for linha in self.__cabecalhos:
+            file.write(linha)
+        if not isinstance(self.data, pd.DataFrame):
+            raise ValueError("Dados do adterm.dat não foram lidos com sucesso")
+        df = self.data.copy()
+        ultima_ute = 0
+        for _, linha_usina in (
+            self.data[["codigo_usina", "lag"]].drop_duplicates().iterrows()
+        ):
+            df_lag = df.loc[
+                (df["codigo_usina"] == linha_usina["codigo_usina"])
+                & (df["lag"] == linha_usina["lag"])
+            ]
+            if df_lag["codigo_usina"].iloc[0] != ultima_ute:
+                ultima_ute = df_lag["codigo_usina"].iloc[0]
+                max_lag_usina = df.loc[
+                    df["codigo_usina"] == ultima_ute, "lag"
+                ].max()
+                file.write(
+                    self.__linha_ute.write(
+                        df_lag[["codigo_usina", "nome_usina"]]
+                        .iloc[0, :]
+                        .tolist()
+                        + [max_lag_usina]
+                    )
+                )
+            file.write(
+                self.__linha_despachos.write(
+                    df_lag.sort_values("patamar")["valor"].tolist()
+                )
+            )
+        file.write(BlocoUTEAdTerm.FIM_BLOCO + "\n")

inewave-1.7.5/inewave/newave/modelos/agrint.py

@@ -0,0 +1,234 @@
+from inewave.config import (
+    MAX_AGRUPAMENTOS_INTERCAMBIOS,
+    MAX_SUBMERCADOS,
+    MAX_MESES_ESTUDO,
+)
+
+from cfinterface.components.section import Section
+from cfinterface.components.line import Line
+from cfinterface.components.literalfield import LiteralField
+from cfinterface.components.integerfield import IntegerField
+from cfinterface.components.datetimefield import DatetimeField
+from cfinterface.components.floatfield import FloatField
+from typing import List, IO
+from datetime import datetime
+import pandas as pd  # type: ignore
+import numpy as np  # type: ignore
+from inewave._utils.formatacao import (
+    repete_vetor,
+)
+
+
+class BlocoGruposAgrint(Section):
+    """
+    Bloco com informações dos intercâmbios pertencentes aos
+    grupos.
+    """
+
+    __slots__ = ["__linha", "__cabecalhos"]
+
+    FIM_BLOCO = " 999"
+
+    def __init__(self, previous=None, next=None, data=None) -> None:
+        super().__init__(previous, next, data)
+        self.__linha = Line(
+            [
+                IntegerField(3, 1),
+                IntegerField(3, 5),
+                IntegerField(3, 9),
+                FloatField(7, 13, 4),
+            ]
+        )
+        self.__cabecalhos: List[str] = []
+
+    def __eq__(self, o: object) -> bool:
+        if not isinstance(o, BlocoGruposAgrint):
+            return False
+        bloco: BlocoGruposAgrint = o
+        if not all(
+            [
+                isinstance(self.data, pd.DataFrame),
+                isinstance(o.data, pd.DataFrame),
+            ]
+        ):
+            return False
+        else:
+            return self.data.equals(bloco.data)
+
+    # Override
+    def read(self, file: IO, *args, **kwargs):
+        def converte_tabela_em_df():
+            cols = [
+                "agrupamento",
+                "submercado_de",
+                "submercado_para",
+                "coeficiente",
+            ]
+            df = pd.DataFrame(tabela, columns=cols)
+            df = df.astype(
+                {
+                    "agrupamento": "int64",
+                    "submercado_de": "int64",
+                    "submercado_para": "int64",
+                }
+            )
+            return df
+
+        # Salta as linhas adicionais
+        for _ in range(3):
+            self.__cabecalhos.append(file.readline())
+
+        i = 0
+        tabela = np.zeros((MAX_AGRUPAMENTOS_INTERCAMBIOS * MAX_SUBMERCADOS, 4))
+        while True:
+            linha = file.readline()
+            # Confere se terminaram
+            if len(linha) < 3 or BlocoGruposAgrint.FIM_BLOCO in linha[:4]:
+                # Converte para df e salva na variável
+                if i > 0:
+                    tabela = tabela[:i, :]
+                    self.data = converte_tabela_em_df()
+                break
+            # Confere se é uma linha de subsistema ou tabela
+            else:
+                dados = self.__linha.read(linha)
+                tabela[i, :] = dados
+                i += 1
+
+    # Override
+    def write(self, file: IO, *args, **kwargs):
+        for linha in self.__cabecalhos:
+            file.write(linha)
+        if not isinstance(self.data, pd.DataFrame):
+            raise ValueError("Dados do agrint.dat não foram lidos com sucesso")
+
+        for _, linha in self.data.iterrows():
+            linha_escrita = []
+            for v in linha:
+                linha_escrita.append(None if np.isnan(v) else int(v))
+            file.write(self.__linha.write(linha_escrita))
+        file.write(BlocoGruposAgrint.FIM_BLOCO + "\n")
+
+
+class BlocoLimitesPorGrupoAgrint(Section):
+    """
+    Bloco com informações de configuração dos limites dos agrupamentos
+    de intercâmbio por período de estudo.
+    """
+
+    FIM_BLOCO = " 999"
+
+    def __init__(self, previous=None, next=None, data=None) -> None:
+        super().__init__(previous, next, data)
+        self.__linha = Line(
+            [
+                IntegerField(3, 1),
+                DatetimeField(7, 6, format="%m %Y"),
+                DatetimeField(7, 14, format="%m %Y"),
+                FloatField(7, 22, 0),
+                FloatField(7, 30, 0),
+                FloatField(7, 38, 0),
+                LiteralField(40, 50),
+            ]
+        )
+        self.__cabecalhos: List[str] = []
+
+    def __eq__(self, o: object) -> bool:
+        if not isinstance(o, BlocoLimitesPorGrupoAgrint):
+            return False
+        bloco: BlocoLimitesPorGrupoAgrint = o
+        if not all(
+            [
+                isinstance(self.data, pd.DataFrame),
+                isinstance(o.data, pd.DataFrame),
+            ]
+        ):
+            return False
+        else:
+            return self.data.equals(bloco.data)
+
+    # Override
+    def read(self, file: IO, *args, **kwargs):
+        def converte_tabela_em_df():
+            df = pd.DataFrame(
+                data={
+                    "agrupamento": repete_vetor(agrupamentos, 3),
+                    "data_inicio": repete_vetor(datas_inicio, 3),
+                    "data_fim": repete_vetor(datas_fim, 3),
+                    "comentario": repete_vetor(comentarios, 3),
+                    "patamar": np.tile(
+                        np.arange(1, 3 + 1),
+                        len(agrupamentos),
+                    ),
+                    "valor": tabela.flatten(),
+                }
+            )
+            return df
+
+        # Salta as linhas adicionais
+        for _ in range(3):
+            self.__cabecalhos.append(file.readline())
+
+        i = 0
+        agrupamentos: List[int] = []
+        datas_inicio: List[datetime] = []
+        datas_fim: List[datetime] = []
+        comentarios: List[str] = []
+        tabela = np.zeros(
+            (MAX_AGRUPAMENTOS_INTERCAMBIOS * MAX_MESES_ESTUDO, 3)
+        )
+        while True:
+            linha = file.readline()
+            # Confere se terminaram
+            if len(linha) < 3 or BlocoGruposAgrint.FIM_BLOCO in linha[:4]:
+                # Converte para df e salva na variável
+                if i > 0:
+                    tabela = tabela[:i, :]
+                    self.data = converte_tabela_em_df()
+                break
+            # Confere se é uma linha de subsistema ou tabela
+            else:
+                dados = self.__linha.read(linha)
+                agrupamentos.append(dados[0])
+                tabela[i, :] = dados[3:6]
+                datas_inicio.append(dados[1])
+                datas_fim.append(dados[2])
+                comentarios.append(dados[-1])
+                i += 1
+
+    # Override
+    def write(self, file: IO, *args, **kwargs):
+        for linha in self.__cabecalhos:
+            file.write(linha)
+        if not isinstance(self.data, pd.DataFrame):
+            raise ValueError("Dados do agrint.dat não foram lidos com sucesso")
+
+        df = self.data.copy()
+        for _, linha_agrupamento in (
+            self.data[["agrupamento", "data_inicio", "data_fim", "comentario"]]
+            .drop_duplicates()
+            .iterrows()
+        ):
+            df_agrupamento = df.loc[
+                (df["agrupamento"] == linha_agrupamento["agrupamento"])
+                & (df["data_inicio"] == linha_agrupamento["data_inicio"])
+            ]
+            if not pd.isna(linha_agrupamento["data_fim"]):
+                df_agrupamento = df_agrupamento.loc[
+                    (
+                        df_agrupamento["data_fim"]
+                        == linha_agrupamento["data_fim"]
+                    )
+                ]
+            file.write(
+                self.__linha.write(
+                    [
+                        linha_agrupamento["agrupamento"],
+                        linha_agrupamento["data_inicio"],
+                        linha_agrupamento["data_fim"],
+                    ]
+                    + df_agrupamento.sort_values("patamar")["valor"].tolist()
+                    + [linha_agrupamento["comentario"]]
+                )
+            )
+        file.write(BlocoGruposAgrint.FIM_BLOCO + "\n")

inewave-1.7.5/inewave/newave/modelos/arquivos.py

@@ -0,0 +1,58 @@
+from cfinterface.components.section import Section
+from cfinterface.components.line import Line
+from cfinterface.components.literalfield import LiteralField
+from typing import IO, List
+import pandas as pd  # type: ignore
+
+
+class BlocoNomesArquivos(Section):
+    """
+    Bloco de informações do arquivo de
+    entrada do NEWAVE `arquivos.dat`.
+    """
+
+    __slots__ = ["__linha"]
+
+    FIM_BLOCO = " 9999"
+
+    def __init__(self, previous=None, next=None, data=None) -> None:
+        super().__init__(previous, next, data)
+        self.__linha = Line([LiteralField(30, 0), LiteralField(40, 30)])
+
+    def __eq__(self, o: object) -> bool:
+        if not isinstance(o, BlocoNomesArquivos):
+            return False
+        bloco: BlocoNomesArquivos = o
+        if not all(
+            [
+                isinstance(self.data, pd.DataFrame),
+                isinstance(o.data, pd.DataFrame),
+            ]
+        ):
+            return False
+        else:
+            return self.data.equals(bloco.data)
+
+    # Override
+    def read(self, file: IO, *args, **kwargs):
+        def converte_tabela_em_df():
+            df = pd.DataFrame(data={"legenda": legendas, "nome": nomes})
+            return df
+
+        legendas: List[str] = []
+        nomes: List[str] = []
+        while True:
+            linha = file.readline()
+            if len(linha) < 3:
+                self.data = converte_tabela_em_df()
+                break
+            dados = self.__linha.read(linha)
+            legendas.append(dados[0])
+            nomes.append(dados[1])
+
+    # Override
+    def write(self, file: IO, *args, **kwargs):
+        if not isinstance(self.data, pd.DataFrame):
+            raise ValueError("Dados do arquivos.dat não foram lidos")
+        for _, linha in self.data.iterrows():
+            file.write(self.__linha.write(linha.tolist()))

inewave-1.7.5/inewave/newave/modelos/avl_cortesfpha_nwv.py

@@ -0,0 +1,87 @@
+# Imports de módulos externos
+from cfinterface.components.line import Line
+from cfinterface.components.integerfield import IntegerField
+from cfinterface.components.literalfield import LiteralField
+from cfinterface.components.floatfield import FloatField
+
+from inewave.newave.modelos.blocos.tabelacsv import TabelaCSV
+
+
+class TabelaAvlCortesFpha28(TabelaCSV):
+    """
+    Bloco com as informações dos cortes da função de produção para as
+    UHEs do modelo NEWAVE.
+    """
+
+    __slots__ = []
+
+    BEGIN_PATTERN = "-----;-----;--------------;"
+
+    LINE_MODEL = Line(
+        [
+            IntegerField(size=5),
+            IntegerField(size=5),
+            LiteralField(size=14),
+            IntegerField(size=7),
+            FloatField(size=10, decimal_digits=6),
+            FloatField(size=16, decimal_digits=8),
+            FloatField(size=16, decimal_digits=8),
+            FloatField(size=16, decimal_digits=8),
+            FloatField(size=16, decimal_digits=8),
+            FloatField(size=16, decimal_digits=8),
+        ],
+        delimiter=";",
+    )
+    COLUMN_NAMES = [
+        "codigo_usina",
+        "periodo",
+        "nome_usina",
+        "indice_corte",
+        "fator_correcao",
+        "rhs_energia",
+        "coeficiente_volume_util_MW_hm3",
+        "coeficiente_vazao_turbinada_MW_m3s",
+        "coeficiente_vazao_vertida_MW_m3s",
+        "coeficiente_vazao_lateral_MW_m3s",
+    ]
+    END_PATTERN = ""
+
+
+class TabelaAvlCortesFpha(TabelaCSV):
+    """
+    Bloco com as informações dos cortes da função de produção para as
+    UHEs do modelo NEWAVE.
+    """
+
+    __slots__ = []
+
+    BEGIN_PATTERN = "----;----;--------------;-------;"
+
+    LINE_MODEL = Line(
+        [
+            IntegerField(size=4),
+            IntegerField(size=4),
+            LiteralField(size=14),
+            IntegerField(size=7),
+            FloatField(size=10, decimal_digits=6),
+            FloatField(size=16, decimal_digits=8),
+            FloatField(size=16, decimal_digits=8),
+            FloatField(size=16, decimal_digits=8),
+            FloatField(size=16, decimal_digits=8),
+            FloatField(size=16, decimal_digits=8),
+        ],
+        delimiter=";",
+    )
+    COLUMN_NAMES = [
+        "codigo_usina",
+        "periodo",
+        "nome_usina",
+        "indice_corte",
+        "fator_correcao",
+        "rhs_energia",
+        "coeficiente_volume_util_MW_hm3",
+        "coeficiente_vazao_turbinada_MW_m3s",
+        "coeficiente_vazao_vertida_MW_m3s",
+        "coeficiente_vazao_lateral_MW_m3s",
+    ]
+    END_PATTERN = ""

inewave-1.7.5/inewave/newave/modelos/avl_desvfpha_s.py

@@ -0,0 +1,90 @@
+# Imports de módulos externos
+from cfinterface.components.block import Block
+from cfinterface.components.line import Line
+from cfinterface.components.integerfield import IntegerField
+from cfinterface.components.literalfield import LiteralField
+from cfinterface.components.floatfield import FloatField
+import pandas as pd  # type: ignore
+from typing import IO, Dict, List
+
+
+class TabelaAvlDesvFphaS(Block):
+    """
+    Bloco com os desvios da função de produção no plano de
+    vazão vertida (S).
+    """
+
+    __slots__ = ["__linha"]
+
+    BEGIN_PATTERN = "-----;--------------;--------;"
+
+    COLUMN_NAMES = [
+        "codigo_usina",
+        "nome_usina",
+        "volume_armazenado_percentual",
+        "vazao_turbinada_m3s",
+        "vazao_vertida_m3s",
+        "desvio_percentual",
+    ]
+    END_PATTERN = ""
+
+    def _monta_df(self, dados: dict) -> pd.DataFrame:
+        return pd.DataFrame(data=dados, columns=self.__class__.COLUMN_NAMES)
+
+    def __eq__(self, o: object) -> bool:
+        if not isinstance(o, TabelaAvlDesvFphaS):
+            return False
+        else:
+            if not all(
+                [type(self.data) is pd.DataFrame, type(o.data) is pd.DataFrame]
+            ):
+                return False
+            else:
+                return self.data.equals(o.data)
+
+    def read(self, file: IO, *args, **kwargs):
+        # Espera o fim do cabeçalho
+        linha = file.readline()
+        while True:
+            linha = file.readline()
+            if "VERT" in linha:
+                num_vertimentos = linha.count("VERT")
+                self.__linha = Line(
+                    [
+                        IntegerField(size=5),
+                        LiteralField(size=14),
+                        FloatField(size=8, decimal_digits=2),
+                        FloatField(size=9, decimal_digits=2),
+                    ]
+                    + [
+                        FloatField(size=9, decimal_digits=2)
+                        for _ in range(num_vertimentos)
+                    ],
+                    delimiter=";",
+                )
+            if self.__class__.BEGIN_PATTERN in linha:
+                break
+            elif len(linha) < 3:
+                return
+        # Lê os valores das variáveis de um dos eixos
+        dados_eixo = self.__linha.read(file.readline())
+        valores_vert = dados_eixo[4:]
+        num_valores_vert = len(valores_vert)
+        # Ignora a segunda linha de cabeçalho
+        file.readline()
+        # Lê a tabela
+        dados: Dict[str, List] = {c: [] for c in self.__class__.COLUMN_NAMES}
+        while True:
+            linha = file.readline()
+            if len(linha) < 3 or "-----;--------------;------;" in linha:
+                self.data = self._monta_df(dados)
+                return
+            dados_linha = self.__linha.read(linha)
+            dados["codigo_usina"] += [dados_linha[0]] * num_valores_vert
+            dados["nome_usina"] += [dados_linha[1]] * num_valores_vert
+            dados["volume_armazenado_percentual"] += [
+                dados_linha[2]
+            ] * num_valores_vert
+            dados["vazao_turbinada_m3s"] += [dados_linha[3]] * num_valores_vert
+            dados["vazao_vertida_m3s"] += valores_vert
+            dados["desvio_percentual"] += dados_linha[4:]