inewave 1.7.5__py3-none-any.whl → 1.8.0__py3-none-any.whl

inewave/__init__.py

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

inewave/newave/__init__.py

@@ -1,5 +1,14 @@
 # Inclui os membros
 
+# Deprecated
+from .avl_cortesfpha_nwv import AvlCortesFpha  # noqa
+from .avl_desvfpha_s import AvlDesvFphaS  # noqa
+from .avl_desvfpha_v_q import AvlDesvFphaVQ  # noqa
+from .eco_fpha import EcoFpha  # noqa
+from .nwv_avl_evap import NwvAvlEvap  # noqa
+from .nwv_cortes_evap import NwvCortesEvap  # noqa
+from .nwv_eco_evap import NwvEcoEvap  # noqa
+
 from .abertura import Abertura  # noqa
 from .adterm import Adterm  # noqa
 from .agrint import Agrint  # noqa
@@ -46,13 +55,13 @@ from .term import Term  # noqa
 from .vazoes import Vazoes  # noqa
 from .vazpast import Vazpast  # noqa
 from .volref_saz import VolrefSaz  # noqa
-from .avl_cortesfpha_nwv import AvlCortesFpha  # noqa
-from .avl_desvfpha_s import AvlDesvFphaS  # noqa
-from .avl_desvfpha_v_q import AvlDesvFphaVQ  # noqa
-from .eco_fpha import EcoFpha  # noqa
-from .nwv_avl_evap import NwvAvlEvap  # noqa
-from .nwv_cortes_evap import NwvCortesEvap  # noqa
-from .nwv_eco_evap import NwvEcoEvap  # noqa
+from .fpha_cortes import FphaCortes  # noqa
+from .fpha_avl_desv_s import FphaAvlDesvS  # noqa
+from .fpha_avl_desv_v_q import FphaAvlDesvVQ  # noqa
+from .fpha_eco import FphaEco  # noqa
+from .evap_avl_desv import EvapAvlDesv  # noqa
+from .evap_cortes import EvapCortes  # noqa
+from .evap_eco import EvapEco  # noqa
 from .energiaf import Energiaf  # noqa
 from .energiab import Energiab  # noqa
 from .energias import Energias  # noqa

inewave/newave/avl_cortesfpha_nwv.py

@@ -11,6 +11,8 @@ from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
 from typing import Optional
 import pandas as pd  # type: ignore
 
+from warnings import warn
+
 
 class AvlCortesFpha(ArquivoCSV):
     """
@@ -44,3 +46,11 @@ class AvlCortesFpha(ArquivoCSV):
         :rtype: pd.DataFrame | None
         """
         return self._tabela()
+
+    def __init__(self, data=...) -> None:
+        warn(
+            "Esta classe é relativa a um arquivo que não é mais suportado."
+            + " Utilize a classe FphaCortes no lugar.",
+            DeprecationWarning,
+        )
+        super().__init__(data)

inewave/newave/avl_desvfpha_s.py

@@ -5,6 +5,8 @@ from cfinterface.files.blockfile import BlockFile
 from typing import Optional, TypeVar
 import pandas as pd  # type: ignore
 
+from warnings import warn
+
 
 class AvlDesvFphaS(BlockFile):
     """
@@ -18,6 +20,11 @@ class AvlDesvFphaS(BlockFile):
     T = TypeVar("T")
 
     def __init__(self, data=...) -> None:
+        warn(
+            "Esta classe é relativa a um arquivo que não é mais suportado."
+            + " Utilize a classe FphaAvlDesvS no lugar.",
+            DeprecationWarning,
+        )
         super().__init__(data)
         self.__df_completo: Optional[pd.DataFrame] = None
 

inewave/newave/avl_desvfpha_v_q.py

@@ -5,6 +5,8 @@ from cfinterface.files.blockfile import BlockFile
 from typing import Optional, TypeVar
 import pandas as pd  # type: ignore
 
+from warnings import warn
+
 
 class AvlDesvFphaVQ(BlockFile):
     """
@@ -18,6 +20,11 @@ class AvlDesvFphaVQ(BlockFile):
     T = TypeVar("T")
 
     def __init__(self, data=...) -> None:
+        warn(
+            "Esta classe é relativa a um arquivo que não é mais suportado."
+            + " Utilize a classe FphaAvlDesvVQ no lugar.",
+            DeprecationWarning,
+        )
         super().__init__(data)
         self.__df_completo: Optional[pd.DataFrame] = None
 

inewave/newave/eco_fpha.py

@@ -5,6 +5,8 @@ from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
 from typing import Optional
 import pandas as pd  # type: ignore
 
+from warnings import warn
+
 
 class EcoFpha(ArquivoCSV):
     """
@@ -39,3 +41,11 @@ class EcoFpha(ArquivoCSV):
         :rtype: pd.DataFrame | None
         """
         return self._tabela()
+
+    def __init__(self, data=...) -> None:
+        warn(
+            "Esta classe é relativa a um arquivo que não é mais suportado."
+            + " Utilize a classe FphaEco no lugar.",
+            DeprecationWarning,
+        )
+        super().__init__(data)

inewave/newave/evap_avl_desv.py

@@ -0,0 +1,33 @@
+from inewave.newave.modelos.blocos.versaomodelo import VersaoModelo
+from inewave.newave.modelos.nwv_avl_evap import TabelaAvlEvap
+
+from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
+from typing import Optional
+import pandas as pd  # type: ignore
+
+
+class EvapAvlDesv(ArquivoCSV):
+    """
+    Arquivo com a avaliação da evaporação linear do NEWAVE.
+    """
+
+    BLOCKS = [VersaoModelo, TabelaAvlEvap]
+
+    @property
+    def tabela(self) -> Optional[pd.DataFrame]:
+        """
+        A tabela de dados que está contida no arquivo.
+
+        - periodo (`int`)
+        - codigo_usina (`int`)
+        - nome_usina (`str`)
+        - volume_armazenado_hm3 (`float`)
+        - evaporacao_calculada_hm3 (`float`)
+        - evaporacao_modelo_hm3 (`float`)
+        - desvio_absoluto_hm3 (`float`)
+        - desvio_percentual (`float`)
+
+        :return: A tabela como um dataframe
+        :rtype: pd.DataFrame | None
+        """
+        return self._tabela()

inewave/newave/evap_cortes.py

@@ -0,0 +1,34 @@
+from inewave.newave.modelos.blocos.versaomodelo import VersaoModelo
+from inewave.newave.modelos.nwv_cortes_evap import TabelaCortesEvap
+
+from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
+from typing import Optional
+import pandas as pd  # type: ignore
+
+
+class EvapCortes(ArquivoCSV):
+    """
+    Arquivo com os cortes da evaporação linear do NEWAVE.
+    """
+
+    BLOCKS = [VersaoModelo, TabelaCortesEvap]
+
+    @property
+    def tabela(self) -> Optional[pd.DataFrame]:
+        """
+        A tabela de dados que está contida no arquivo.
+
+        - periodo (`int`)
+        - indice_usina (`int`)
+        - nome_usina (`str`)
+        - derivada_cota_area (`float`)
+        - derivada_volume_cota (`float`)
+        - volume_referencia_hm3 (`float`)
+        - evaporacao_referencia_hm3 (`float`)
+        - coeficiente_volume (`float`)
+        - rhs_volume (`float`)
+
+        :return: A tabela como um dataframe
+        :rtype: pd.DataFrame | None
+        """
+        return self._tabela()

inewave/newave/evap_eco.py

@@ -0,0 +1,34 @@
+from inewave.newave.modelos.blocos.versaomodelo import VersaoModelo
+from inewave.newave.modelos.nwv_eco_evap import TabelaEcoEvap
+
+from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
+from typing import Optional
+import pandas as pd  # type: ignore
+
+
+class EvapEco(ArquivoCSV):
+    """
+    Arquivo com o eco dos dados da evaporação linear do NEWAVE.
+    """
+
+    BLOCKS = [VersaoModelo, TabelaEcoEvap]
+
+    @property
+    def tabela(self) -> Optional[pd.DataFrame]:
+        """
+        A tabela de dados que está contida no arquivo.
+
+        - periodo (`int`)
+        - codigo_usina (`int`)
+        - nome_usina (`str`)
+        - volume_referencia_hm3 (`float`)
+        - evaporacao_referencia_hm3 (`float`)
+        - coeficiente_evaporacao_mm_mes (`int`)
+        - flag_evaporacao (`int`)
+        - evaporacao_linear (`int`)
+        - tipo_volume_referencia (`int`)
+
+        :return: A tabela como um dataframe
+        :rtype: pd.DataFrame | None
+        """
+        return self._tabela()

inewave/newave/fpha_avl_desv_s.py

@@ -0,0 +1,59 @@
+from inewave.newave.modelos.blocos.versaomodelo import VersaoModelo
+from inewave.newave.modelos.avl_desvfpha_s import TabelaAvlDesvFphaS
+
+from cfinterface.files.blockfile import BlockFile
+from typing import Optional, TypeVar
+import pandas as pd  # type: ignore
+
+
+class FphaAvlDesvS(BlockFile):
+    """
+    Arquivo com os desvios da função de produção no plano de
+    vazão vertida (S).
+    """
+
+    BLOCKS = [VersaoModelo, TabelaAvlDesvFphaS]
+    ENCODING = "iso-8859-1"
+
+    T = TypeVar("T")
+
+    def __init__(self, data=...) -> None:
+        super().__init__(data)
+        self.__df_completo: Optional[pd.DataFrame] = None
+
+    @property
+    def tabela(self) -> Optional[pd.DataFrame]:
+        """
+        A tabela de dados que está contida no arquivo.
+
+        - codigo_usina (`int`)
+        - nome_usina (`str`)
+        - volume_armazenado_percentual (`float`)
+        - vazao_turbinada_m3s (`float`)
+        - vazao_vertida_m3s (`float`)
+        - desvio_percentual (`float`)
+
+        :return: A tabela como um dataframe
+        :rtype: pd.DataFrame | None
+        """
+        if self.__df_completo is None:
+            tabelas = self.data.of_type(TabelaAvlDesvFphaS)
+            self.__df_completo = pd.DataFrame()
+            for t in tabelas:
+                self.__df_completo = pd.concat(
+                    [self.__df_completo, t.data], ignore_index=True
+                )
+        return self.__df_completo
+
+    @property
+    def versao(self) -> Optional[str]:
+        """
+        A versão do modelo utilizada para executar o caso.
+
+        :return: A versão do modelo
+        :rtype: str | None
+        """
+        b = self.data.get_blocks_of_type(VersaoModelo)
+        if isinstance(b, VersaoModelo):
+            return b.data
+        return None

inewave/newave/fpha_avl_desv_v_q.py

@@ -0,0 +1,58 @@
+from inewave.newave.modelos.blocos.versaomodelo import VersaoModelo
+from inewave.newave.modelos.avl_desvfpha_v_q import TabelaAvlDesvFphaVQ
+
+from cfinterface.files.blockfile import BlockFile
+from typing import Optional, TypeVar
+import pandas as pd  # type: ignore
+
+
+class FphaAvlDesvVQ(BlockFile):
+    """
+    Arquivo com os desvios da função de produção nos planos de
+    volume armazenado e vazão turbinada (V-Q).
+    """
+
+    BLOCKS = [VersaoModelo, TabelaAvlDesvFphaVQ]
+    ENCODING = "iso-8859-1"
+
+    T = TypeVar("T")
+
+    def __init__(self, data=...) -> None:
+        super().__init__(data)
+        self.__df_completo: Optional[pd.DataFrame] = None
+
+    @property
+    def tabela(self) -> Optional[pd.DataFrame]:
+        """
+        A tabela de dados que está contida no arquivo.
+
+        - codigo_usina (`int`)
+        - nome_usina (`str`)
+        - volume_armazenado_percentual (`float`)
+        - vazao_turbinada_m3s (`float`)
+        - desvio_percentual (`float`)
+
+        :return: A tabela como um dataframe
+        :rtype: pd.DataFrame | None
+        """
+        if self.__df_completo is None:
+            tabelas = self.data.of_type(TabelaAvlDesvFphaVQ)
+            tabelas_validas = [t.data for t in tabelas if t is not None]
+            self.__df_completo = pd.concat(
+                [t for t in tabelas_validas if isinstance(t, pd.DataFrame)],
+                ignore_index=True,
+            )
+        return self.__df_completo
+
+    @property
+    def versao(self) -> Optional[str]:
+        """
+        A versão do modelo utilizada para executar o caso.
+
+        :return: A versão do modelo
+        :rtype: str | None
+        """
+        b = self.data.get_blocks_of_type(VersaoModelo)
+        if isinstance(b, VersaoModelo):
+            return b.data
+        return None

inewave/newave/fpha_cortes.py

@@ -0,0 +1,40 @@
+from inewave.newave.modelos.blocos.versaomodelo import (
+    VersaoModeloLibs,
+)
+from inewave.newave.modelos.avl_cortesfpha_nwv import (
+    TabelaAvlCortesFpha,
+)
+
+from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
+from typing import Optional
+import pandas as pd  # type: ignore
+
+
+class FphaCortes(ArquivoCSV):
+    """
+    Arquivo com os cortes da função de produção para as UHEs
+    do NEWAVE.
+    """
+
+    BLOCKS = [VersaoModeloLibs, TabelaAvlCortesFpha]
+
+    @property
+    def tabela(self) -> Optional[pd.DataFrame]:
+        """
+        A tabela de dados que está contida no arquivo.
+
+        - codigo_usina (`int`)
+        - periodo (`int`)
+        - nome_usina (`str`)
+        - indice_corte (`int`)
+        - fator_correcao (`float`)
+        - rhs_energia (`float`)
+        - coeficiente_volume_util_MW_hm3 (`float`)
+        - coeficiente_vazao_turbinada_MW_m3s (`float`)
+        - coeficiente_vazao_vertida_MW_m3s (`float`)
+        - coeficiente_vazao_lateral_MW_m3s (`float`)
+
+        :return: A tabela como um dataframe
+        :rtype: pd.DataFrame | None
+        """
+        return self._tabela()

inewave/newave/fpha_eco.py

@@ -0,0 +1,41 @@
+from inewave.newave.modelos.blocos.versaomodelo import VersaoModelo
+from inewave.newave.modelos.eco_fpha import TabelaEcoFpha
+
+from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
+from typing import Optional
+import pandas as pd  # type: ignore
+
+
+class FphaEco(ArquivoCSV):
+    """
+    Arquivo com o eco da função de produção para as UHEs
+    do NEWAVE.
+    """
+
+    BLOCKS = [VersaoModelo, TabelaEcoFpha]
+
+    @property
+    def tabela(self) -> Optional[pd.DataFrame]:
+        """
+        A tabela de dados que está contida no arquivo.
+
+        - codigo_usina (`int`)
+        - periodo (`int`)
+        - nome_usina (`str`)
+        - tipo (`int`)
+        - conv (`int`)
+        - alfa (`int`)
+        - rems (`int`)
+        - numero_pontos_vazao_turbinada (`int`)
+        - vazao_turbinada_minima (`float`)
+        - vazao_turbinada_maxima (`float`)
+        - numero_pontos_volume_armazenado (`int`)
+        - volume_armazenado_minimo (`float`)
+        - volume_armazenado_maximo (`float`)
+        - geracao_minima (`float`)
+        - geracao_maxima (`float`)
+
+        :return: A tabela como um dataframe
+        :rtype: pd.DataFrame | None
+        """
+        return self._tabela()

inewave/newave/modelos/pmo.py

@@ -21,6 +21,46 @@ from inewave._utils.formatacao import (
 )
 
 
+class BlocoVersaoModeloPMO(Block):
+    """
+    Bloco com a versão do modelo localizado no arquivo `pmo.dat`.
+    """
+
+    __slots__ = ["__line"]
+
+    BEGIN_PATTERN = (
+        " CEPEL                         MODELO ESTRATEGICO DE"
+        + " GERACAO HIDROTERMICA A SUBSISTEMAS              VERSAO"
+    )
+    END_PATTERN = ""
+
+    def __init__(self, previous=None, next=None, data=None) -> None:
+        super().__init__(previous, next, data)
+
+        self.__line = Line([LiteralField(18, 109)])
+
+    def __eq__(self, o: object) -> bool:
+        if not isinstance(o, BlocoVersaoModeloPMO):
+            return False
+        bloco: BlocoVersaoModeloPMO = o
+        if not all(
+            [
+                isinstance(self.data, str),
+                isinstance(o.data, str),
+            ]
+        ):
+            return False
+        else:
+            return self.data == bloco.data
+
+    # Override
+    def read(self, file: IO, *args, **kwargs):
+
+        linha = file.readline()
+        dados: List[str] = self.__line.read(linha)
+        self.data = dados[0].strip()
+
+
 class BlocoEafPastTendenciaHidrolPMO(Block):
     """
     Bloco de informações de afluências passadas para

inewave/newave/nwv_avl_evap.py

@@ -5,6 +5,8 @@ from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
 from typing import Optional
 import pandas as pd  # type: ignore
 
+from warnings import warn
+
 
 class NwvAvlEvap(ArquivoCSV):
     """
@@ -31,3 +33,11 @@ class NwvAvlEvap(ArquivoCSV):
         :rtype: pd.DataFrame | None
         """
         return self._tabela()
+
+    def __init__(self, data=...) -> None:
+        warn(
+            "Esta classe é relativa a um arquivo que não é mais suportado."
+            + " Utilize a classe EvapAvlDesv no lugar.",
+            DeprecationWarning,
+        )
+        super().__init__(data)

inewave/newave/nwv_cortes_evap.py

@@ -5,6 +5,8 @@ from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
 from typing import Optional
 import pandas as pd  # type: ignore
 
+from warnings import warn
+
 
 class NwvCortesEvap(ArquivoCSV):
     """
@@ -32,3 +34,11 @@ class NwvCortesEvap(ArquivoCSV):
         :rtype: pd.DataFrame | None
         """
         return self._tabela()
+
+    def __init__(self, data=...) -> None:
+        warn(
+            "Esta classe é relativa a um arquivo que não é mais suportado."
+            + " Utilize a classe EvapCortes no lugar.",
+            DeprecationWarning,
+        )
+        super().__init__(data)

inewave/newave/nwv_eco_evap.py

@@ -5,6 +5,8 @@ from inewave.newave.modelos.arquivoscsv.arquivocsv import ArquivoCSV
 from typing import Optional
 import pandas as pd  # type: ignore
 
+from warnings import warn
+
 
 class NwvEcoEvap(ArquivoCSV):
     """
@@ -32,3 +34,11 @@ class NwvEcoEvap(ArquivoCSV):
         :rtype: pd.DataFrame | None
         """
         return self._tabela()
+
+    def __init__(self, data=...) -> None:
+        warn(
+            "Esta classe é relativa a um arquivo que não é mais suportado."
+            + " Utilize a classe EvapEco no lugar.",
+            DeprecationWarning,
+        )
+        super().__init__(data)

inewave/newave/pmo.py

@@ -1,3 +1,4 @@
+from inewave.newave.modelos.pmo import BlocoVersaoModeloPMO
 from inewave.newave.modelos.pmo import BlocoEafPastTendenciaHidrolPMO
 from inewave.newave.modelos.pmo import BlocoEafPastCfugaMedioPMO
 from inewave.newave.modelos.pmo import BlocoConvergenciaPMO
@@ -48,6 +49,7 @@ class Pmo(BlockFile):
     T = TypeVar("T")
 
     BLOCKS = [
+        BlocoVersaoModeloPMO,
         BlocoEafPastTendenciaHidrolPMO,
         BlocoEafPastCfugaMedioPMO,
         BlocoConvergenciaPMO,
@@ -71,6 +73,21 @@ class Pmo(BlockFile):
         BlocoGeracaoMaximaUsinasTermicasPMO,
     ]
 
+    @property
+    def versao_modelo(self) -> Optional[str]:
+        """
+        A versão do modelo que produziu o arquivo.
+
+        :return: A string de versão do modelo.
+        :rtype: str | None
+        """
+        b = self.data.get_blocks_of_type(BlocoVersaoModeloPMO)
+        if isinstance(b, BlocoVersaoModeloPMO):
+            return b.data
+        elif isinstance(b, list):
+            return b[0].data
+        return None
+
     @property
     def eafpast_tendencia_hidrologica(self) -> Optional[pd.DataFrame]:
         """