Sondaggio

Guida alla compilazione

Il Gruppo di Lavoro PoliSoft ha avviato il primo censimento del software prodotto all’interno dell’Istituto Nazionale di Geofisica e Vulcanologia.

Attenzione: Questo sondaggio è riservato al personale dipendente dell'INGV.

Quale “Software” ha senso mappare?

Non stiamo cercando solo software pubblici, pacchettizzati e con documentazione perfetta. L’obiettivo del sondaggio è mappare tutto il software che ha senso poter condividere con altri (siano essi colleghi o la comunità esterna) e che vorresti veder valorizzato nel futuro “Registro Software” istituzionale. Questo Registro aiuterà chi desidera condividere il proprio lavoro a pubblicizzarlo efficacemente, garantendo il giusto riconoscimento e credito a tutte le persone che vi hanno contribuito. Questo include:

  • Software scientifico e modelli numerici.
  • Sistemi di acquisizione e monitoraggio.
  • Software per la divulgazione, il public engagement, educational.
  • Script di analisi dati (Python, R, Bash, MATLAB, ecc.).
  • Procedure automatizzate, pipeline e tool di conversione.
  • Web app, servizi web, plugin (es. per QGIS) e librerie.
  • Software amministrativo o gestionale interno.
  • Codice sviluppato nell’ambito di progetti o tesi.

Anche se il tuo codice è a “uso interno”, “in via di sviluppo” o “legacy” (vecchio ma ancora in uso), ti chiediamo di segnalarlo se ritieni possa essere utile ad altri.

Come accedere e primi passi nel sistema

Vai all’indirizzo https://software.ingv.it/metadata/ e accedi utilizzando il tuo account istituzionale Google Workspace (nome.cognome@ingv.it).

Appena effettuato l’accesso, il sistema ti chiederà di scegliere la modalità di utilizzo dell’editor:

  • Sola consultazione: per navigare e visualizzare le schede in modalità sola lettura.
  • Abilita modifiche per i record di cui sei referente: seleziona questa opzione per poter aggiungere o modificare le tue schede descrittive.

Il metadata editor utilizzato per questo censimento è lo stesso editor impiegato per il Registro Dati. Chi ha già utilizzato quel portale si troverà in un ambiente familiare, poiché si tratta esattamente dello stesso strumento.

Nota: Quando si entra abilitando le modifiche e non si è ancora creata nessuna scheda, il sistema potrebbe avvisare che nessuna scheda è stata trovata: si tratta di un normale avviso, puoi ignorarlo tranquillamente.

Flusso di lavoro per inserire i tuoi software

  1. Un software, una scheda: Va creata una scheda di metadati distinta per ciascun software che si vuole aggiungere.
  2. Creare un nuovo record: Per iniziare, clicca sul bottone “New record” situato in basso a sinistra, sotto l’elenco dei software già presenti.
  3. Inizializzare la scheda: Inizia inserendo le informazioni base, come il Titolo e poco altro. Fatto ciò, crea effettivamente la scheda nel sistema cliccando sul bottone “Create” che trovi in fondo alla pagina, in basso a destra.
  4. Completare la compilazione: Solo dopo aver premuto “Create”, la scheda si sbloccherà e potrà essere compilata in ogni sua singola parte (ad esempio, potrai aggiungere autori, link e dettagli tecnici).
  5. Salvataggio manuale: Attenzione, il salvataggio dei dati non è automatico! Ti consigliamo di salvare spesso la scheda cliccando sul bottone “Save” in fondo alla pagina per evitare di perdere il lavoro fatto. Non aspettare di aver compilato ogni minimo dettaglio prima di salvare la prima volta.

Istruzioni per la compilazione

Il form è diviso in 14 sezioni. Non preoccuparti se non hai tutte le informazioni subito a disposizione: salvando regolarmente, potrai mantenere delle bozze (Draft) e completarle in seguito.

1. Basic information

Inserisci le informazioni base per identificare il software: il Titolo, l’eventuale Acronimo, la lingua principale dell’interfaccia, la versione corrente e l’anno di pubblicazione (o creazione). Molto importante è lo Status: puoi specificare se il software è up and running (operativo), in development (in sviluppo/instabile) o legacy (vecchio ma ancora in uso).

2. Other titles

Se il software ha un nome tradotto in altre lingue (es. italiano/inglese) o dei sottotitoli descrittivi, puoi inserirli in questa sezione. Se non ne ha, puoi tranquillamente saltare questo passaggio.

3. Authorship

Chi ha scritto il codice? Qui puoi distinguere tra Main authors (gli autori e ideatori principali) e Contributors (chi ha contribuito in misura minore o in ruoli specifici come Project Manager, Tester, ecc.).

Nota: questa come tutte le altre liste della scheda può essere modificata solo dopo aver cliccato “Create” la prima volta.

4. Digital Object Identifier (DOI)

Il software ha già un DOI associato (ad esempio tramite Zenodo)? Se la risposta è affermativa inseriscilo qui. Se non lo ha, ma ti piacerebbe ottenerne uno per poter citare ufficialmente il tuo software nelle pubblicazioni, spunta la casella “Software has no DOI, I want one”.

Attenzione: il DOI può essere assegnato solo ad una versione che non cambia nel tempo e deve essere chiaramente identificabile (una release, una versione specifica identificata con checksum…). Il DOI deve quindi puntare ad una landing page dove questa versione del software sia trovabile.

5. Info specific to INGV

Questa sezione mappa il software all’interno della struttura dell’Ente. Seleziona i Dipartimenti INGV coinvolti (Terremoti, Vulcani, Ambiente).

Indica lo Scientific Manager e il Technical Manager (possono coincidere nella stessa persona). Puoi anche delegare altri colleghi ad aggiornare la scheda di metadati in futuro (Additional users).

6. Detailed information

Questa è la sezione tecnica. Indica il Purpose (Ricerca, Servizio, Amministrazione, Disseminazione, Script di processamento, ecc.). Specifica il linguaggio di programmazione (es. Python, C++, Fortran), lo stack tecnologico, le dipendenze esterne, il sistema operativo supportato e i requisiti minimi di hardware, se rilevanti.

7. Temporal information

Inserisci una stima delle date fondamentali della vita del software: la data di creazione (Creation date), da quando è disponibile all’uso (Available since) e, se si tratta di un software dismesso, la data del suo ritiro (Withdrawn date). Se non ricordi i giorni esatti, puoi inserire un’approssimazione o almeno l’anno.

8. Software Access and Distribution

Come si accede al software? Specifica il tipo di accesso (anonimo, registrato, autorizzato). Indica se esiste una pagina web descrittiva (Landing page) e, soprattutto, la piattaforma in cui è ospitato il codice sorgente (Code Hosting Platform, ad esempio GitHub, GitLab gestito INGV o da altra organizzazione, oppure un server interno).

9. Description

Fornisci una descrizione testuale. Idealmente, compila sia la parte in inglese che quella in italiano. Puoi aggiungere dettagli sui metodi scientifici implementati nel codice (Description of methods) o note prettamente tecniche (Description technical). Ricorda che questi testi verranno inclusi nei metadati associati al DOI qualora venisse assegnato.

10. Ownership, publisher, licenses and disclaimer

Attenzione: Il Software owner (Titolare) per i software sviluppati con risorse umane/strumentali dell’Ente è l’Istituto Nazionale di Geofisica e Vulcanologia (INGV), non la singola Sezione, il Gruppo di Lavoro o il singolo autore. Seleziona il Publisher e, se applicabile, la licenza d’uso Open Source (es. GPLv3, MIT, Apache). Se il codice è a uso ristretto e non licenziato, indicalo nei disclaimer.

11. Financing project(s)

Il software è stato sviluppato (in tutto o in parte) grazie ai fondi di un progetto specifico? Seleziona il progetto dal menu a tendina. Questo è molto utile per la rendicontazione istituzionale e riconoscere il contributo di organizzazioni esterne.

Nota: in questa sezione è possibile indicare progetti il cui soggetto finanziatore è diverso dall’INGV, al fine di dare credito alle organizzazioni esterne. Si dà per scontato che, se non è indicato nessun progetto, il finanziatore è l’INGV stesso.

12. Related online resources (other software, data and publications)

E’ molto utile collegare il tuo software ad altre risorse online già pubblicate. Se ad esempio il software è stato descritto in un articolo scientifico (es. “IsDocumentedBy” journal article), genera un dataset specifico, o dipende da altri software, inserisci qui i DOI o altri identificativi relativi per stabilire una relazione.

13. Relation to research infrastructures

Il tuo tool è utilizzato all’interno delle grandi infrastrutture di ricerca europee o nazionali? Spunta le caselle pertinenti se il software è utilizzato nell’ambito dell’ERIC EPOS, ERIC EMSO, EIDA Italia, o del PNRA.

14. General notes

Uno spazio libero per qualsiasi altra informazione. Se hai dubbi su come licenziare il software, se manca il progetto finanziatore nella lista della sezione 11, o se vuoi spiegare una particolarità della tua applicazione, scrivi tutto qui.

Per qualsiasi dubbio o richiesta di assistenza nella compilazione, contatta PoliSoft all’indirizzo: polisoft@ingv.it.