1
Fork 0
mirror of https://github.com/Steffo99/sophon.git synced 2024-12-21 22:34:21 +00:00

📔 Refine some things

This commit is contained in:
Steffo 2021-11-03 17:56:51 +01:00
parent e015f06656
commit e82ce37fd0
7 changed files with 86 additions and 28 deletions

View file

@ -18,5 +18,5 @@ Screenshots
.. image:: ../2_concepts/4_researchprojects/list.png
.. image:: ../2_concepts/5_notebooks/list.png
.. image:: ../2_concepts/5_notebooks/detail.png
.. image:: ../screenshots/inside_the_lab.png
.. image:: ../screenshots/admin_page.png
.. image:: ../2_concepts/5_notebooks/inside_the_lab.png
.. image:: ../../2_admin/2_administration/admin_page.png

View file

@ -1,7 +1,7 @@
Progetto di ricerca
===================
Un *progetto di ricerca* rappresenta una **collezione di materiali** relativa a un singolo argomento mantenuta da un :ref:`gruppo di ricerca`.
Un *progetto di ricerca* rappresenta una **collezione di oggetti** relativa a un singolo argomento mantenuta da un :ref:`gruppo di ricerca`.
.. image:: diagram.png
:width: 400

View file

@ -1,25 +1,12 @@
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ù.
Un *notebook* rappresenta una **postazione di lavoro** che può essere allegata ad un :ref:`progetto di ricerca`.
.. 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
---------------------------
@ -29,7 +16,7 @@ Qualsiasi **membro** di un :ref:`gruppo di ricerca` può creare nuovi notebook a
.. note::
Per motivi tecnici, i notebook non possono avere come slug ``backend``, ``frontend``, ``proxy``, ``api``, ``static`` e ``src``.
Per motivi tecnici, i notebook non possono avere come slug ``backend``, ``frontend``, ``proxy``, ``api``, ``static`` e ``src``, oppure iniziare o terminare con un trattino ``-``.
Stato del notebook
@ -90,6 +77,16 @@ I **membri** del :ref:`gruppo di ricerca` a cui appartiene il notebook possono c
.. image:: connection.png
Utilizzo di un notebook
^^^^^^^^^^^^^^^^^^^^^^^
Una volta connessi ad un notebook, sarà visualizzato il programma eseguito dall'immagine selezionata.
.. seealso::
Per informazioni su come usare JupyterLab, è possibile consultare l'apposita `documentazione <https://jupyterlab.readthedocs.io/en/stable/>`_.
Collaborazione
^^^^^^^^^^^^^^
@ -110,6 +107,7 @@ Bloccare un notebook **rimuove dall'interfaccia web** i bottoni per l'avvio, l'a
.. 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.
@ -118,6 +116,17 @@ Un notebook bloccato potrà essere sbloccato da qualsiasi **membro** del :ref:`g
:ref:`Conferma di eliminazione`
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
Modifica di un notebook
-----------------------
@ -131,7 +140,7 @@ Lo *slug*, l'identificatore univoco del notebook, non è modificabile successiva
Eliminazione di un notebook
---------------------------
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può eliminare i notebook all'interno dei progetti del gruppo.
Qualsiasi *membro* di un :ref:`gruppo di ricerca` può eliminare i notebook all'interno dei progetti del gruppo, a condizione che questi siano *fermi* e *non bloccati*.
Notebook nell'interfaccia web

BIN
docs/source/1_user/2_concepts/5_notebooks/inside_the_lab.png (Stored with Git LFS) Normal file

Binary file not shown.

View file

@ -1,6 +1,55 @@
Dettagli dell'interfaccia web
*****************************
Sono elencate in questo capitolo alcuni dettagli interessanti relativi all'intera interfaccia web.
Markdown nelle descrizioni
==========================
Le descrizioni dell':ref:`istanza`, del :ref:`gruppo di ricerca` selezionato e del :ref:`progetto di ricerca` selezionato sono interpretate dall'interfaccia web come `Markdown`_, un semplice e comune linguaggio di marcatura del testo con varie funzionalità che possono essere utili per descrivere l'entità in questione o lasciare messaggi agli altri collaboratori.
Si fornisce un breve riassunto della sintassi di `Markdown`_.
.. code-block:: markdown
<!-- Commento, non viene visualizzato -->
<!-- Titoli -->
# Parte
## Capitolo
### Sezione
#### Sottosezione
##### Sottosottosezione
###### Paragrafo
<!-- Formattazione -->
**grassetto**
*corsivo*
__sottolineato__
`codice`
<!-- Collegamenti -->
[testo](url)
<!-- Immagini -->
![alt](url)
<!-- Tabelle -->
| Riga 1 | Riga 2 | Riga 3 |
|--------|--------|--------|
| Cella | Cella | Cella |
| Cella | Cella | Cella |
<!-- Codice -->
```linguaggio
def funzione():
pass
```
.. _Markdown: https://daringfireball.net/projects/markdown/syntax
Elenco dei membri
=================

Binary file not shown.

View file

@ -1,11 +1,11 @@
Differenze con altri progetti simili
************************************
Differenze da altri progetti simili
***********************************
Sophon a prima vista può sembrare simile ad altri progetti già esistenti, ma si differenzia in alcune particolarità del suo funzionamento.
Differenze con JupyterHub
=========================
Differenze da JupyterHub
========================
`JupyterHub`_ è un progetto con scopi molto simili a quelli di Sophon, ovvero di permettere a tanti utenti di utilizzare `Jupyter`_ su un server remoto, ma ha funzionalità di autorizzazione molto semplici e non ha supporto per :ref:`collaborazione` in tempo reale, in quanto i server `Jupyter`_ che istanzia sono single-user.
@ -15,8 +15,8 @@ Differenze con JupyterHub
.. _Jupyter: https://jupyter.org/
Differenze con Google Colab
===========================
Differenze da Google Colab
==========================
`Google Colab`_ è un progetto che permette di effettuare ricerca su server `Jupyter`_ utilizzando le risorse della `Google Cloud Platform`_.