Metadata-Version: 2.4
Name: atlas_ipea
Version: 0.1.0
Summary: Matrizes inter-regionais e tabelas de recursos e usos do Ipea
Author: Felipe Morelli
Keywords: ipea,mip,mai,tru,input-output,economics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.24

# atlas_ipea

`atlas_ipea` e um pacote Python para distribuir, carregar e inspecionar bases
inter-regionais do Ipea empacotadas em arquivos `.npz`.

O pacote foi pensado para uso direto em analises com NumPy, sem exigir que o
usuario localize manualmente os arquivos de dados dentro do projeto.

## Conteudo

As seguintes bases estao incluidas no pacote:

- `mip`
- `mai`
- `tru_recursos`
- `tru_usos`
- `dicionario`

## Instalacao

Instalacao local a partir do codigo-fonte:

```bash
python -m pip install -e .
```

Se preferir uma instalacao nao editavel:

```bash
python -m pip install .
```

## Uso rapido

```python
import atlas_ipea as ai

print(ai.datasets())
# ('mip', 'mai', 'tru_recursos', 'tru_usos', 'dicionario')

print(ai.variables("mip")[:5])

arr = ai.load("CI_nac_iknj", dataset_name="mip")
print(arr.shape, arr.dtype)
```

## API principal

### `datasets()`

Retorna os nomes das bases disponiveis.

```python
import atlas_ipea as ai

ai.datasets()
```

### `variables(dataset_name)`

Lista as variaveis existentes em uma base especifica.

```python
ai.variables("tru_usos")
```

### `load(variable_name, dataset_name=None)`

Carrega uma variavel individual como `numpy.ndarray`.

Quando `dataset_name` nao e informado, o pacote procura a variavel em todas as
bases. Se ela existir em mais de uma, uma excecao e levantada para evitar
ambiguidade.

```python
ai.load("CI_nac_iknj", dataset_name="mip")
```

### `dataset(dataset_name)`

Carrega todas as variaveis de uma base e retorna um dicionario
`dict[str, numpy.ndarray]`.

```python
mip = ai.dataset("mip")
print(mip.keys())
```

### `describe(dataset_name)`

Retorna um resumo com nome, formato, tipo e tamanho aproximado das variaveis de
uma base.

```python
summary = ai.describe("mai")
print(summary[:2])
```

### `find(variable_name)`

Informa em quais bases uma variavel aparece.

```python
ai.find("CI_nac_iknj")
```

## Observacoes

- O pacote requer Python 3.10 ou superior.
- As estruturas sao retornadas como `numpy.ndarray`.
- Os arquivos `.npz` sao distribuidos junto com o pacote.
