PAC4 - Embassaments

Exercici 4 de Programació per a la ciència de dades.

Estructura del projecte

pac4/
│
|
├── data/
|
├── main.py
|
├── scripts/
│     ├── exercici1.py
│     ├── exercici2.py
│     ├── exercici3.py
│     ├── exercici4.py
│     └── exercici5.py
│
├── tests/                # Tests unitaris
│
├── doc/                  # Documentació generada amb pdoc
│
├── screenshots/          # Captures de pantalla del projecte
│
├── enviroment.yml        # Llibreries necessàries
├── LICENSE               # Llicència del projecte
└── README.md             # Aquest fitxer

El projecte té una estructura com la mostrada. Al directori principal es troba aquest document, la llicència, l'arxiu main.py per executar i finalment el arxiu enviroment.yml que facilita el funcionament del projecte.

Instal·lació

Un cop dins la carpeta pac4, executar el següent per crear el enviroment:

mamba create env -f enviroment.yml
mamba activate pac4

Amb aquest ambient ja podrem executar el projecte sense cap problema.

Execució

De cara a poder executar el arxiu hem de fer servir el següent comando:

python main.py

Una vegada executat, a la terminal es mostrarà tot el contingut de cada exercici i també s'haurà creat la carpeta img/ on en aquesta hi haurà els dos plots generats en els exercicis 3 i 4.

A més a més, també hi ha opcions de línia de comandes. A través de les opcions -h o --help es pot obtenir tota la informació de les línies de comanda. Alhora, a través de -ex es pot indicar fins a quin exercici es vol executar el codi.

python main.py -ex 4

Aquest codi executa tot fins el exercici 4, per tant, no executa el exercici 5.

Tests i cobertura

Per comprovar que els exercicis funcionen correctament s'han generat una sèrie de tests que es poden executar i d'aquesta manera ens assegurem que tot està funcionant correctament.

coverage run -m pytest
coverage report

Linter

Per poder seguir una guia d'estil de Python (PEP8) es fa servir pylint. A més a més també es fa servir black per poder comprovar que tot està correcte.

pylint scripts/
black .

Cal recalcar que en aquest document només es mostra com s'ha fet servir per poder seguir la guia d'estil en la carpeta scripts. Tanmateix, s'ha seguit el mateix format per les altres carpetes que contenien arxius de Python alhora que l'arxiu main.py.

Generar documentació

Finalment, s'ha generat un document html amb la documentació dels docstrings de cada exercici.

pdoc -o doc scripts