Versionen från 24 januari 2020 kl. 19.01

Snabbguide Jupyter

Den här guiden beskriver i huvudsak Jupyter Notebook 6.x (LÄNK). Den kan med fördel utökas med mer information om resten av Project Jupyter.

Information om Jupyter

Jupyter Notebook (tidigare IPython Notebook) är ett gränssnitt och ett filformat som ofta används för explorativ dataanalys, demonstrationer och undervisningsmaterial. Filformatet låter dig kombinera avsnitt med text, bilder och annan media med avsnitt som innehåller programkod och resultat i samma fil. Jupyter Notebook är öppen källkod, används av forskare inom många områden och erbjuds som molntjänst av företag och infrastrukturer som Microsoft, Google och European Open Science Cloud (EOSC-hub).

Jupyter Notebook är därmed inget fristående analysverktyg utan ett redskap för att arbeta med programkod som analysverktyg eller för att presentera resultaten. Den huvudsakliga fördelen med verktyget är att kunna köra programkod på ett lättillgängligt sätt. Beskrivningar och kod läggs in i notebookfilen i en sekvens av avgränsade celler, som sedan kan markeras och köras individuellt. Eventuell utmatning dyker upp under respektive cell. Jupyter fungerar på samma sätt oavsett programspråk, men för att kunna köra programkod krävs att en s.k. kernel för programspråket finns tillgänglig på datorn tillsammans med eventuella programpaket som används. Gränssnittet kan också utökas med widgets som t.ex. används för att interagera med data eller programkod.

Jupyter Notebook är ett delprojekt i det större Project Jupyter (LÄNK). Ett annat sådant är JupyterLab, som är en vidareutveckling och framtida ersättare för gränssnittet till Jupyter Notebook (LÄNK). JupyterLab öppnar och skriver samma filformat som Jupyter Notebook.

JupyterHub är en serverprogramvara som gör Jupyter Notebook och/eller JupyterLab med kernels och widgets tillgänglig för användare över internet (LÄNK).

Ett enkelt sätt att hämta Jupyter Notebook är som en del av den Python- och R-baserade programsviten Anaconda, som finns för Windows, macOS och Linux (LÄNK).

Lathund

Att öppna och spara en fil

Jupyter Notebook kräver en webbläsare och officiellt stöds de senaste versionerna av Chrome, Safari och Firefox. När du har startat Jupyter Notebook lokalt på datorn öppnas dess gränssnitt i din webbläsare och du möts av en lista med filer. Du kan skapa en ny notebook genom att navigera till önskad mapp och klicka New uppe till höger. Du väljer sedan en kernel för det programspråk som du skall använda i Noteboken, t.ex. Python 3, och en ny notebook skapas i samma mapp med filnamnet "Untitled".

Jupyter Notebooks har filändelsen .ipynb och kan identifieras på sin särskilda ikon i webbfilhanteraren. För att öppna en existerande notebook navigerar du till dess mapp och klickar på den i webbfilhanteraren.

Din öppnade notebook sparas automatiskt allt eftersom du arbetar i den och lägger till nya celler. I File-menyn finns dock möjligheten att skapa s.k. checkpoints med Save and Checkpoint. Du sparar då undan en version av notebooken som det är möjligt att gå tillbaka till senare. Samtidigt fortsätter notebooken att autosparas.

Eftersom Jupyter utvecklats i programspråket Python finns alltid en kernel för Python 3.x tillgänglig. Du kan behöva konfigurera eller installera en annan kernel om programkoden är skriven i ett annat programspråk eller om den förutsätter att vissa programpaket finns installerade. Detta är dock något som du sköter utanför Jupyter Notebook, med hjälp av pakethanterare eller installationsprogram.

Det är också möjligt att öppna och arbeta i en Jupyter Notebook som finns på en annan server eller molntjänst. Du interagerar då i webbläsaren med notebooken, men all kod körs på servern. Detta kan vara en fördel då man vill tillgängliggöra en färdig miljö som användaren kan jobba i direkt utan att behöva installera extramjukvara på egen dator eller lagra datasets lokalt. En vanlig sådan lösning är fleranvändarservern JupyterHub (LÄNK) eller den tidigare varianten Binder (LÄNK), och det finns ett urval av molntjänster för att arbeta på detta sätt.

Dokumentationsmöjligheter

En Jupyter Notebook utgör i sig ofta en del av dokumentationen av en analys eller ett projekt. Den information i notebookfilen som inte är programkod utan t.ex. förklaringar och beskrivningar byggs upp med hjälp av ett standardiserat märkspråk, Markdown (LÄNK). Detta är utformat för att vara intuitivt och kan t.ex. jämföras med wikitext. Det går också att använda sig av LaTeX-syntax för att t.ex. generera formler och liknande notation i cellerna.

Det kanske viktigaste att dokumentera om själva Jupyter Notebook-filen är de olika beroenden som finns till andra entiteter. Detta kan röra sig om programspråk och kernels, programbibliotek som anropas, eller olika verktyg på datorn som används för t.ex. nedladdning, filhantering eller konvertering. En tydlig redogörelse för vilken mjukvara som används och vilka versioner av denna som krävs behöver därför finnas med i dokumentationen, kanske som en readme-fil.

I de fall som data för analysen eller annat material länkas eller hämtas in genom URL:er eller API-anrop är det eftersträvansvärt att använda olika typer av persistenta adresser och identifierare. Om möjligt bör också kontaktuppgifter och ansvariga för det externa materialet finnas med i dokumentationen utifall att det inte längre skulle gå att komma åt.

Filtyper som stöds i Jupyter

Filformatet IPyNB

Jupyter Notebook 6.x använder filformatet Jupyter Notebook Format 5.x (LÄNK). Filerna är uppbyggda i JSON-format och innehåller cellerna och en beskrivning av den Kernel som används för programkoden. Skapar du checkpoints sparas dessa i en undermapp: ".ipynb_checkpoints/".

Notebook (.ipynb)
Checkpoint (.ipynb)

Import

Export

Källor

1.^ [Länkplatshållare]

Blandade länkar

Författare: André Jernung, Thomas Kieselbach, Nadja Neumann & Wolmar Nyberg Åkerström

Senast uppdaterad: 2020-01-24

@@ Rad 1: / Rad 1: @@
 = Snabbguide Jupyter =
-Den här guiden beskriver i huvudsak Jupyter Notebook 6.x. Den kan med fördel utökas med mer information om resten av Project Jupyter.
+Den här guiden beskriver i huvudsak Jupyter Notebook 6.x (LÄNK). Den kan med fördel utökas med mer information om resten av Project Jupyter.
 == Information om Jupyter ==
@@ Rad 7: / Rad 7: @@
 Jupyter Notebook är därmed inget fristående analysverktyg utan ett redskap för att arbeta med programkod som analysverktyg eller för att presentera resultaten. Den huvudsakliga fördelen med verktyget är att kunna köra programkod på ett lättillgängligt sätt. Beskrivningar och kod läggs in i notebookfilen i en sekvens av avgränsade ''celler'', som sedan kan markeras och köras individuellt. Eventuell utmatning dyker upp under respektive cell. Jupyter fungerar på samma sätt oavsett programspråk, men för att kunna köra programkod krävs att en s.k. ''kernel'' för programspråket finns tillgänglig på datorn tillsammans med eventuella programpaket som används. Gränssnittet kan också utökas med ''widgets'' som t.ex. används för att interagera med data eller programkod.
-Jupyter Notebook är ett delprojekt i det större Project Jupyter. Ett annat sådant är JupyterLab, som är en vidareutveckling och framtida ersättare för gränssnittet till Jupyter Notebook. JupyterLab öppnar och skriver samma filformat som Jupyter Notebook.
+Jupyter Notebook är ett delprojekt i det större Project Jupyter (LÄNK). Ett annat sådant är JupyterLab, som är en vidareutveckling och framtida ersättare för gränssnittet till Jupyter Notebook (LÄNK). JupyterLab öppnar och skriver samma filformat som Jupyter Notebook.
-JupyterHub är en serverprogramvara som gör Jupyter Notebook och/eller JupyterLab med kernels och widgets tillgänglig för användare över internet.
+JupyterHub är en serverprogramvara som gör Jupyter Notebook och/eller JupyterLab med kernels och widgets tillgänglig för användare över internet (LÄNK).
-Ett enkelt sätt att hämta Jupyter Notebook är som en del av den Python- och R-baserade programsviten Anaconda, som finns för Windows, macOS och Linux.
+Ett enkelt sätt att hämta Jupyter Notebook är som en del av den Python- och R-baserade programsviten Anaconda, som finns för Windows, macOS och Linux (LÄNK).
 == Lathund ==
@@ Rad 25: / Rad 25: @@
 Eftersom Jupyter utvecklats i programspråket Python finns alltid en kernel för Python 3.x tillgänglig. Du kan behöva konfigurera eller installera en annan kernel om programkoden är skriven i ett annat programspråk eller om den förutsätter att vissa programpaket finns installerade. Detta är dock något som du sköter utanför Jupyter Notebook, med hjälp av pakethanterare eller installationsprogram.
-Det är också möjligt att öppna och arbeta i en Jupyter Notebook som finns på en annan server eller molntjänst. Du interagerar då i webbläsaren med notebooken, men all kod körs på servern. Detta kan vara en fördel då man vill tillgängliggöra en färdig miljö som användaren kan jobba i direkt utan att behöva installera extramjukvara på egen dator. En vanlig sådan lösning är fleranvändarservern JupyterHub eller den tidigare varianten Binder, och det finns ett urval av andra molntjänster för att arbeta på detta sätt.
+Det är också möjligt att öppna och arbeta i en Jupyter Notebook som finns på en annan server eller molntjänst. Du interagerar då i webbläsaren med notebooken, men all kod körs på servern. Detta kan vara en fördel då man vill tillgängliggöra en färdig miljö som användaren kan jobba i direkt utan att behöva installera extramjukvara på egen dator eller lagra datasets lokalt. En vanlig sådan lösning är fleranvändarservern JupyterHub (LÄNK) eller den tidigare varianten Binder (LÄNK), och det finns ett urval av molntjänster för att arbeta på detta sätt.
 === Dokumentationsmöjligheter ===
-En Jupyter Notebook utgör i sig ofta en del av dokumentationen av en analys eller ett projekt. Den information i notebookfilen som inte är programkod utan t.ex. förklaringar och beskrivningar byggs upp med hjälp av ett standardiserat märkspråk, '''Markdown'''. Detta är utformat för att vara intuitivt och kan t.ex. jämföras med wikitext. Det går också att använda sig av LaTeX-syntax för att t.ex. generera formler och liknande notation i cellerna.
+En Jupyter Notebook utgör i sig ofta en del av dokumentationen av en analys eller ett projekt. Den information i notebookfilen som inte är programkod utan t.ex. förklaringar och beskrivningar byggs upp med hjälp av ett standardiserat märkspråk, '''Markdown''' (LÄNK). Detta är utformat för att vara intuitivt och kan t.ex. jämföras med wikitext. Det går också att använda sig av LaTeX-syntax för att t.ex. generera formler och liknande notation i cellerna.
-Det kanske viktigaste att dokumentera om själva Jupyter Notebook-filen är de olika beroenden som finns till andra entiteter. Detta kan röra sig om programspråk och kernels, programbibliotek som anropas, eller olika verktyg på datorn som används för t.ex. nedladdning, filhantering eller konvertering. En tydlig redogörelse över vilken mjukvara som används och vilka versioner av denna som krävs behöver därför finnas med i dokumentationen, kanske som en readme-fil.
+Det kanske viktigaste att dokumentera om själva Jupyter Notebook-filen är de olika beroenden som finns till andra entiteter. Detta kan röra sig om programspråk och kernels, programbibliotek som anropas, eller olika verktyg på datorn som används för t.ex. nedladdning, filhantering eller konvertering. En tydlig redogörelse för vilken mjukvara som används och vilka versioner av denna som krävs behöver därför finnas med i dokumentationen, kanske som en readme-fil.
 I de fall som data för analysen eller annat material länkas eller hämtas in genom URL:er eller API-anrop är det eftersträvansvärt att använda olika typer av persistenta adresser och identifierare. Om möjligt bör också kontaktuppgifter och ansvariga för det externa materialet finnas med i dokumentationen utifall att det inte längre skulle gå att komma åt.
 === Filtyper som stöds i Jupyter  ===
 ==== Filformatet IPyNB ====
+Jupyter Notebook 6.x använder filformatet Jupyter Notebook Format 5.x (LÄNK). Filerna är uppbyggda i JSON-format och innehåller cellerna och en beskrivning av den Kernel som används för programkoden. Skapar du checkpoints sparas dessa i en undermapp: ".ipynb_checkpoints/".
+* Notebook (.ipynb)
+* Checkpoint (.ipynb)
 ==== Import ====

Skillnad mellan versioner av "Jupyter"

Från DAU-handboken