mirror of
https://github.com/Steffo99/sophon.git
synced 2024-12-22 14:54:22 +00:00
📔 Progress!
This commit is contained in:
parent
617af38f8c
commit
d121aa2fbe
56 changed files with 525 additions and 331 deletions
|
@ -10,11 +10,13 @@ Sophon permette ai suoi utenti di effettuare in sicurezza attività di ricerca c
|
||||||
|
|
||||||
|
|
||||||
Screenshots
|
Screenshots
|
||||||
-----------
|
===========
|
||||||
|
|
||||||
.. image:: screenshots/instance_select.png
|
.. image:: ../2_concepts/1_instances/choose.png
|
||||||
.. image:: screenshots/user_select.png
|
.. image:: ../2_concepts/2_users/login.png
|
||||||
.. image:: screenshots/notebook_select.png
|
.. image:: ../2_concepts/3_researchgroups/list.png
|
||||||
.. image:: screenshots/mode_select.png
|
.. image:: ../2_concepts/4_researchprojects/list.png
|
||||||
.. image:: screenshots/inside_the_lab.png
|
.. image:: ../2_concepts/5_notebooks/list.png
|
||||||
.. image:: screenshots/admin_page.png
|
.. image:: ../2_concepts/5_notebooks/detail.png
|
||||||
|
.. image:: ../screenshots/inside_the_lab.png
|
||||||
|
.. image:: ../screenshots/admin_page.png
|
|
@ -1,227 +0,0 @@
|
||||||
I concetti
|
|
||||||
**********
|
|
||||||
|
|
||||||
Istanza
|
|
||||||
=======
|
|
||||||
|
|
||||||
Un'*istanza* rappresenta un'**installazione di Sophon** effettuata su un server di un'istituzione di ricerca, come ad esempio un'Università.
|
|
||||||
|
|
||||||
Ogni istanza è **fisicamente e logicamente separata** dalle altre; istanze diverse **non condividono alcun dato** tra loro.
|
|
||||||
|
|
||||||
.. image:: instances_diagram.png
|
|
||||||
:width: 400
|
|
||||||
|
|
||||||
|
|
||||||
URL dell'istanza
|
|
||||||
----------------
|
|
||||||
|
|
||||||
Ciascuna istanza è accessibile tramite **uno specifico URL**, deciso dall'amministratore di sistema al momento dell'installazione.
|
|
||||||
|
|
||||||
.. image:: instances_urls.png
|
|
||||||
:width: 400
|
|
||||||
|
|
||||||
|
|
||||||
Istanze nell'interfaccia web
|
|
||||||
----------------------------
|
|
||||||
|
|
||||||
L'interfaccia web di Sophon permette di **selezionare l'istanza** che si desidera usare inserendo il corrispondente URL.
|
|
||||||
|
|
||||||
.. image:: instance_select.png
|
|
||||||
|
|
||||||
|
|
||||||
Personalizzazione dell'istanza
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
Nel pannello di amministrazione di un'istanza Sophon è possibile personalizzare alcuni dettagli dell'istanza, quali:
|
|
||||||
|
|
||||||
- il **nome** dell'istanza, che verrà visualizzato come titolo dell'interfaccia web;
|
|
||||||
|
|
||||||
.. image:: instance_title.png
|
|
||||||
|
|
||||||
- la **descrizione** dell'istanza in `Markdown`_, visualizzata all'interno del riquadro "A proposito dell'istanza";
|
|
||||||
|
|
||||||
.. image:: instance_description.png
|
|
||||||
|
|
||||||
- il **tema colori** dell'istanza, applicato all'interfaccia web una volta che l'istanza è stata selezionata.
|
|
||||||
|
|
||||||
.. image:: instance_theme_sophon.png
|
|
||||||
:width: 240
|
|
||||||
.. image:: instance_theme_royalblue.png
|
|
||||||
:width: 240
|
|
||||||
.. image:: instance_theme_amber.png
|
|
||||||
:width: 240
|
|
||||||
.. image:: instance_theme_paper.png
|
|
||||||
:width: 240
|
|
||||||
.. image:: instance_theme_hacker.png
|
|
||||||
:width: 240
|
|
||||||
|
|
||||||
|
|
||||||
.. _Markdown: https://it.wikipedia.org/wiki/Markdown
|
|
||||||
|
|
||||||
|
|
||||||
Utente
|
|
||||||
======
|
|
||||||
|
|
||||||
Un *utente* è una entità che interagisce con una specifica istanza Sophon: ad esempio, un utente potrebbe essere una persona fisica, oppure potrebbe essere un software di automazione che si interfaccia con Sophon.
|
|
||||||
|
|
||||||
|
|
||||||
Livelli di accesso
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Un utente può avere uno dei seguenti livelli di accesso:
|
|
||||||
|
|
||||||
.. glossary::
|
|
||||||
|
|
||||||
Superutente
|
|
||||||
Utente con accesso completo a ogni singola risorsa sull'istanza Sophon, tipicamente riservato per l'amministratore di sistema; deve effettuare l'accesso all'istanza con le proprie credenziali.
|
|
||||||
|
|
||||||
Utente
|
|
||||||
Utente con permessi limitati alle risorse che ha creato o a cui è stato fornito accesso; deve effettuare l'accesso all'istanza con le proprie credenziali.
|
|
||||||
|
|
||||||
Ospite
|
|
||||||
Utente che può visualizzare alcuni contenuti dell'istanza Sophon ma non può interagirci.
|
|
||||||
|
|
||||||
|
|
||||||
Creazione di nuovi utenti
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
In una istanza Sophon, la registrazione autonoma non è possibile: ciò permetterebbe agli utenti creati di accedere a dati riservati al personale di ricerca.
|
|
||||||
|
|
||||||
Nuovi utenti possono essere creati esclusivamente da un :term:`superutente` nel pannello di amministrazione dell'istanza.
|
|
||||||
|
|
||||||
.. image:: user_creation.png
|
|
||||||
|
|
||||||
|
|
||||||
Utenti nell'interfaccia web
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
L'interfaccia web di Sophon permette di **selezionare la tipologia di utente** con la quale si intende utilizzare il servizio.
|
|
||||||
|
|
||||||
.. image:: user_select.png
|
|
||||||
|
|
||||||
|
|
||||||
Gruppo di ricerca
|
|
||||||
=================
|
|
||||||
|
|
||||||
Un *gruppo di ricerca* rappresenta un insieme di :term:`utenti` che collaborano su uno o più progetti.
|
|
||||||
|
|
||||||
.. image:: groups_diagram.png
|
|
||||||
:width: 400
|
|
||||||
|
|
||||||
|
|
||||||
Membri dei gruppi
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
Gli :term:`utenti` dell'istanza possono diventare *membri* dei gruppi di ricerca, con una delle seguenti modalità selezionate nelle impostazioni del gruppo:
|
|
||||||
|
|
||||||
- se il gruppo è *aperto*, allora qualsiasi utente può diventarne membro semplicemente **facendo richiesta** attraverso l'interfaccia web;
|
|
||||||
|
|
||||||
.. image:: join_request.png
|
|
||||||
|
|
||||||
- se il gruppo è in *modalità manuale*, allora nessun utente potrà richiedere di unirsi, e i membri saranno **selezionati manualmente** dal creatore del gruppo.
|
|
||||||
|
|
||||||
.. image:: join_manual.png
|
|
||||||
|
|
||||||
Nell'interfaccia web, i gruppi aperti sono marcati con l'icona di un **globo 🌐**, mentre i gruppi in modalità manuale sono marcati con l'icona di una **busta ✉️**.
|
|
||||||
|
|
||||||
.. image:: group_icons.png
|
|
||||||
|
|
||||||
In qualsiasi momento, i membri di un gruppo possono **lasciarlo** facendo richiesta attraverso l'interfaccia web.
|
|
||||||
|
|
||||||
|
|
||||||
Creazione di nuovi gruppi
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
Qualsiasi :term:`utente` può **creare** gruppi di ricerca dall'interfaccia web.
|
|
||||||
|
|
||||||
.. image:: group_creation.png
|
|
||||||
|
|
||||||
|
|
||||||
Modifica di gruppi
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Il creatore di un gruppo di ricerca è l'unico :term:`utente` che può cambiarne **nome**, **descrizione**, **membri** e **modalità di accesso**.
|
|
||||||
|
|
||||||
Lo *slug*, l'identificatore univoco del gruppo, non è modificabile successivamente alla creazione, dato che è utilizzato all'interno degli URL.
|
|
||||||
|
|
||||||
|
|
||||||
Eliminazione di gruppi
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
Il creatore di un gruppo è l'unico utente in grado di **cancellare** il gruppo che ha creato.
|
|
||||||
|
|
||||||
.. warning::
|
|
||||||
|
|
||||||
L'eliminazione di un gruppo è un'operazione distruttiva non reversibile!
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
Se si è i creatori di un gruppo, e si vuole trasferire il gruppo ad un altro utente, sarà necessario fare richiesta ad un :term:`superutente` di cambiare il proprietario del gruppo all'interno del pannello di amministrazione.
|
|
||||||
|
|
||||||
.. seealso::
|
|
||||||
|
|
||||||
:ref:`Conferma di eliminazione`
|
|
||||||
|
|
||||||
|
|
||||||
Progetto di ricerca
|
|
||||||
===================
|
|
||||||
|
|
||||||
Un *progetto di ricerca* rappresenta una **collezione di materiali** relativa a un singolo argomento mantenuta da un :ref:`gruppo di ricerca`.
|
|
||||||
|
|
||||||
.. image:: projects_diagram.png
|
|
||||||
:width: 400
|
|
||||||
|
|
||||||
|
|
||||||
Creazione di nuovi progetti
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può creare nuovi progetti.
|
|
||||||
|
|
||||||
|
|
||||||
Modifica di progetti
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può modificare **nome**, **descrizione** dei progetti al suo interno.
|
|
||||||
|
|
||||||
Solo il *creatore del gruppo* può modificarne la **visibilità**, o **trasferire il progetto ad un altro gruppo**.
|
|
||||||
|
|
||||||
Lo *slug*, l'identificatore univoco del progetto, non è modificabile successivamente alla creazione, dato che è utilizzato all'interno degli URL.
|
|
||||||
|
|
||||||
|
|
||||||
Eliminazione di progetti
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
Il **creatore del gruppo** al quale appartiene il progetto è l'unico utente in grado di eliminarlo.
|
|
||||||
|
|
||||||
.. warning::
|
|
||||||
|
|
||||||
L'eliminazione di un progetto è un'operazione distruttiva non reversibile!
|
|
||||||
|
|
||||||
.. seealso::
|
|
||||||
|
|
||||||
:ref:`Conferma di eliminazione`
|
|
||||||
|
|
||||||
|
|
||||||
Visibilità dei progetti
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
I progetti hanno tre diverse impostazioni di visibilità che regolano chi può visualizzarne i contenuti:
|
|
||||||
|
|
||||||
.. glossary::
|
|
||||||
|
|
||||||
Progetto privato
|
|
||||||
Il progetto è visibile solo ai membri del gruppo a cui appartiene il progetto.
|
|
||||||
|
|
||||||
Progetto interno
|
|
||||||
Il progetto è visibile solo agli :term:`utenti` dell'istanza, e non agli :term:`ospiti`.
|
|
||||||
|
|
||||||
Progetto pubblico
|
|
||||||
Il progetto è visibile a tutti.
|
|
||||||
|
|
||||||
I progetti privati sono marcati con l'icona di un **luchetto chiuso 🔒**, i progetti interni con l'icona di un **università 🏦** e i progetti pubblici con l'icona di un **globo 🌐**.
|
|
||||||
|
|
||||||
|
|
||||||
Notebook
|
|
||||||
========
|
|
||||||
|
|
||||||
.. TODO: Do this.
|
|
56
docs/source/1_user/2_concepts/1_instances/index.rst
Normal file
56
docs/source/1_user/2_concepts/1_instances/index.rst
Normal file
|
@ -0,0 +1,56 @@
|
||||||
|
Istanza
|
||||||
|
=======
|
||||||
|
|
||||||
|
Un'*istanza* rappresenta un'**installazione di Sophon** effettuata su un server di un'istituzione di ricerca, come ad esempio un'Università.
|
||||||
|
|
||||||
|
Ogni istanza è **fisicamente e logicamente separata** dalle altre; istanze diverse **non condividono alcun dato** tra loro.
|
||||||
|
|
||||||
|
.. image:: diagram.png
|
||||||
|
:width: 400
|
||||||
|
|
||||||
|
|
||||||
|
URL dell'istanza
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Ciascuna istanza è accessibile tramite **uno specifico URL**, deciso dall'amministratore di sistema al momento dell'installazione.
|
||||||
|
|
||||||
|
.. image:: urls.png
|
||||||
|
:width: 400
|
||||||
|
|
||||||
|
|
||||||
|
Istanze nell'interfaccia web
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
L'interfaccia web di Sophon permette di **selezionare l'istanza** che si desidera usare inserendo il corrispondente URL.
|
||||||
|
|
||||||
|
.. image:: choose.png
|
||||||
|
|
||||||
|
|
||||||
|
Personalizzazione dell'istanza
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
Nel pannello di amministrazione di un'istanza Sophon è possibile personalizzare alcuni dettagli dell'istanza, quali:
|
||||||
|
|
||||||
|
- il **nome** dell'istanza, che verrà visualizzato come titolo dell'interfaccia web;
|
||||||
|
|
||||||
|
.. image:: custom_title.png
|
||||||
|
|
||||||
|
- la **descrizione** dell'istanza in `Markdown`_, visualizzata all'interno del riquadro "A proposito dell'istanza";
|
||||||
|
|
||||||
|
.. image:: custom_description.png
|
||||||
|
|
||||||
|
- il **tema colori** dell'istanza, applicato all'interfaccia web una volta che l'istanza è stata selezionata.
|
||||||
|
|
||||||
|
.. image:: theme_sophon.png
|
||||||
|
:width: 240
|
||||||
|
.. image:: theme_royalblue.png
|
||||||
|
:width: 240
|
||||||
|
.. image:: theme_amber.png
|
||||||
|
:width: 240
|
||||||
|
.. image:: theme_paper.png
|
||||||
|
:width: 240
|
||||||
|
.. image:: theme_hacker.png
|
||||||
|
:width: 240
|
||||||
|
|
||||||
|
|
||||||
|
.. _Markdown: https://it.wikipedia.org/wiki/Markdown
|
BIN
docs/source/1_user/2_concepts/2_users/diagram.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/2_users/diagram.png
(Stored with Git LFS)
Normal file
Binary file not shown.
58
docs/source/1_user/2_concepts/2_users/index.rst
Normal file
58
docs/source/1_user/2_concepts/2_users/index.rst
Normal file
|
@ -0,0 +1,58 @@
|
||||||
|
Utente
|
||||||
|
======
|
||||||
|
|
||||||
|
Un *utente* è una entità che interagisce con una specifica istanza Sophon: ad esempio, un utente potrebbe essere una persona fisica, oppure potrebbe essere un software di automazione che si interfaccia con Sophon.
|
||||||
|
|
||||||
|
.. image:: diagram.png
|
||||||
|
:width: 400
|
||||||
|
|
||||||
|
|
||||||
|
Livelli di accesso
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Un utente può avere uno dei seguenti *livelli di accesso*:
|
||||||
|
|
||||||
|
|
||||||
|
Superutente
|
||||||
|
^^^^^^^^^^^
|
||||||
|
|
||||||
|
Utente con accesso completo a ogni singola risorsa sull'istanza Sophon, tipicamente riservato per l'amministratore di sistema.
|
||||||
|
|
||||||
|
|
||||||
|
Utente
|
||||||
|
^^^^^^
|
||||||
|
|
||||||
|
Utente con permessi limitati alle risorse che ha creato o a cui è stato fornito accesso.
|
||||||
|
|
||||||
|
|
||||||
|
Ospite
|
||||||
|
^^^^^^
|
||||||
|
|
||||||
|
Utente che può visualizzare alcuni contenuti dell'istanza Sophon ma non può interagirci.
|
||||||
|
|
||||||
|
|
||||||
|
Credenziali di accesso
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
Gli utenti di tipo :ref:`Utente` e :ref:`Superutente` devono identificarsi sull'istanza con le loro credenziali.
|
||||||
|
|
||||||
|
Di default, le credenziali sono un **nome utente** e una **password**, ma è possibile che l'amministratore di sistema implementi un sistema diverso, ad esempio un sistema `Single Sign-On`_.
|
||||||
|
|
||||||
|
|
||||||
|
.. _Single Sign-On: https://it.wikipedia.org/wiki/Single_sign-on
|
||||||
|
|
||||||
|
|
||||||
|
Creazione di nuovi utenti
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
In un':ref:`istanza` Sophon, la registrazione autonoma **non è permessa**: nuovi utenti possono essere creati esclusivamente da un :ref:`superutente` all'interno del pannello di amministrazione.
|
||||||
|
|
||||||
|
.. image:: creation.png
|
||||||
|
|
||||||
|
|
||||||
|
Utenti nell'interfaccia web
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
Dopo aver selezionato un':ref:`istanza`, l'interfaccia web di Sophon permette di **effettuare l'accesso** come la tipologia di utente con la quale si intende utilizzare il servizio.
|
||||||
|
|
||||||
|
.. image:: login.png
|
BIN
docs/source/1_user/2_concepts/3_researchgroups/choose.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/3_researchgroups/choose.png
(Stored with Git LFS)
Normal file
Binary file not shown.
69
docs/source/1_user/2_concepts/3_researchgroups/index.rst
Normal file
69
docs/source/1_user/2_concepts/3_researchgroups/index.rst
Normal file
|
@ -0,0 +1,69 @@
|
||||||
|
Gruppo di ricerca
|
||||||
|
=================
|
||||||
|
|
||||||
|
Un *gruppo di ricerca* rappresenta un insieme di utenti che collaborano su uno o più progetti.
|
||||||
|
|
||||||
|
.. image:: diagram.png
|
||||||
|
:width: 400
|
||||||
|
|
||||||
|
|
||||||
|
Membri e modalità di accesso
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
Gli utenti dell':ref:`istanza` possono diventare *membri* dei gruppi di ricerca, con una delle seguenti modalità selezionate nelle impostazioni del gruppo:
|
||||||
|
|
||||||
|
- se il gruppo è *aperto*, allora qualsiasi utente può diventarne membro semplicemente **facendo richiesta** attraverso l'interfaccia web;
|
||||||
|
|
||||||
|
.. image:: join_open.png
|
||||||
|
|
||||||
|
- se il gruppo è in *modalità manuale*, allora nessun utente potrà richiedere di unirsi, e i membri saranno **selezionati manualmente** dal creatore del gruppo.
|
||||||
|
|
||||||
|
.. image:: join_manual.png
|
||||||
|
|
||||||
|
Nell'interfaccia web, i gruppi aperti sono marcati con l'icona di un **globo 🌐**, mentre i gruppi in modalità manuale sono marcati con l'icona di una **busta ✉️**.
|
||||||
|
|
||||||
|
.. image:: icons.png
|
||||||
|
|
||||||
|
In qualsiasi momento, i membri di un gruppo possono **lasciarlo** facendo richiesta attraverso l'interfaccia web.
|
||||||
|
|
||||||
|
|
||||||
|
Creazione di nuovi gruppi
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
Qualsiasi :ref:`utente` può **creare** gruppi di ricerca dall'interfaccia web.
|
||||||
|
|
||||||
|
.. image:: creation.png
|
||||||
|
|
||||||
|
|
||||||
|
Modifica di gruppi
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Il creatore di un gruppo di ricerca è l'unico :ref:`utente` che può cambiarne **nome**, **descrizione**, **membri** e **modalità di accesso**.
|
||||||
|
|
||||||
|
Lo *slug*, l'identificatore univoco del gruppo, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili.
|
||||||
|
|
||||||
|
|
||||||
|
Eliminazione di gruppi
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
Il creatore di un gruppo è l'unico utente in grado di **cancellare** il gruppo che ha creato.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
L'eliminazione di un gruppo è un'operazione distruttiva non reversibile!
|
||||||
|
|
||||||
|
.. hint::
|
||||||
|
|
||||||
|
Se si è i creatori di un gruppo, e si vuole trasferire il gruppo ad un altro utente, sarà necessario fare richiesta ad un :ref:`superutente` di cambiare il proprietario del gruppo all'interno del pannello di amministrazione.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
:ref:`Conferma di eliminazione`
|
||||||
|
|
||||||
|
|
||||||
|
Gruppi nell'interfaccia web
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
Dopo aver effettuato l'accesso come :ref:`utente` o :ref:`ospite`, l'interfaccia utente di Sophon visualizza l'elenco di gruppi di ricerca disponibili nell':ref:`instanza`, permettendo agli utenti di unirsi ad essi, lasciarli, oppure eliminarli.
|
||||||
|
|
||||||
|
.. image:: list.png
|
BIN
docs/source/1_user/2_concepts/3_researchgroups/list.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/3_researchgroups/list.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/4_researchprojects/creation.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/4_researchprojects/creation.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/4_researchprojects/icons.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/4_researchprojects/icons.png
(Stored with Git LFS)
Normal file
Binary file not shown.
68
docs/source/1_user/2_concepts/4_researchprojects/index.rst
Normal file
68
docs/source/1_user/2_concepts/4_researchprojects/index.rst
Normal file
|
@ -0,0 +1,68 @@
|
||||||
|
Progetto di ricerca
|
||||||
|
===================
|
||||||
|
|
||||||
|
Un *progetto di ricerca* rappresenta una **collezione di materiali** relativa a un singolo argomento mantenuta da un :ref:`gruppo di ricerca`.
|
||||||
|
|
||||||
|
.. image:: diagram.png
|
||||||
|
:width: 400
|
||||||
|
|
||||||
|
|
||||||
|
Visibilità dei progetti
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
I progetti hanno tre diverse impostazioni di visibilità che regolano chi può visualizzarne i contenuti:
|
||||||
|
|
||||||
|
.. glossary::
|
||||||
|
|
||||||
|
Progetto privato
|
||||||
|
Il progetto è visibile solo ai membri del gruppo a cui appartiene il progetto.
|
||||||
|
|
||||||
|
Progetto interno
|
||||||
|
Il progetto è visibile solo agli :term:`utenti` dell'istanza, e non agli :term:`ospiti`.
|
||||||
|
|
||||||
|
Progetto pubblico
|
||||||
|
Il progetto è visibile a tutti.
|
||||||
|
|
||||||
|
I progetti privati sono marcati con l'icona di un **luchetto chiuso 🔒**, i progetti interni con l'icona di un **università 🏦** e i progetti pubblici con l'icona di un **globo 🌐**.
|
||||||
|
|
||||||
|
.. image:: icons.png
|
||||||
|
|
||||||
|
|
||||||
|
Creazione di nuovi progetti
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può creare nuovi progetti.
|
||||||
|
|
||||||
|
.. image:: creation.png
|
||||||
|
|
||||||
|
|
||||||
|
Modifica di progetti
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può modificare **nome**, **descrizione** dei progetti al suo interno.
|
||||||
|
|
||||||
|
Solo il *creatore del gruppo* può modificarne la **visibilità**, o **trasferire il progetto ad un altro gruppo**.
|
||||||
|
|
||||||
|
Lo *slug*, l'identificatore univoco del progetto, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili.
|
||||||
|
|
||||||
|
|
||||||
|
Eliminazione di progetti
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può eliminare i progetti al suo interno.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
L'eliminazione di un progetto è un'operazione distruttiva non reversibile!
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
:ref:`Conferma di eliminazione`
|
||||||
|
|
||||||
|
|
||||||
|
Progetti nell'interfaccia web
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
Dopo aver selezionato un :ref:`gruppo di ricerca`, l'interfaccia web mostra i progetti visibili all':term:`utente` attuale, e gli permette di selezionarne uno oppure di eliminarli.
|
||||||
|
|
||||||
|
.. image:: list.png
|
BIN
docs/source/1_user/2_concepts/4_researchprojects/list.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/4_researchprojects/list.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/action_lock.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/action_lock.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/action_start.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/action_start.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/action_stop.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/action_stop.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/collaboration.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/collaboration.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/connection.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/connection.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/creation.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/creation.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/detail.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/detail.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/diagram.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/diagram.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/diagram_network.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/diagram_network.png
(Stored with Git LFS)
Normal file
Binary file not shown.
142
docs/source/1_user/2_concepts/5_notebooks/index.rst
Normal file
142
docs/source/1_user/2_concepts/5_notebooks/index.rst
Normal file
|
@ -0,0 +1,142 @@
|
||||||
|
Notebook
|
||||||
|
========
|
||||||
|
|
||||||
|
Un *notebook* è un **tipo di materiale** che può essere allegato ad un :ref:`progetto di ricerca` (attualmente, l'unico implementato).
|
||||||
|
|
||||||
|
Rappresenta una **postazione di lavoro** sul server dell':ref:`istanza` Sophon, utilizzabile da un :term:`utente` o più.
|
||||||
|
|
||||||
|
.. image:: diagram.png
|
||||||
|
:width: 400
|
||||||
|
|
||||||
|
|
||||||
|
Isolamento dei notebook
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
I notebook risiedono tutti sullo **stesso elaboratore fisico** che esegue l':ref:`istanza` Sophon, pertanto ne condividono le risorse, come processore, scheda video e memoria.
|
||||||
|
|
||||||
|
Sono però **logicamente isolati**: i file contenuti in un notebook non sono accessibili agli altri, e i notebook non hanno modo di comunicare direttamente tra loro.
|
||||||
|
|
||||||
|
.. image:: diagram_network.png
|
||||||
|
:width: 400
|
||||||
|
|
||||||
|
|
||||||
|
Creazione di nuovi notebook
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
Qualsiasi **membro** di un :ref:`gruppo di ricerca` può creare nuovi notebook all'interno di uno dei progetti del gruppo a cui appartiene.
|
||||||
|
|
||||||
|
.. image:: creation.png
|
||||||
|
|
||||||
|
|
||||||
|
Stato del notebook
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Un notebook può essere *avviato* o *fermo* in base al suo stato di esecuzione sull':ref:`istanza` Sophon:
|
||||||
|
|
||||||
|
- è *avviato* se sta venendo eseguito ed è accessibile;
|
||||||
|
|
||||||
|
.. image:: status_stopped.png
|
||||||
|
:height: 40
|
||||||
|
|
||||||
|
- è *fermo* se non sta venendo eseguito o sta venendo preparato.
|
||||||
|
|
||||||
|
.. image:: status_running.png
|
||||||
|
:height: 40
|
||||||
|
|
||||||
|
Alla creazione, un notebook è *fermo*.
|
||||||
|
|
||||||
|
|
||||||
|
Avviare un notebook
|
||||||
|
^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
Un **membro** del :ref:`gruppo di ricerca` a cui appartiene il notebook può richiedere al server l'avvio di quest'ultimo, in modo da poterlo utilizzare successivamente.
|
||||||
|
|
||||||
|
.. image:: action_start.png
|
||||||
|
|
||||||
|
|
||||||
|
Fermare un notebook
|
||||||
|
^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
Un **membro** del :ref:`gruppo di ricerca` a cui appartiene il notebook può richiedere al server l'arresto di quest'ultimo, salvando i dati e interrompendo la sessione di lavoro attualmente in corso.
|
||||||
|
|
||||||
|
.. image:: action_stop.png
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
Se un notebook viene fermato durante un upload o download di file, essi risulteranno corrotti e saranno da ritrasferire.
|
||||||
|
|
||||||
|
|
||||||
|
Immagine del notebook
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
In **fase di creazione** di un notebook, oppure mentre esso è **fermo**, è possibile selezionare un'*immagine*, ovvero il programma che sarà eseguito dal notebook all'avvio.
|
||||||
|
|
||||||
|
Attualmente, l'unica immagine configurata è **Jupyter (Sophon)**, che esegue un server `Jupyter`_ con un'interfaccia `JupyterLab`_.
|
||||||
|
|
||||||
|
|
||||||
|
.. _Jupyter: https://jupyter.org/
|
||||||
|
.. _JupyterLab: https://jupyterlab.readthedocs.io/en/stable/
|
||||||
|
|
||||||
|
|
||||||
|
Collegarsi a un notebook
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
I **membri** del :ref:`gruppo di ricerca` a cui appartiene il notebook possono connettersi ad un notebook **avviato** attraverso un URL segreto comunicatogli dall':ref:`istanza`.
|
||||||
|
|
||||||
|
.. image:: connection.png
|
||||||
|
|
||||||
|
|
||||||
|
Collaborazione
|
||||||
|
^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
È possibile il collegamento **simultaneo** di più membri al notebook: l'immagine selezionata permetterà loro di collaborare in tempo reale sugli stessi file.
|
||||||
|
|
||||||
|
.. image:: collaboration.png
|
||||||
|
|
||||||
|
|
||||||
|
Blocco di un notebook
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Qualsiasi **membro** del :ref:`gruppo di ricerca` a cui appartiene il notebook può *bloccarlo* per segnalare agli altri utenti che vi hanno accesso di non utilizzare quello specifico notebook.
|
||||||
|
|
||||||
|
.. image:: action_lock.png
|
||||||
|
|
||||||
|
Bloccare un notebook **rimuove dall'interfaccia web** i bottoni per l'avvio, l'arresto, l'eliminazione al notebook bloccato, e, per tutti tranne l':ref:`utente` che ha effettuato la richiesta, anche il bottone per la connessione.
|
||||||
|
|
||||||
|
.. image:: locked.png
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
Il blocco di un notebook è solo estetico, e non impedisce agli utenti di effettuare queste operazioni tramite strumenti esterni, come la Console per sviluppatori del browser web.
|
||||||
|
|
||||||
|
Un notebook bloccato potrà essere sbloccato da qualsiasi **membro** del :ref:`gruppo di ricerca`; il membro che ha richiesto il blocco potrà sbloccarlo **immediatamente**, mentre agli altri membri sarà richiesto di confermare l'azione come se stesse venendo effettuata un'eliminazione.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
:ref:`Conferma di eliminazione`
|
||||||
|
|
||||||
|
|
||||||
|
Modifica di un notebook
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può modificare **nome** e **immagine** dei notebook *fermi* al suo interno.
|
||||||
|
|
||||||
|
I notebook *avviati* non possono essere modificati.
|
||||||
|
|
||||||
|
Lo *slug*, l'identificatore univoco del notebook, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili.
|
||||||
|
|
||||||
|
|
||||||
|
Eliminazione di un notebook
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può eliminare i notebook all'interno dei progetti del gruppo.
|
||||||
|
|
||||||
|
|
||||||
|
Notebook nell'interfaccia web
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
Dopo aver selezionato un :ref:`progetto di ricerca`, l'interfaccia web mostra l'elenco dei notebook che gli appartengono, assieme alle azioni che è possibile effettuare su di essi.
|
||||||
|
|
||||||
|
.. image:: list.png
|
||||||
|
|
||||||
|
È possibile selezionare un notebook per visualizzarne i dettagli o connettercisi.
|
||||||
|
|
||||||
|
.. image:: detail.png
|
BIN
docs/source/1_user/2_concepts/5_notebooks/list.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/list.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/locked.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/locked.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/status_running.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/status_running.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/5_notebooks/status_stopped.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/5_notebooks/status_stopped.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/2_concepts/diagram_full.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/2_concepts/diagram_full.png
(Stored with Git LFS)
Normal file
Binary file not shown.
15
docs/source/1_user/2_concepts/index.rst
Normal file
15
docs/source/1_user/2_concepts/index.rst
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
I concetti
|
||||||
|
**********
|
||||||
|
|
||||||
|
Questa sezione illustra i concetti chiave di Sophon e il loro funzionamento.
|
||||||
|
|
||||||
|
.. image:: diagram_full.png
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
1_instances/index
|
||||||
|
2_users/index
|
||||||
|
3_researchgroups/index
|
||||||
|
4_researchprojects/index
|
||||||
|
5_notebooks/index
|
|
@ -1,11 +0,0 @@
|
||||||
Dettagli implementativi dell'interfaccia web
|
|
||||||
********************************************
|
|
||||||
|
|
||||||
Conferma di eliminazione
|
|
||||||
========================
|
|
||||||
|
|
||||||
Per impedire eliminazioni accidentali di risorse, è presente nell'interfaccia web un meccanismo di conferma che richiede all'utente di ripremere il tasto di eliminazione trascorsi 3 secondi dalla prima richiesta.
|
|
||||||
|
|
||||||
.. raw:: html
|
|
||||||
|
|
||||||
<p><video controls src="../_static/group_delete_confirm.mp4"></video></p>
|
|
BIN
docs/source/1_user/3_extras/confirm.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/3_extras/confirm.png
(Stored with Git LFS)
Normal file
Binary file not shown.
23
docs/source/1_user/3_extras/index.rst
Normal file
23
docs/source/1_user/3_extras/index.rst
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
Dettagli dell'interfaccia web
|
||||||
|
*****************************
|
||||||
|
|
||||||
|
Elenco dei membri
|
||||||
|
=================
|
||||||
|
|
||||||
|
Quando viene selezionato un :ref:`gruppo di ricerca`, viene visualizzato l'elenco dei suoi membri.
|
||||||
|
|
||||||
|
Il creatore del :ref:`gruppo di ricerca` è evidenziato in blu, mentre l':ref:`utente` attuale è sottolineato.
|
||||||
|
|
||||||
|
.. image:: members_list.png
|
||||||
|
|
||||||
|
|
||||||
|
Conferma di eliminazione
|
||||||
|
========================
|
||||||
|
|
||||||
|
Per impedire eliminazioni accidentali di risorse, è presente un meccanismo di conferma che richiede all'utente di ripremere il tasto di eliminazione trascorsi 3 secondi dalla prima richiesta.
|
||||||
|
|
||||||
|
.. image:: confirm.png
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<p><video width="460" height="232" controls src="../../_static/group_delete_confirm.mp4"></video></p>
|
BIN
docs/source/1_user/3_extras/members_list.png
(Stored with Git LFS)
Normal file
BIN
docs/source/1_user/3_extras/members_list.png
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
docs/source/1_user/group_creation.png
(Stored with Git LFS)
BIN
docs/source/1_user/group_creation.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/group_icons.png
(Stored with Git LFS)
BIN
docs/source/1_user/group_icons.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/groups_diagram.png
(Stored with Git LFS)
BIN
docs/source/1_user/groups_diagram.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instance_description.png
(Stored with Git LFS)
BIN
docs/source/1_user/instance_description.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instance_theme_amber.png
(Stored with Git LFS)
BIN
docs/source/1_user/instance_theme_amber.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instance_theme_hacker.png
(Stored with Git LFS)
BIN
docs/source/1_user/instance_theme_hacker.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instance_theme_paper.png
(Stored with Git LFS)
BIN
docs/source/1_user/instance_theme_paper.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instance_theme_royalblue.png
(Stored with Git LFS)
BIN
docs/source/1_user/instance_theme_royalblue.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instance_theme_sophon.png
(Stored with Git LFS)
BIN
docs/source/1_user/instance_theme_sophon.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instance_title.png
(Stored with Git LFS)
BIN
docs/source/1_user/instance_title.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instances_diagram.png
(Stored with Git LFS)
BIN
docs/source/1_user/instances_diagram.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/instances_urls.png
(Stored with Git LFS)
BIN
docs/source/1_user/instances_urls.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/join_manual.png
(Stored with Git LFS)
BIN
docs/source/1_user/join_manual.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/join_request.png
(Stored with Git LFS)
BIN
docs/source/1_user/join_request.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/projects_diagram.png
(Stored with Git LFS)
BIN
docs/source/1_user/projects_diagram.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/screenshots/instance_select.png
(Stored with Git LFS)
BIN
docs/source/1_user/screenshots/instance_select.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/screenshots/mode_select.png
(Stored with Git LFS)
BIN
docs/source/1_user/screenshots/mode_select.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/screenshots/notebook_select.png
(Stored with Git LFS)
BIN
docs/source/1_user/screenshots/notebook_select.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/screenshots/user_select.png
(Stored with Git LFS)
BIN
docs/source/1_user/screenshots/user_select.png
(Stored with Git LFS)
Binary file not shown.
BIN
docs/source/1_user/user_creation.png
(Stored with Git LFS)
BIN
docs/source/1_user/user_creation.png
(Stored with Git LFS)
Binary file not shown.
|
@ -1,48 +1,41 @@
|
||||||
Sophon
|
Sophon
|
||||||
======
|
######
|
||||||
|
|
||||||
Benvenuto alla documentazione di Sophon, il centro di ricerca per le Università!
|
Benvenuto alla documentazione di Sophon, il centro di ricerca per le Università!
|
||||||
|
|
||||||
Contenuti
|
È divisa in tre parti: un **manuale utente** che illustra i concetti chiave che un utente di Sophon deve sapere per utilizzarlo, una **guida per l'amministratore** che fornisce le conoscenze necessarie al deployment del software, e infine una **documentazione tecnica** per i programmatori interessati a capire il funzionamento a livello di codice dell'applicazione.
|
||||||
---------
|
|
||||||
|
Si è cercato di mantenere il registro di ciascuna parte al livello tecnico del pubblico a cui è destinata, pertanto è possibile osservare alcune **semplificazioni** nelle prime parti.
|
||||||
|
|
||||||
|
|
||||||
|
Tabelle dei contenuti
|
||||||
|
=====================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 4
|
|
||||||
:caption: Manuale utente
|
:caption: Manuale utente
|
||||||
|
|
||||||
1_user/1_about
|
1_user/1_about/index
|
||||||
1_user/2_concepts
|
1_user/2_concepts/index
|
||||||
|
1_user/3_extras/index
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 4
|
:caption: Guida per l'amministratore
|
||||||
:caption: Amministrazione
|
|
||||||
|
|
||||||
2_admin/1_installation
|
2_admin/1_why_sophon
|
||||||
2_admin/2_update
|
2_admin/2_how_does_it_work
|
||||||
2_admin/3_administration
|
2_admin/3_installation
|
||||||
|
2_admin/4_update
|
||||||
|
2_admin/5_administration
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 4
|
:caption: Documentazione tecnica
|
||||||
:caption: Sviluppo
|
|
||||||
|
|
||||||
3_dev/autodoc
|
|
||||||
|
|
||||||
|
|
||||||
Collegamenti
|
Collegamenti
|
||||||
------------
|
============
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
|
|
||||||
Licenza
|
|
||||||
-------
|
|
||||||
|
|
||||||
Sophon è rilasciato sotto la `GNU Affero General Public License 3`_ (o successiva).
|
|
||||||
|
|
||||||
Il testo completo della licenza è disponibile all'interno del file ``LICENSE.txt`` allegato al codice sorgente del software.
|
|
||||||
|
|
||||||
.. _GNU Affero General Public License 3: https://www.gnu.org/licenses/agpl-3.0.html
|
|
||||||
|
|
Loading…
Reference in a new issue