Skip to content

Commit 590882c

Browse files
MARIO31XDMARIO31XD
committed
how to usage imarina and Reference in developer guide in process TODO
1 parent f4df6c3 commit 590882c

2 files changed

Lines changed: 167 additions & 0 deletions

File tree

‎_posts/iMarina/Developer-Guide/2026-05-14-How-To-Usage-iMarina.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: default
3+
title: Guía de como usar iMarina
4+
permalink: /iMarina/Developer-Guide/How-To-Usage-iMarina
5+
parent: Developer Guide
6+
---
7+
8+
# Guia de uso de iMarina para el Desarrollador
9+
10+
El objetivo de esta guía es mostrar como se usa correctamente iMarina.
11+
12+
## Obtención traducción de los Excels
13+
Por defecto se leen estos Excels desde la carpeta `input/ folder` pero puedes cambiar la ubicación de estos archivos utilizando los siguientes argumentos.
14+
15+
```shell
16+
--imarina-input /path/to/iMarina.xlsx
17+
--a3-input /path/to/A3.xlsx
18+
--countries-dict /path/to/countries.xlsx
19+
--jobs-dict /app/input/Job_Descriptions.xlsx
20+
```
21+
22+
Puedes descargar manualmente los Excels necesarios desde el [Sharepoint(carpeta input)](https://iciq.sharepoint.com/sites/digitalitzacio-InstitutionalStrengthening).
23+
24+
También puedes utilizar el `OneDrive` en el contenedor de **Docker** para sincronizar los archivos del SharePoint en tu máquina de forma automática en segundo plano.
25+
26+
## Ejecutar main
27+
Para iniciar el programa **main** debes ejecutar el siguiente comando con el argumento `--imarina-input`
28+
29+
```shell
30+
./venv/bin/python -m imarina --step build --imarina-input ./input/iMarina.xlsx
31+
```
32+
33+
<!-- TODO-->

‎_posts/iMarina/Developer-Guide/2026-05-15-Reference.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
layout: default
3+
title: Guía de como usar iMarina
4+
permalink: /iMarina/Developer-Guide/Reference
5+
parent: Developer Guide
6+
---
7+
8+
9+
# Referencia API
10+
11+
El objetivo de esta referencia es documentar tanto argumentos de la **CLI** como definir los **Excels** utilizados y su estructura para el proyecto
12+
con sus respectivas carpetas `INPUT` y `OUTPUT`.
13+
Como deben ser estos `Excels` y porque se guardan en las carpetas del SharePoint.
14+
15+
16+
## CLI
17+
La **Command Line Interface** es muy importante en el proyecto de iMarina.
18+
Estos son los comandos a ejecutar:
19+
20+
```shell
21+
# argumentos a ejecutar en la CLI
22+
venv/bin/python3 -m imarina download
23+
venv/bin/python3 -m imarina build
24+
venv/bin/python3 -m imarina upload
25+
```
26+
27+
### Download
28+
29+
El comando `Download` descarga todos los Excels de la carpeta input del SharePoint.
30+
31+
### Build
32+
33+
El comando `Build` une los Excels de A3 y de iMarina y genera el último Excel de upload (con la fecha en la cuál se ha generado).
34+
35+
### Upload
36+
37+
El comando `Upload` sube a la carpeta Output el Excel generado tras ejecutar el comando Build.
38+
39+
40+
## INPUT
41+
En la carpeta Input del SharePoint se encuentran los Excels de A3 y de iMarina.
42+
43+
### A3 Excel
44+
45+
Es el Excel que nos facilita `RRHH`, contiene la información de los `Researchers` en los siguientes 19 campos:
46+
47+
> A continuación muestro el orden de los campos que debe seguir el Excel de principio a fin.
48+
49+
* Codigo empleado
50+
* Codigo Centro
51+
* Nombre
52+
* Primer Apellido
53+
* Segundo Apellido
54+
* NIF
55+
* Sexo
56+
* Nacionalidad
57+
* Pais Nacimiento
58+
* Email
59+
* Puesto de trabajo
60+
* Grupo Unidad
61+
* Fecha Antigüedad
62+
* ORCID
63+
* Fecha Inicio Contrato
64+
* Fecha Fin Contrato
65+
* Fecha Inicio Prórroga
66+
* Fecha Fin Prórroga
67+
* Fecha de baja en compañía
68+
69+
70+
Hay `Researchers` que tendrán algunos campos vacíos **sobretodo fechas** pero no afecta en absoluto a gestión de los datos.
71+
72+
73+
### iMarina Excel
74+
Este Excel contiene los datos actualizados de los `Researchers` y muchos más campos que en A3:
75+
76+
> Orden correcto de los campos del iMarina Excel
77+
* Code
78+
* Nombre
79+
* Primer Apellido
80+
* Segundo Apellido
81+
* signature
82+
* signature_custom
83+
* DNI/NIE/NIF
84+
* Fecha de Nacimiento
85+
* Sexo
86+
* Pais de Nacimiento
87+
* Ciudad de Nacimiento
88+
* Región/Comunidad de Nacimiento
89+
* Correo Electrónico
90+
* Web Personal
91+
* Tipo de Contrato
92+
* Tipo de Adscripción
93+
* Categoria Investigadora / Docente
94+
* Dedicación
95+
* Fecha de Inicio
96+
* Fecha de Fin
97+
* id_1
98+
* Tipo de Entidad
99+
* País de la Entidad
100+
* Región de la Entidad
101+
* Provincia de la Entidad
102+
* Ciudad de la Entidad
103+
* Codigo Postal de la Entidad
104+
* Dirección de la Entidad
105+
* Web de la Entidad
106+
* Tipo de Entidad Nivel 2
107+
* Entidad (Nivel 2)
108+
* id_2
109+
* Entidad (Nivel 3)
110+
* id_3
111+
* ORCID
112+
* ResearchID
113+
* AuthorID(Scopus)
114+
* DialnetID
115+
* Google Scholar ID
116+
* Telefono de Contacto
117+
118+
119+
También hay campos completamente vacios ya que no es obligatorio rellenarlos todos
120+
(no todos los Researchers tienen todos los datos anotados).
121+
122+
123+
124+
## OUTPUT
125+
Después de la fusión del `Excel` de A3 y el de iMarina, esta unión genera el último Excel de Upload que se guarda en la carpeta Output del SharePoint.
126+
127+
Esto ha unido campos que no estaban A3 junto a los campos de iMarina, pero con los datos totalmente curados y actualizados.
128+
129+
Excel final de Upload (en la carpeta OutPut)
130+
131+
<!-- TODO-->
132+
133+
134+

0 commit comments

Comments
 (0)