Metadata-Version: 2.4
Name: idessem
Version: 1.2.1
Summary: Pacote Python para manipulacao dos arquivos de entrada e saida do DESSEM
Project-URL: Documentation, https://rjmalves.github.io/idessem/
Project-URL: Repository, https://github.com/rjmalves/idessem/
Author-email: Rogerio Alves <rogerioalves.ee@gmail.com>, Mariana Noel <marianasimoesnoel@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Rogerio Alves
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: cfinterface>=1.9.0
Requires-Dist: numpy>=2.2.1
Requires-Dist: pandas>=3.0.0
Provides-Extra: dev
Requires-Dist: furo; extra == 'dev'
Requires-Dist: matplotlib; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: numpydoc; extra == 'dev'
Requires-Dist: plotly; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-xdist; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-gallery; extra == 'dev'
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: matplotlib; extra == 'docs'
Requires-Dist: numpydoc; extra == 'docs'
Requires-Dist: plotly; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-gallery; extra == 'docs'
Provides-Extra: lint
Requires-Dist: mypy; extra == 'lint'
Requires-Dist: pre-commit; extra == 'lint'
Requires-Dist: ruff; extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-xdist; extra == 'test'
Description-Content-Type: text/markdown

# idessem

> Pacote Python para leitura e escrita dos arquivos de entrada e saída do modelo DESSEM.

[![CI](https://github.com/rjmalves/idessem/actions/workflows/main.yml/badge.svg)](https://github.com/rjmalves/idessem/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/rjmalves/idessem/branch/main/graph/badge.svg?token=HA31U1FWM4)](https://codecov.io/gh/rjmalves/idessem)
[![PyPI version](https://img.shields.io/pypi/v/idessem)](https://pypi.org/project/idessem/)
[![Python versions](https://img.shields.io/pypi/pyversions/idessem)](https://pypi.org/project/idessem/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Documentacao](https://img.shields.io/badge/docs-online-blue)](https://rjmalves.github.io/idessem/)

O `idessem` é um pacote Python para manipulação dos arquivos de entrada e saída do modelo [DESSEM](https://www.cepel.br/linhas-de-pesquisa/dessem/), desenvolvido pelo [CEPEL](http://www.cepel.br) e utilizado para a programação da operação do Sistema Interligado Nacional (SIN).

## Funcionalidades

- Leitura e escrita dos arquivos de entrada e saída do DESSEM, com suporte a mais de 43 classes de arquivos no módulo `dessem` e utilitários no módulo `libs`
- Dados tabulares expostos como `DataFrame` do [pandas](https://pandas.pydata.org/), prontos para análise e visualização
- Interface orientada a objetos consistente: cada arquivo corresponde a uma classe com método `read` e, quando aplicável, método `write`
- Modelos estruturados com tipagem estática, compatíveis com ferramentas de análise estática e autocompletar em IDEs

## Exemplo Rapido

Leitura do arquivo de entrada `entdados.dat` e acesso aos dados de usinas hidráulicas como DataFrame:

```python
from idessem.dessem.entdados import Entdados

arq = Entdados.read("./entdados.dat")
df_uh = arq.uh(df=True)
```

Leitura de um arquivo de saída e acesso aos dados de operação:

```python
from idessem.dessem.pdo_sist import PdoSist

arq_sist = PdoSist.read("./PDO_SIST.DAT")
arq_sist.tabela
```

## Instalacao

O `idessem` é compatível com Python 3.11, 3.12, 3.13 e 3.14.

Instalação a partir do PyPI:

```
pip install idessem
```

Instalação da versão de desenvolvimento diretamente do repositório:

```
pip install git+https://github.com/rjmalves/idessem
```

## Documentacao

A documentação completa do pacote está disponível em [rjmalves.github.io/idessem](https://rjmalves.github.io/idessem/) e inclui:

- [Tutorial](https://rjmalves.github.io/idessem/geral/tutorial.html) — exemplos de leitura, escrita e modificação de arquivos
- [Arquitetura](https://rjmalves.github.io/idessem/geral/arquitetura.html) — estrutura interna do pacote e do framework cfinterface
- [Perguntas Frequentes](https://rjmalves.github.io/idessem/geral/faq.html) — dúvidas comuns dos usuários
- [Guia de Desempenho](https://rjmalves.github.io/idessem/geral/desempenho.html) — características de performance e resultados de benchmarks
- [Referencia da API](https://rjmalves.github.io/idessem/referencia) — documentação de todas as classes e propriedades públicas

## Contribuindo

Contribuições são bem-vindas. Consulte o arquivo [CONTRIBUTING.md](CONTRIBUTING.md) para instruções sobre como configurar o ambiente de desenvolvimento, executar os testes e enviar pull requests.

## Licenca

Distribuído sob a licença [MIT](LICENSE.md).
