# Paralelización de simulación de permeabilidad

## Clonar este repositorio

```
# Por HTTPS
git clone https://git.csc.gob.ar/ssantisi/simulacion-permeabilidad.git
# Por SSH
git clone git@git.csc.gob.ar:ssantisi/simulacion-permeabilidad.git
```

Entrar a la carpeta del proyecto

```
cd simulacion-permeabilidad
```

## Habilitar NIX e ingresar a entorno

```
enable_nix
nix-shell
```

Para más info ver el archivo `shell.nix`. 

## Instalación de las librerías (Python 3) 

Como requisitos previos a la instalación hace falta tener:

**(Si se usa `nix-shell` ya están provistas estas dependencias)**

 * `python3`
 * `python3-pip`
 * `gfortran`
 * `gcc`
 * `build-essentials`

```
make install
```

El instalador genera un entorno virtual en `venv`.

Para activar el entorno virtual:

```
source venv/bin/activate
```

Para desactivarlo `deactivate`.


## Correr la simulación

```
make run
```

## Correr los casos de prueba

```
make test
```

## Correr las pruebas de performance

```
make perf
```

## Branches de github

Explicacion sobre las branches que quedaron en github para entender cuales usar:

- `main` -> solo la migracion a python3 sin ninguna cambio sobre el modulo de FFTMA (sin mejoras)

- `improvement_NOMBRE` -> branch con el `NOMBRE` de la mejora que esta explicado que hace cada una en el analisis

donde la primera es `remove_generate_array` y la ultima es `multiple_buffers`

- `improvement_NOMBRE-logs` -> misma branch de mejora pero agregando informacion de logs que se utilizo para realizar los analisis y no deberian utilizarse porque degradan la performance considerablemente.

- `migrate_fortran` -> una branch donde se trato de migrar de fortran a C pero quedo inconcluso el trabajo y no se continuo.