Arquivo de dados gerais (entdados.dat)

As informações de entrada gerais do DESSEM, localizadas no arquivo geralmente denominado entdados.dat são armazenadas na classe:

class Entdados(data=Ellipsis)[código-fonte]

Armazena os dados de entrada gerais do DESSEM.

Esta classe lida com as informações de entrada fornecidas ao DESSEM no entdados.dat. Possui métodos para acessar individualmente cada registro, editá-lo e também cria alguns novos registros.

ac(codigo_usina: int, modificacao: Any, df: bool = False, **kwargs) ACVTFUGA | ACVOLMAX | ACVOLMIN | ACVSVERT | ACVMDESV | ACCOTVAZ | ACCOTVOL | ACCOTTAR | ACNUMCON | ACNUMJUS | ACNUMPOS | ACJUSENA | ACJUSMED | ACCOFEVA | ACNUMMAQ | ACDESVIO | ACPOTEFE | List[ACVTFUGA | ACVOLMAX | ACVOLMIN | ACVSVERT | ACVMDESV | ACCOTVAZ | ACCOTVOL | ACCOTTAR | ACNUMCON | ACNUMJUS | ACNUMPOS | ACJUSENA | ACJUSMED | ACCOFEVA | ACNUMMAQ | ACDESVIO | ACPOTEFE] | DataFrame | None[código-fonte]

Obtém um registro que define modificações nos parâmetros das UHE em um Entdados.

Parâmetros:
  • codigo_usina (int) – código da UHE modificada

  • modificacao (subtipos do tipo AC) – classe da modificação realizada

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

AC | list[AC] | pd.DataFrame | None

cd(codigo_submercado: int | None = None, numero_curva: int | None = None, df: bool = False) CD | List[CD] | DataFrame | None[código-fonte]

Obtém um registro que define as curvas de déficit no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_submercado (int | None) – submercado para o qual valerá a curva

  • numero_curva (int | None) – índice da curva de déficit descrita

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

CD | list[CD] | pd.DataFrame | None

cr(codigo_secao: int | None = None, nome_secao: str | None = None, grau: int | None = None, df: bool = False) CR | List[CR] | DataFrame | None[código-fonte]

Obtém um registro que especifica o polinômio cota x vazão para seções de rio no estudo especificado no Entdados

Parâmetros:
  • codigo_secao (int | None) – Código da seção

  • nome_secao (str | None) – Nome da seção

  • grau (int | None) – Grau do polinômio

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

CR | list[CR] | pd.DataFrame | None

da(codigo_usina: int | None = None, df: bool = False) DA | List[DA] | DataFrame | None[código-fonte]

Obtém um registro que especifica a taxa de retirada de água para uma usina existente no estudo especificado no Entdados

Parâmetros:
  • codigo_usina (int | None) – Código da usina

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

DA | list[DA] | pd.DataFrame | None

de(codigo_demanda_especial: int | None = None, df: bool = False) DE | List[DE] | DataFrame | None[código-fonte]

Obtém um registro que define uma demanda especial para serem representadas em restrições elétricas no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_demanda_especial (int | None) – código da demanda especial.

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

DE | list[DE] | pd.DataFrame | None

dp(codigo_submercado: int | None = None, df: bool = False) DP | List[DP] | DataFrame | None[código-fonte]

Obtém um registro que define os dados de demanda para os submercados que serão consideradas para os períodos que não se considerada a rede elétrica no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_submercado (int | None) – subsistema para o qual valerão os patamares.

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

DP | list[DP] | pd.DataFrame | None

ez(codigo_usina: int | None = None, df: bool = False) EZ | List[EZ] | DataFrame | None[código-fonte]

Obtém um registro que especifica o percentual máximo do volume útil para acoplamento no estudo especificado no Entdados

Parâmetros:
  • codigo_usina (int | None) – Código da usina

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

EZ | list[EZ] | pd.DataFrame | None

fc(codigo_restricao: int | None = None, dia_inicial: str | int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, dia_final: str | int | None = None, hora_final: int | None = None, meia_hora_final: int | None = None, codigo_demanda: int | None = None, coeficiente: float | None = None, df: bool = False) FC | List[FC] | DataFrame | None[código-fonte]

Obtém um registro que cadastra os coeficientes das restrições elétricas para demandas especiais.

Parâmetros:
  • codigo_restricao (int | None) – Índice do código que especifica o registro da restrição elétrica

  • dia_inicial (int | None) – dia inicial

  • hora_inicial (int | None) – hora inicial

  • meia_hora_inicial – meia-hora inicial

  • dia_final (int | None) – dia final

  • hora_final (int | None) – hora final

  • meia_hora_final (int | None) – meia-hora final

  • codigo_demanda (int | None) – código da demanda especial

  • coeficiente (int | None) – coeficiente de participação da usina na restrição

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FR | list[FR] | pd.DataFrame | None

fe(codigo_restricao: int | None = None, dia_inicial: str | int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, dia_final: str | int | None = None, hora_final: int | None = None, meia_hora_final: int | None = None, codigo_contrato: int | None = None, coeficiente: float | None = None, df: bool = False) FE | List[FE] | DataFrame | None[código-fonte]

Obtém um registro que cadastra os coeficientes das restrições elétricas para contratos de importação/exportação de energia.

Parâmetros:
  • codigo_restricao (int | None) – Índice do código que especifica o registro da restrição elétrica

  • dia_inicial (int | None) – dia inicial

  • hora_inicial (int | None) – hora inicial

  • meia_hora_inicial – meia-hora inicial

  • dia_final (int | None) – dia final

  • hora_final (int | None) – hora final

  • meia_hora_final (int | None) – meia-hora final

  • codigo_contrato (int | None) – código do contrato

  • coeficiente (int | None) – coeficiente de participação do contrato na restrição

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FE | list[FE] | pd.DataFrame | None

fh(codigo_restricao: int | None = None, dia_inicial: str | int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, dia_final: str | int | None = None, hora_final: int | None = None, meia_hora_final: int | None = None, codigo_usina: int | None = None, codigo_conjunto: int | None = None, coeficiente: float | None = None, df: bool = False) FH | List[FH] | DataFrame | None[código-fonte]

Obtém um registro que cadastra os coeficientes das restrições elétricas para usinas hidráulicas.

Parâmetros:
  • codigo_restricao (int | None) – Índice do código que especifica o registro da restrição elétrica

  • dia_inicial (int | None) – dia inicial

  • hora_inicial (int | None) – hora inicial

  • meia_hora_inicial – meia-hora inicial

  • dia_final (int | None) – dia final

  • hora_final (int | None) – hora final

  • meia_hora_final (int | None) – meia-hora final

  • codigo_usina (int | None) – código da usina hidráulica

  • codigo_conjunto (int | None) – conjunto de máquinas da usina

  • coeficiente (int | None) – coeficiente de participação da usina na restrição

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FH | list[FH] | pd.DataFrame | None

fi(codigo_restricao: int | None = None, dia_inicial: str | int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, dia_final: str | int | None = None, hora_final: int | None = None, meia_hora_final: int | None = None, nome_submercado_de: int | None = None, nome_submercado_para: int | None = None, coeficiente: float | None = None, df: bool = False) FI | List[FI] | DataFrame | None[código-fonte]

Obtém um registro que cadastra os coeficientes das restrições elétricas para intercâmbios.

Parâmetros:
  • codigo_restricao (int | None) – Índice do código que especifica o registro da restrição elétrica

  • dia_inicial (int | None) – dia inicial

  • hora_inicial (int | None) – hora inicial

  • meia_hora_inicial – meia-hora inicial

  • dia_final (int | None) – dia final

  • hora_final (int | None) – hora final

  • meia_hora_final (int | None) – meia-hora final

  • nome_submercado_de (str | None) – mnemônico do submercado origem (de)

  • nome_submercado_para (str | None) – mnemônico do submercado destino (para)

  • coeficiente (int | None) – coeficiente de participação do fluxo na restrição

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FI | list[FI] | pd.DataFrame | None

fp(codigo_usina: int | None = None, tipo_tratamento_volume: int | None = None, numero_pontos_turbinamento: int | None = None, numero_pontos_volume: int | None = None, verifica_concavidade: int | None = None, ajuste_minimos_quadrados: int | None = None, comprimento_janela_volume: float | None = None, tolerancia_desvio: float | None = None, df: bool = False) FP | List[FP] | DataFrame | None[código-fonte]

Obtém um registro que que contém alteração de parâmetros para a construção da função de produção aproximada (FPHA) das usinas existente no estudo especificado no Entdados

Parâmetros:
  • codigo_usina (int | None) – Código da UHE associada ao registro

  • tipo_tratamento_volume (int | None) – Tipo de tratamento para o eixo de volume

  • numero_pontos_turbinamento (int | None) – número de pontos para discretização da janela

  • numero_pontos_volume (int | None) – número de pontos para discretização da janela

  • verifica_concavidade (int | None) – Verificação da concavidade

  • ajuste_minimos_quadrados (int | None) – Ajuste de mínimos quadrados

  • comprimento_janela_volume (float | None) – Comprimento da janela para discretização do volume

  • tolerancia_desvio (float | None) – Tolerância para desvio para na função

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

FP | list[FP] | pd.DataFrame | None

fr(codigo_restricao: int | None = None, dia_inicial: str | int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, dia_final: str | int | None = None, hora_final: int | None = None, meia_hora_final: int | None = None, codigo_usina: int | None = None, coeficiente: float | None = None, df: bool = False) FR | List[FR] | DataFrame | None[código-fonte]

Obtém um registro que cadastra os coeficientes das restrições elétricas para usinas de fontes renováveis.

Parâmetros:
  • codigo_restricao (int | None) – Índice do código que especifica o registro da restrição elétrica

  • dia_inicial (int | None) – dia inicial

  • hora_inicial (int | None) – hora inicial

  • meia_hora_inicial – meia-hora inicial

  • dia_final (int | None) – dia final

  • hora_final (int | None) – hora final

  • meia_hora_final (int | None) – meia-hora final

  • codigo_usina (int | None) – código da usina renovável

  • coeficiente (int | None) – coeficiente de participação da usina na restrição

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FR | list[FR] | pd.DataFrame | None

ft(codigo_restricao: int | None = None, dia_inicial: str | int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, dia_final: str | int | None = None, hora_final: int | None = None, meia_hora_final: int | None = None, codigo_usina: int | None = None, coeficiente: float | None = None, df: bool = False) FT | List[FT] | DataFrame | None[código-fonte]

Obtém um registro que cadastra os coeficientes das restrições elétricas para usinas térmicas.

Parâmetros:
  • codigo_restricao (int | None) – Índice do código que especifica o registro da restrição elétrica

  • dia_inicial (int | None) – dia inicial

  • hora_inicial (int | None) – hora inicial

  • meia_hora_inicial – meia-hora inicial

  • dia_final (int | None) – dia final

  • hora_final (int | None) – hora final

  • meia_hora_final (int | None) – meia-hora final

  • codigo_usina (int | None) – código da usina hidráulica

  • coeficiente (int | None) – coeficiente de participação da usina na restrição

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FT | list[FT] | pd.DataFrame | None

property gp: GP | None

Obtém o (único) registro que define o gap de convergência no estudo definido no Entdados

Retorna:

Um registro, se existir.

Tipo de retorno:

GP | None.

ia(nome_submercado_de: str | None = None, nome_submercado_para: str | None = None, df: bool = False) IA | List[IA] | DataFrame | None[código-fonte]

Obtém um registro que define as capacidades de intercâmbio no estudo descrito pelo Entdados.

Parâmetros:
  • nome_submercado_de (str | None) – mnemônico do submercado de origem (de).

  • nome_submercado_para (str | None) – mnemônico do submercado de destino (para).

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

IA | list[IA] | pd.DataFrame | None

property it: IT | None

Obtém o (único) registro que contém os coeficientes do polinômio do canal de fuga de Itaipu em função da vazão na Régua 11, para casos sem FPHA Libs no estudo definido no Entdados

Retorna:

Um registro, se existir.

Tipo de retorno:

IT | None.

lu(codigo_restricao: int | None = None, dia_inicial: str | int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, dia_final: str | int | None = None, hora_final: int | None = None, meia_hora_final: int | None = None, df: bool = False) LU | List[LU] | DataFrame | None[código-fonte]

Obtém um registro que especifica o limite inferior e superior de uma restrição elétrica existente no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_restricao (int | None) – Índice do código que especifica o registro da restrição elétrica

  • dia_inicial (int | str | None) – dia inicial

  • hora_inicial (int | None) – hora inicial

  • meia_hora_inicial – meia-hora inicial

  • dia_final (int | str | None) – dia final

  • hora_final (int | None) – hora final

  • meia_hora_final (int | None) – meia-hora final

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

LU | list[LU] | pd.DataFrame | None

mh(codigo_usina: int | None = None, codigo_conjunto: int | None = None, codigo_unidade: int | None = None, disponivel: int | None = None, df: bool = False) MH | List[MH] | DataFrame | None[código-fonte]

Obtém um registro que especifica a taxa de retirada de água para uma usina existente no estudo especificado no Entdados

Parâmetros:
  • codigo_usina (int | None) – Código da usina

  • codigo_conjunto (int | None) – Código do conjunto

  • codigo_unidade (int | None) – Código da unidade

  • disponivel (int | None) – Flag disponibilidade

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

MH | list[MH] | pd.DataFrame | None

property ni: NI | None

Obtém o (único) registro que define o número de iterações caso considere PDD no DESSEM no estudo definido no Entdados

Retorna:

Um registro, se existir.

Tipo de retorno:

NI | None.

property pe: PE | None

Obtém o (único) registro que contém penalidades no estudo definido no Entdados

Retorna:

Um registro, se existir.

Tipo de retorno:

PE | None.

pq(codigo_usina: int | None = None, nome_usina: str | None = None, localizacao: int | None = None, df: bool = False) PQ | List[PQ] | DataFrame | None[código-fonte]

Obtém um registro que define as gerações das pequenas usinas no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_usina (str | None) – o código das gerações

  • nome_usina (str | None) – o nome das gerações

  • localizacao (int | None) – índice do subsistema ou barra associado à geração

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

PQ | list[PQ] | pd.DataFrame | None

r11(df: bool = False) R11 | List[R11] | DataFrame | None[código-fonte]

Obtém um registro que contém as restrições de variação horária e diária no nível da Régua 11 existente no estudo especificado no Entdados

Parâmetros:

df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

R11 | list[R11] | pd.DataFrame | None

property rd: RD | None

Obtém o (único) registro que define as opções de representação da rede elétrica no estudo descrito pelo Entdados.

Retorna:

Um registro, se existir.

Tipo de retorno:

RD | None

re(codigo_restricao: int | None = None, dia_inicial: str | int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, dia_final: str | int | None = None, hora_final: int | None = None, meia_hora_final: int | None = None, df: bool = False) RE | List[RE] | DataFrame | None[código-fonte]

Obtém um registro que cadastra uma restrição elétrica existente no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_restricao (int | None) – código que especifica o registro da restrição elétrica

  • dia_inicial (int | str | None) – dia inicial

  • hora_inicial (int | None) – hora inicial

  • meia_hora_inicial – meia-hora inicial

  • dia_final (int | str | None) – dia final

  • hora_final (int | None) – hora final

  • meia_hora_final (int | None) – meia-hora final

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

RE | list[RE] | pd.DataFrame | None

ree(codigo_ree: int | None = None, codigo_submercado: int | None = None, nome_ree: str | None = None, df: bool = False) REE | List[REE] | DataFrame | None[código-fonte]

Obtém um registro que define os reservatórios equivalentes de energia existentes no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_ree (int | None) – código que especifica o registro do submercado

  • codigo_submercado (str | None) – código do submercado correspondente

  • nome_ree (int | None) – nome do REE

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

REE | list[REE] | pd.DataFrame | None

ri(df: bool = False) RI | List[RI] | DataFrame | None[código-fonte]

Obtém um registro que define restrições de Itaipu no estudo descrito pelo Entdados.

Parâmetros:

df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

RI | list[RI] | pd.DataFrame | None

rivar(codigo_entidade: int | None = None, tipo_variavel: int | None = None, df: bool = False) RIVAR | List[RIVAR] | DataFrame | None[código-fonte]

Obtém um registro que define a consideração de restrições internas do tipo “soft” de variação para variáveis do problema no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_entidade (int | None) – código da entidade

  • sistema_para (int | None) – sistema “para” quando aplicável

  • tipo_variavel (int | None) – tipo de variável

  • penalidade (float | None) – penalidade

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

RIVAR | list[RIVAR] | pd.DataFrame | None

secr(codigo_secao: int | None = None, nome_secao: str | None = None, df: bool = False) SECR | List[SECR] | DataFrame | None[código-fonte]

Obtém um registro que define as seções de rio no estudo especificado no Entdados

Parâmetros:
  • codigo_secao (int | None) – Código da seção

  • nome_secao (str | None) – Nome da seção

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

SECR | list[SECR] | pd.DataFrame | None

sist(codigo_submercado: int | None = None, nome_submercado: str | None = None, df: bool = False) SIST | List[SIST] | DataFrame | None[código-fonte]

Obtém um registro que define os submercados existentes no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_submercado (int | None) – código que especifica o registro do submercado

  • nome_submercado (str | None) – nome do submercado

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

SIST | list[SIST] | pd.DataFrame | None

tm(dia_inicial: int | None = None, hora_inicial: int | None = None, meia_hora_inicial: int | None = None, df: bool = False) TM | List[TM] | DataFrame | None[código-fonte]

Obtém um registro que define a discretização temporal e representação da rede elétrica no estudo descrito pelo Entdados.

Parâmetros:
  • dia_inicial (int | None) – dia inicial do período

  • hora_inicial (int | None) – hora inicial do período

  • meia_hora_inicial (int | None) – meia-hora inicial do período

  • duracao (int | None) – duração do período

  • duracao – flag para consideração da rede elétrica

  • nome_patamar (str | None) – nome do patamar de carga

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

TM | list[TM] | pd.DataFrame | None

tviag(codigo_usina_montante: int | None = None, codigo_elemento_jusante: int | None = None, tipo_elemento_jusante: str | None = None, duracao: int | None = None, tipo_tempo_viagem: int | None = None, df: bool = False) TVIAG | List[TVIAG] | DataFrame | None[código-fonte]

Obtém um registro que especifica os tempos de viagem da água entre uma UHE existente e um elemento a jusante no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_usina_montante (int | None) – Índice da UHE a montante com tempo de viagem

  • codigo_elemento_jusante (int | None) – Índice do elemento a jusante

  • tipo_elemento_jusante (str | None) – Tipo do elemento a jusante (seção ou UHE)

  • duracao (int | None) – duração, em horas, da viagem da água

  • tipo_tempo_viagem (int | None) – ìndice do tipo do tempo de viagem (translação ou propagação)

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

TVIAG | list[TVIAG] | pd.DataFrame | None

property tx: TX | None

Obtém o (único) registro que define a taxa de desconto aplicada no estudo definido no Entdados

Retorna:

Um registro, se existir.

Tipo de retorno:

TX | None.

uh(codigo_usina: int | None = None, nome_usina: str | None = None, codigo_ree: int | None = None, volume_inicial: float | None = None, evaporacao: int | None = None, df: bool = False) UH | List[UH] | DataFrame | None[código-fonte]

Obtém um registro que define uma usina hidrelétrica existente no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_usina (int | None) – índice do código que especifica o registro da UHE

  • nome_usina (str | None) – nome da UHE

  • codigo_ree (int | None) – índice do ree da UHE

  • volume_inicial (float | None) – volume inicial da UHE

  • evaporacao (int | None) – consideração da evaporação na UHE

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

UH | list[UH] | pd.DataFrame | None

usie(codigo_usina: int | None = None, codigo_submercado: int | None = None, nome_usina: str | None = None, codigo_usina_montante: int | None = None, codigo_usina_jusante: int | None = None, df: bool = False) USIE | List[USIE] | DataFrame | None[código-fonte]

Obtém um registro que define as usinas elevatórias da configuração e seus principais dados físicos no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_usina (int | None) – código que especifica a usina elevatória

  • codigo_submercado (str | None) – código do submercado correspondente

  • nome_usina (int | None) – nome da usina elevatória

  • codigo_usina_montante (int | None) – código da usina a montante

  • codigo_usina_jusante (int | None) – código da usina a jusante

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

USIE | list[USIE] | pd.DataFrame | None

ut(codigo_usina: int | None = None, nome_usina: str | None = None, codigo_submercado: int | None = None, tipo_restricao: int | None = None, geracao_minima: float | None = None, geracao_maxima: float | None = None, df: bool = False) UT | List[UT] | DataFrame | None[código-fonte]

Obtém um registro que define uma usina termelétrica existente no estudo descrito pelo Entdados.

Parâmetros:
  • codigo_usina (int | None) – índice do código que especifica o registro da UTE

  • nome_usina (str | None) – nome da UTE

  • codigo_submercado (int | None) – índice do submercado da UTE

  • tipo_restricao (int | None) – tipo de restrição

  • geracao_minima (float | None) – limite de geração mínima (ou, caso restrição de rampa, valor da variação máxima para decréscimo de geração)

  • geracao_maxima (float | None) – limite de geração máxima (ou, caso restrição de rampa, valor da variação máxima para acréscimo de geração)

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

UT | list[UT] | pd.DataFrame | None

ve(codigo_usina: int | None = None, df: bool = False) VE | List[VE] | DataFrame | None[código-fonte]

Obtém um registro que especifica o volume de espera por UHE existente no estudo especificado no Entdados

Parâmetros:
  • codigo_usina (int | None) – Código da usina

  • df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VE | list[VE] | pd.DataFrame | None

As informações existentes em cada um dos registros são armazenadas em modelos próprios para cada um. Os registros suportados até o momento são os utilizados nos estudos oficiais de operação:

class RD(previous=None, next=None, data=None)[código-fonte]

Registro que contém opções de representação da rede elétrica.

property carga_registro_dbar: int | None

O flag para executar um caso sem rede elétrica porém utilizando a carga declarada nos registros do bloco DBAR.

Retorna:

O flag.

Tipo de retorno:

int | None

property consideracao_perdas: int | None

O flag para consideração das perdas nos circuitos da rede elétrica.

Retorna:

O flag.

Tipo de retorno:

int | None

property formato_arquivos_rede: int | None

O flag para indicar o tipo de formato dos arquivos da rede elétrica.

Retorna:

O flag.

Tipo de retorno:

int | None

property limites_circuitos_e_drefs: int | None

O flag para não considerar restrições de limite de fluxo em circuitos e somatórios de fluxo independente dos níveis de tensão das barras.

Retorna:

O flag.

Tipo de retorno:

int | None

property limites_circuitos_transformadores_elevadores: int | None

O flag para não considerar os limites de fluxo em circuitos transformadores elevadores.

Retorna:

O flag.

Tipo de retorno:

int | None

property maximo_circuitos_violados: int | None

O número máximo de circuitos que podem ser violados, por período.

Retorna:

O número máximo de circuitos.

Tipo de retorno:

int | None

property variaveis_de_folga: int | None

O flag que define a inclusão de variáveis de folga nas restrições de rede elétrica.

Retorna:

O flag.

Tipo de retorno:

int | None

class RIVAR(previous=None, next=None, data=None)[código-fonte]

Registro que contém configurações para consideração de restrições soft de variação para as variáveis do problema.

property codigo_entidade: int | None

O código da entidade (hidrelétrica, termelétrica, elevatória, intercâmbio).

Retorna:

O número.

Tipo de retorno:

int | None

property penalidade: float | None

A penalidade a ser utilizada nas restrições.

Retorna:

A penalidade.

Tipo de retorno:

float | None

property sistema_para: int | None

O código do sistema “para” no caso de restrição de intercâmbio.

Retorna:

O código do sistema para.

Tipo de retorno:

int | None

property tipo_variavel: int | None

O código do tipo de variável.

Retorna:

O tipo de variável.

Tipo de retorno:

int | None

class TM(previous=None, next=None, data=None)[código-fonte]

Registro que contém a discretização temporal e representação da rede elétrica.

property consideracao_rede_eletrica: int | None

O flag para indicar conisderação da rede elétrica no período.

Retorna:

O flag.

Tipo de retorno:

int | None

property dia_inicial: int | None

O dia inicial do período.

Retorna:

O dia.

Tipo de retorno:

int | None

property duracao: float | None

A duração do período em horas.

Retorna:

A duração.

Tipo de retorno:

float | None

property hora_inicial: int | None

A hora inicial do período.

Retorna:

A hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial do período.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property nome_patamar: str | None

O nome do patamar de carga.

Retorna:

O patamar.

Tipo de retorno:

str | None

class SIST(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro dos submercados.

property codigo_submercado: int | None

O código de cadastro do submercado.

Retorna:

O código.

Tipo de retorno:

int | None]

property ficticio: int | None

O código de cadastro do submercado.

Retorna:

O código.

Tipo de retorno:

int | None]

property mnemonico_submercado: str | None

O mnemônico de cadastro do submercado.

Retorna:

O mnemônico.

Tipo de retorno:

str | None

property nome_submercado: str | None

O nome de cadastro do submercado.

Retorna:

O nome.

Tipo de retorno:

str | None

class REE(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro dos reservatórios equivalentes de energia.

property codigo_ree: int | None

O código de cadastro do REE.

Retorna:

O código.

Tipo de retorno:

int | None]

property codigo_submercado: int | None

O código do submercado que pertence o REE.

Retorna:

O código.

Tipo de retorno:

int | None]

property nome_ree: str | None

O nome de cadastro do REE.

Retorna:

O mnemônico.

Tipo de retorno:

str | None

class UH(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro das UHEs, com os seus volumes iniciais no estudo.

property codigo_ree: int | None

O REE de cadastro da UHE.

Retorna:

O REE.

Tipo de retorno:

int | None

property codigo_usina: int | None

O código de cadastro da UHE.

Retorna:

O código.

Tipo de retorno:

int | None

property dia_inicial: str | int | None

O dia inicial.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property evaporacao: int | None

A consideração ou não de evaporação para a UHE.

Retorna:

A consideração.

Tipo de retorno:

int | None

property hora_inicial: int | None

A hora inicial.

Retorna:

A hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property nome_usina: str | None

O nome da UHE.

Retorna:

O nome.

Tipo de retorno:

str | None

property penaliza_restricao_geracao: int | None

O flag que indica penalização de restrições de geração.

Retorna:

O flag.

Tipo de retorno:

int | None

property produtividade: int | None

O tipo de produtividade considerada.

Retorna:

O flag.

Tipo de retorno:

int | None

property volume_inicial: float | None

O volume inicial da UHE para o estudo.

Retorna:

O volume.

Tipo de retorno:

float | None

property volume_morto_inicial: float | None

Volume morto inicial da usina.

Retorna:

O volume em hm3.

Tipo de retorno:

float | None

class TVIAG(previous=None, next=None, data=None)[código-fonte]

Registro que contém os tempos de viagem da água entre usinas.

property codigo_elemento_jusante: int | None

O código do elemento a jusante do qual é contabilizado o tempo de viagem.

Retorna:

O código

Tipo de retorno:

int | None

property codigo_usina_montante: int | None

O código da UHE a montante a partir do qual é contabilizado o tempo de viagem.

Retorna:

O código

Tipo de retorno:

int | None

property duracao: int | None

A duração da viagem da água (em horas) entre a UHE a montante e o elemento à jusante.

Retorna:

A duração

Tipo de retorno:

int | None

property tipo_elemento_jusante: str | None

O tipo de elemento de jusante (S=seção de rio, H=usina).

Retorna:

O código

Tipo de retorno:

str | None

property tipo_tempo_viagem: int | None

O código referente ao tipo de tempo de viagem considerado (1=translação; 2=propagação).

Retorna:

O código do tipo.

Tipo de retorno:

int | None

class UT(previous=None, next=None, data=None)[código-fonte]

Registro que contém as usinas termelétricas e suas restrições de geração.

property codigo_submercado: int | None

O submercado de cadastro da UTE.

Retorna:

O submercado.

Tipo de retorno:

int | None

property codigo_usina: int | None

O código de cadastro da UTE.

Retorna:

O código.

Tipo de retorno:

int | None

property dia_final: str | int | None

O dia final.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property dia_inicial: str | int | None

O dia inicial.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property geracao_maxima: float | None

O valor do limite de geracao máxima (caso restrição de rampa, é o valor da variação máxima para acréscimo de geração).

Retorna:

O valor.

Tipo de retorno:

float | None

property geracao_minima: float | None

O valor do limite de geracao minima (caso restrição de rampa, é o valor da variação máxima para decréscimo de geração).

Retorna:

O valor.

Tipo de retorno:

float | None

property hora_final: int | None

A hora final.

Retorna:

A hora.

Tipo de retorno:

int | None

property hora_inicial: int | None

A hora inicial.

Retorna:

A hora.

Tipo de retorno:

int | None

property meia_hora_final: int | None

A meia-hora final.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property nome_usina: str | None

O nome de cadastro da UTE.

Retorna:

O nome como uma str.

Tipo de retorno:

str | None

property tipo_restricao: int | None

O flag para indicar tipo de restrição.

Retorna:

O flag.

Tipo de retorno:

int | None

property unidade_restricao: int | None

O flag para indicar a unidade da restrição de rampa.

Retorna:

O flag.

Tipo de retorno:

int | None

class USIE(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro das usinas elevatórias.

property codigo_submercado: int | None

O submercado de cadastro da UE.

Retorna:

O submercado.

Tipo de retorno:

int | None

property codigo_usina: int | None

O código de cadastro da UE.

Retorna:

O código.

Tipo de retorno:

int | None

property codigo_usina_jusante: int | None

O código da UHE a jusante, conforme registro UH.

Retorna:

O código.

Tipo de retorno:

int | None

property codigo_usina_montante: int | None

O código da UHE a montante, conforme registro UH.

Retorna:

O código.

Tipo de retorno:

int | None

property nome_usina: str | None

O nome da usina elevatória.

Retorna:

O nome.

Tipo de retorno:

str | None

property taxa_consumo: float | None

A taxa de consumo.

Retorna:

A taxa em MWmed/m3/s.

Tipo de retorno:

float | None

property vazao_maxima_bombeavel: float | None

A vazão mínima bombeável.

Retorna:

A vazão em m3/s

Tipo de retorno:

float | None

property vazao_minima_bombeavel: float | None

A vazão mínima bombeável.

Retorna:

A vazão em m3/s

Tipo de retorno:

float | None

class DP(previous=None, next=None, data=None)[código-fonte]

Registro que as demandas para os submercados que serão consideradas para os períodos em que não se considerada a rede elétrica.

property codigo_submercado: int | None

O submercado associado à demanada especificada.

Retorna:

O submercado.

Tipo de retorno:

int | None

property demanda: float | None

A demanda em Mwmed para o período especificado

Retorna:

A demanda.

Tipo de retorno:

float | None

property dia_final: str | int | None

O dia final.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property dia_inicial: str | int | None

O dia inicial.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property hora_final: int | None

A hora final.

Retorna:

A hora.

Tipo de retorno:

int | None

property hora_inicial: int | None

A hora inicial.

Retorna:

A hora.

Tipo de retorno:

int | None

property meia_hora_final: int | None

A meia-hora final.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

class DE(previous=None, next=None, data=None)[código-fonte]

Registro que as demandas especiais para serem representadas em restrições elétricas do tipo RE.

property codigo_demanda_especial: int | None

O código da demanda especial.

Retorna:

O código.

Tipo de retorno:

int | None

property demanda: float | None

A demanda em Mwmed para o período especificado

Retorna:

A demanda.

Tipo de retorno:

float | None

property dia_final: str | int | None

O dia final.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property dia_inicial: str | int | None

O dia inicial.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property hora_final: int | None

A hora final.

Retorna:

A hora.

Tipo de retorno:

int | None

property hora_inicial: int | None

A hora inicial.

Retorna:

A hora.

Tipo de retorno:

int | None

property justificativa: str | None

A descrição ou justificativa.

Retorna:

A justificativa.

Tipo de retorno:

str | None

property meia_hora_final: int | None

A meia-hora final.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

class CD(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro dos custos de déficit.

property codigo_submercado: int | None

O índice do submercado associado.

Retorna:

O submercado.

Tipo de retorno:

int | None

property custo: float | None

O custo de déficit.

Retorna:

O custo.

Tipo de retorno:

float | None

property dia_final: str | int | None

O dia final.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property dia_inicial: str | int | None

O dia inicial.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property hora_final: int | None

A hora final.

Retorna:

A hora.

Tipo de retorno:

int | None

property hora_inicial: int | None

A hora inicial.

Retorna:

A hora.

Tipo de retorno:

int | None

property limite_superior: float | None

O limite superior para consideração dos custos.

Retorna:

O limite.

Tipo de retorno:

float | None

property meia_hora_final: int | None

A meia-hora final.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property numero_curva: int | None

O número da curva de déficit.

Retorna:

O índice da curva.

Tipo de retorno:

int | None

class PQ(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro da geração por pequenas usinas.

property codigo_usina: str | None

O código da pequena usina.

Retorna:

O código.

Tipo de retorno:

str | None

property dia_final: str | int | None

O dia final.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property dia_inicial: str | int | None

O dia inicial.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property geracao: float | None

A geração da pequena usina.

Retorna:

A geração.

Tipo de retorno:

float | None

property hora_final: int | None

A hora final.

Retorna:

A hora.

Tipo de retorno:

int | None

property hora_inicial: int | None

A hora inicial.

Retorna:

A hora.

Tipo de retorno:

int | None

property localizacao: int | None

O indice do subsistema ou barra associado à geração.

Retorna:

O índice da localização.

Tipo de retorno:

int | None

property meia_hora_final: int | None

A meia-hora final.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property nome_usina: str | None

O nome da pequena usina.

Retorna:

O nome.

Tipo de retorno:

str | None

class IT(previous=None, next=None, data=None)[código-fonte]

Registro que contém os coeficientes do polinômio do canal de fuga de Itaipu em função da vazão na Régua 11, para casos sem FPHA Libs.

property codigo_ree: int | None

O código do REE em que se encontra a usina de Itaipu.

Retorna:

O ree.

Tipo de retorno:

int | None

property coeficiente_a0: float | None

O coeficiente de grau 0 do polinômio.

Retorna:

O coeficiente.

Tipo de retorno:

float | None

property coeficiente_a1: float | None

O coeficiente de grau 1 do polinômio.

Retorna:

O coeficiente.

Tipo de retorno:

float | None

property coeficiente_a2: float | None

O coeficiente de grau 2 do polinômio.

Retorna:

O coeficiente.

Tipo de retorno:

float | None

property coeficiente_a3: float | None

O coeficiente de grau 3 do polinômio.

Retorna:

O coeficiente.

Tipo de retorno:

float | None

property coeficiente_a4: float | None

O coeficiente de grau 4 do polinômio.

Retorna:

O coeficiente.

Tipo de retorno:

float | None

class RI(previous=None, next=None, data=None)[código-fonte]

Registro que contém as restrições de Itaipu.

property carga_ande: float | None

A carga da ANDE.

Retorna:

A carga.

Tipo de retorno:

float | None

property dia_final: str | int | None

O dia final.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property dia_inicial: str | int | None

O dia inicial.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property geracao_maxima_50hz: float | None

O limite superior para a geração 50 Hz de Itaipu.

Retorna:

O limite.

Tipo de retorno:

float | None

property geracao_maxima_60hz: float | None

O limite superior para a geração 60 Hz de Itaipu.

Retorna:

O limite.

Tipo de retorno:

float | None

property geracao_minima_50hz: float | None

O limite inferior para a geração 50 Hz de Itaipu.

Retorna:

O limite.

Tipo de retorno:

float | None

property geracao_minima_60hz: float | None

O limite inferior para a geração 60 Hz de Itaipu.

Retorna:

O limite.

Tipo de retorno:

float | None

property hora_final: int | None

A hora final.

Retorna:

A hora.

Tipo de retorno:

int | None

property hora_inicial: int | None

A hora inicial.

Retorna:

A hora.

Tipo de retorno:

int | None

property meia_hora_final: int | None

A meia-hora final.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

class IA(previous=None, next=None, data=None)[código-fonte]

Registro que contém os limites de intercâmbio entre os subsistemas.

property capacidade_de: float | None

A capacidade do intercâmbio do submercado de ao submercado para.

Retorna:

A capacidade.

Tipo de retorno:

float | None

property capacidade_para: float | None

A capacidade do intercâmbio do submercado para ao submercado de.

Retorna:

A capacidade.

Tipo de retorno:

float | None

property dia_final: str | int | None

O dia final.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property dia_inicial: str | int | None

O dia inicial.

Retorna:

O dia.

Tipo de retorno:

str | int | None

property hora_final: int | None

A hora final.

Retorna:

A hora.

Tipo de retorno:

int | None

property hora_inicial: int | None

A hora inicial.

Retorna:

A hora.

Tipo de retorno:

int | None

property meia_hora_final: int | None

A meia-hora final.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property meia_hora_inicial: int | None

A meia-hora inicial.

Retorna:

A meia-hora.

Tipo de retorno:

int | None

property nome_submercado_de: str | None

O submercado de origem (de).

Retorna:

O submercado.

Tipo de retorno:

str | None

property nome_submercado_para: str | None

O submercado de destino (para).

Retorna:

O submercado.

Tipo de retorno:

str | None

class GP(previous=None, next=None, data=None)[código-fonte]

Registro que contém os gaps de tolerância para convergência para os métodos PDD ou MILP.

property gap_milp: float | None

O gap de convergência do problema por programação linear inteira mista (MILP).

Retorna:

O gap.

Tipo de retorno:

float | None

property gap_pdd: float | None

O gap de convergência do processo iterativo de programação dinâmica dual (PDD).

Retorna:

O gap.

Tipo de retorno:

float | None

class ACVTFUGA(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para consideração da influência do vertimento no canal de fuga.

write(file: IO, storage: str = '', *args, **kwargs) bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:

file (IO) – The filepointer

Retorna:

The success, or not, in the writing

Tipo de retorno:

bool

class ACVOLMAX(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração de volume máximo.

write(file: IO, storage: str = '', *args, **kwargs) bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:

file (IO) – The filepointer

Retorna:

The success, or not, in the writing

Tipo de retorno:

bool

class ACVOLMIN(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração de volume mínimo.

write(file: IO, storage: str = '', *args, **kwargs) bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:

file (IO) – The filepointer

Retorna:

The success, or not, in the writing

Tipo de retorno:

bool

class ACVSVERT(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do volume mínimo para operação do vertedor.

write(file: IO, storage: str = '', *args, **kwargs) bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:

file (IO) – The filepointer

Retorna:

The success, or not, in the writing

Tipo de retorno:

bool

class ACVMDESV(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do volume mínimo para operação do canal de desvio.

write(file: IO, storage: str = '', *args, **kwargs) bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:

file (IO) – The filepointer

Retorna:

The success, or not, in the writing

Tipo de retorno:

bool

class ACCOTVAZ(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração de um coeficiente do polinômio cota-vazão.

write(file: IO, storage: str = '', *args, **kwargs) bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:

file (IO) – The filepointer

Retorna:

The success, or not, in the writing

Tipo de retorno:

bool