Att dela kodexempel

För några år sedan som gymnasielärare ville jag tillgängliggöra ett utbildningsmaterial som involverade programmeringskod. Jag kom fram till följande önskemål:

1. Enkelt att komma igång
2. Något icke-kommersiellt
3. Roligare än bara kod och ett terminalfönster

Jag hade upptäckt Jupyter och bestämde mig för det som grund. Jupyter är en arbetsmiljö där kod kan skrivas och köras i så kallade Jupyter Notebooks där kod, text, grafer, och annat interaktivt kan få plats. Just därför lämpar de sig väl för utbildningsmaterial tycker jag!

Två lösningar

Jag kommer presentera två lösningar för att tillgängligöra kodexempel, utbildningsmaterial, och övrigt.

Den enklare lösningen

Med gratistjänsten mybinder.org kan du dela kodexempel som blir tillgänliga för andra att köra genom ett enda länkklick.

Ungefär såhär gör du för att dela kodexempel med mybinder.org:

1. Gör kodexemplet tillgängligt på GitHub, GitLab, eller liknande.
2. Skapa en konfigurationsfil (requirements.txt för Python t.ex.) som beskriver vad som behövs installeras
3. Besök mybinder.org och skapa en länk
4. Dela länken

Exempel på kodmaterial delat via mybinder.org:

• Klassiskt kodexempel av Jupyter notebooks interaktivitet:
  https://gke.mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo/Lorenz.ipynb

  

• Utbildningsmaterial för maskininlärning av mig, lämpligt för engagerade elever i gymnasiet som läst iallafall matte 3:
  https://gke.mybinder.org/v2/gh/consideratio/jupyter-se-math-teacher/master?urlpath=lab/tree/source/gradient-descent/gradient-descent.ipynb

  

• Kodexempel på hur ett API av polisen.se kan användas, skapat av @salgo60 under Hack for Sweden 2019:
  https://gke.mybinder.org/v2/gh/hack-for-sweden/open-data-examples/HEAD?urlpath=lab/tree/polisen-se.ipynb

  

Den klumpigare lösningen

Som lärare ville jag att mina elever skulle kunna spara sitt arbete och liknande, men för detta krävdes något mer än mybinder.org. Jag listar nedan projekten som möjliggör detta, och är nu projekt jag har möjliggjorts att arbeta fulltid med att utveckla. Att använda dessa lämpar sig kanske bäst för universitet, skolor, företag osv. som kan investera lite tid och energi att tillhandahålla en sådan infrastruktur för sina elever, anställda, eller liknande.

• JupyterHub var ett lämpligt verktyg för att hjälpa mig göra Jupyter arbetsmiljöer tillgängliga för mina elever. Med en JupyterHub kunde de få köra koden på en extern dator istället för sin egen, och även spara sitt arbetsmaterial där osv.

• JupyterHub installerat på Kubernetes visade sig även mycket lovande för att hjälpa hela min skola eller t.om. hela skolkoncernen.

  
  University of California: Berkeley, studenter som går Data8 kursen där eleverna övar med kodexempel med hjälp av en JupyterHub.

Tack för er tid

Jag hoppas detta har kunnat fungera som en introduktion av potentiellt relevanta verktyg.

Varma hälsningar från Uppsala!
/ Erik Sundell

Säg att du gjort en forskningsstudie och skapat ett dataset som du vill tillgängliggöra för att säkerställa reproducerbarheten i en datanalys du gjort, och vars kod finns på GitHub.com.

Då kan Zenodo vara användbart att känna till, och istället för att beskriva det själv i text här, så föreslår jag denna youtubefilm som en del av en playlist om transparent forskning.

@salgo60 sa i Dela kodexempel: ett enda klick kan räcka:

har du någon bra erfarenhet/tankar hur man enklare kan hitta vilka applikationer som skapats och som använder dataset...

Hmmm nej tror det krävs en standard för deklarera datakällor. Det kan mycket väl krävas att det finns någon morot att använda denna standard för att deklarera datakällor också för att den ska tillämpas.

Jag kom att tänka på att GitHub redan kan visa vilka kodprojekt som beror på andra kodprojekt genom att söka efter välkända filnamn. På motsvarande sätt funderar jag på ifall det finns motsvarande filer som deklarerar datakällor, och jag tror det.

Jag kan inte så mycket om Intake, men det är ett verktyg som hjälper användare att konsumera data från olika källor. Med Intake så deklarerar användarna faktiskt sina datakällor i en YAML fil. Så om de börjar rekommendera ett enhetligt sätt att namnge dessa filer så vore det fullt rimligt att scanna källkod på GitHub, GitLab etc efter dessa filer.

Detta blev en avstickare från ämnet av att dela kodexempel, så jag föreslår att uppföljningar görs från en helt ny tråd i detta forum dock!

Va roligt!

Vill då kort också tipsa om en lättviktigare installation av JupyterHub kan göras utan Kubernetes med guiden på tljh.jupyter.org - då kan en ensam server används för upp till ungefär 100 samtida användare.

Vid behov kan en fråga efter hjälp på discourse.jupyter.org för övrigt, eller besöka JupyterHub's chatkanal på Gitter / Matrix.

Lycka till!

Att dela kodexempel

För några år sedan som gymnasielärare ville jag tillgängliggöra ett utbildningsmaterial som involverade programmeringskod. Jag kom fram till följande önskemål:

1. Enkelt att komma igång
2. Något icke-kommersiellt
3. Roligare än bara kod och ett terminalfönster

Jag hade upptäckt Jupyter och bestämde mig för det som grund. Jupyter är en arbetsmiljö där kod kan skrivas och köras i så kallade Jupyter Notebooks där kod, text, grafer, och annat interaktivt kan få plats. Just därför lämpar de sig väl för utbildningsmaterial tycker jag!

Två lösningar

Jag kommer presentera två lösningar för att tillgängligöra kodexempel, utbildningsmaterial, och övrigt.

Den enklare lösningen

Med gratistjänsten mybinder.org kan du dela kodexempel som blir tillgänliga för andra att köra genom ett enda länkklick.

Ungefär såhär gör du för att dela kodexempel med mybinder.org:

1. Gör kodexemplet tillgängligt på GitHub, GitLab, eller liknande.
2. Skapa en konfigurationsfil (requirements.txt för Python t.ex.) som beskriver vad som behövs installeras
3. Besök mybinder.org och skapa en länk
4. Dela länken

Exempel på kodmaterial delat via mybinder.org:

• Klassiskt kodexempel av Jupyter notebooks interaktivitet:
  https://gke.mybinder.org/v2/gh/jupyterlab/jupyterlab-demo/master?urlpath=lab/tree/demo/Lorenz.ipynb

  

• Utbildningsmaterial för maskininlärning av mig, lämpligt för engagerade elever i gymnasiet som läst iallafall matte 3:
  https://gke.mybinder.org/v2/gh/consideratio/jupyter-se-math-teacher/master?urlpath=lab/tree/source/gradient-descent/gradient-descent.ipynb

  

• Kodexempel på hur ett API av polisen.se kan användas, skapat av @salgo60 under Hack for Sweden 2019:
  https://gke.mybinder.org/v2/gh/hack-for-sweden/open-data-examples/HEAD?urlpath=lab/tree/polisen-se.ipynb

  

Den klumpigare lösningen

Som lärare ville jag att mina elever skulle kunna spara sitt arbete och liknande, men för detta krävdes något mer än mybinder.org. Jag listar nedan projekten som möjliggör detta, och är nu projekt jag har möjliggjorts att arbeta fulltid med att utveckla. Att använda dessa lämpar sig kanske bäst för universitet, skolor, företag osv. som kan investera lite tid och energi att tillhandahålla en sådan infrastruktur för sina elever, anställda, eller liknande.

• JupyterHub var ett lämpligt verktyg för att hjälpa mig göra Jupyter arbetsmiljöer tillgängliga för mina elever. Med en JupyterHub kunde de få köra koden på en extern dator istället för sin egen, och även spara sitt arbetsmaterial där osv.

• JupyterHub installerat på Kubernetes visade sig även mycket lovande för att hjälpa hela min skola eller t.om. hela skolkoncernen.

  
  University of California: Berkeley, studenter som går Data8 kursen där eleverna övar med kodexempel med hjälp av en JupyterHub.

Tack för er tid

Jag hoppas detta har kunnat fungera som en introduktion av potentiellt relevanta verktyg.

Varma hälsningar från Uppsala!
/ Erik Sundell