Skip to content

Commit

Permalink
🔧 Moving the Data Science content into Python4DataScience
Browse files Browse the repository at this point in the history
* /first-steps/index.html -> /notebook/index.html
* /first-steps/create-notebook.html -> /notebook/create-notebook.html
* /first-steps/install.html -> /notebook/install.html
* /workspace/jupyter/$rest -> /
* /workspace/first-steps/$rest -> /notebook/
* /workspace/ipython/$rest -> Python4DataScience:/workspace/ipython/
* /workspace/numpy/$rest -> Python4DataScience:/workspace/numpy/
* /workspace/pandas/$rest -> Python4DataScience:/workspace/pandas/
* /data-processing/$rest -> Python4DataScience:/data-processing/
* /clean-prep/$rest -> Python4DataScience:/clean-prep/
* /parameterise/$rest -> /notebook/parameterise/
* /performance/ipyparallel//$rest -> /hub/ipyparallel/
* /performance/ -> Python4DataScience:/performance/
* /productive/ -> Python4DataScience:/productive/
* /testing/$rest ->  /notebook/testing/
* /web/dashboards/$rest ->  /dashboards/
  • Loading branch information
veit committed Jun 16, 2023
1 parent 60e197d commit b97f868
Show file tree
Hide file tree
Showing 133 changed files with 3,177 additions and 356 deletions.
50 changes: 26 additions & 24 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
cff-version: "1.1.0"
message: "If you use this tutorial, please cite it as below."
cff-version: 1.2.0
title: Jupyter-Tutorial
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
-
- given-names: Veit
family-names: Schiele
given-names: Veit
orcid: "https://orcid.org/https://orcid.org/0000-0002-2448-8958"
email: veit@cusy.io
affiliation: cusy GmbH
identifiers:
-
type: doi
value: "10.5281/zenodo.4147287"
- type: doi
value: 10.5281/zenodo.8047111
repository-code: 'https://github.com/veit/jupyter-tutorial-de'
url: 'https://jupyter-tutorial.readthedocs.io/de/latest/'
abstract: >-
Schulungsmaterialen für den Aufbau und die Nutzung einer
Forschungsinfrastruktur auf Basis von Jupyter Notebooks.
keywords:
- "data-science"
- jupyter
- "jupyter-notebooks"
- "jupyter-kernels"
- ipython
- pandas
- spack
- pipenv
- ipywidgets
- "ipython-widget"
- dvc
title: "Jupyter tutorial"
version: "0.8.0"
date-released: 2020-10-08
license: "BSD-3-Clause"
repository-code: "https://github.com/veit/jupyter-tutorial"
- Jupyter
- Notebook
- iPython
- Jupyter-Notebook
- JupyterHub
- iPython-Widget
- ipywidget
license: BSD-3-Clause
version: 1.0.0
date-released: '2023-06-16'
23 changes: 10 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,36 +48,34 @@ Installation

.. code-block:: console
$ cd jupyter-tutorial-main
$ pipenv install
Creating a virtualenv for this project…
$ cd jupyter-tutorial-de-main
$ python3 -m venv .
$ . bin/activate
$ python -m pip install -r docs/requirements.txt
#. Installieren der `Jupyter Notebook Extensions
<https://jupyter-contrib-nbextensions.readthedocs.io/>`_:

.. code-block:: console
$ pipenv run jupyter contrib nbextension install --user
$ jupyter contrib nbextension install --user
jupyter contrib nbextension install --user
Installing jupyter_contrib_nbextensions nbextension files to jupyter data directory
Successfully installed jupyter-contrib-core-0.3.3 jupyter-contrib-nbextensions-0.5.1
jupyter-highlight-selected-word-0.2.0 jupyter-latex-envs-1.4.6
jupyter-nbextensions-configurator-0.4.1
$ pipenv run jupyter nbextension enable latex_envs --user --py
$ jupyter nbextension enable latex_envs --user --py
Enabling notebook extension latex_envs/latex_envs...
- Validating: OK
#. HTML-Dokumentation erstellen:

.. code-block:: console
$ python3 -m venv .
$ bin/python -m pip install --upgrade pip
$ bin/python -m pip install -r docs/constraints.txt
$ bin/sphinx-build -ab html docs/ docs/_build/
$ cd docs/
$ make html
#. PDF erstellen:

Expand All @@ -87,7 +85,7 @@ Installation

.. code-block:: console
$ sudo apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk
$ sudo apt install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk
oder für macOS mit:

Expand All @@ -106,8 +104,7 @@ Installation

.. code-block:: console
$ cd docs/
$ pipenv run make latexpdf
$ make latexpdf
The LaTeX files are in _build/latex.
Run 'make' in that directory to run these through (pdf)latex
Expand Down
41 changes: 41 additions & 0 deletions codemeta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"codeRepository": "https://github.com/veit/jupyter-tutorial-de/",
"dateCreated": "2023-06-16",
"datePublished": "2023-06-16",
"dateModified": "2023-06-16",
"downloadUrl": "https://github.com/veit/jupyter-tutorial-de/archive/refs/tags/v1.0.0.tar.gz",
"issueTracker": "https://github.com/veit/jupyter-tutorial-de/issues",
"name": "Jupyter-Tutorial",
"version": "1.0.0",
"description": "Schulungsmaterialen für den Aufbau und die Nutzung einer Forschungsinfrastruktur auf Basis von Jupyter Notebooks.",
"developmentStatus": "active",
"isPartOf": "https://www.python4data.science/de/latest/",
"referencePublication": "https://doi.org/10.5281/zenodo.8047111",
"keywords": [
"Jupyter",
"iPython",
"Jupyter-Kernel",
"iPython-Widget",
"ipywidget",
"Notebook",
"JupyterHub",
""
],
"relatedLink": [
"https://jupyter-tutorial.readthedocs.io/de/latest/"
],
"author": [
{
"@type": "Person",
"givenName": "Veit",
"familyName": "Schiele",
"email": "veit@cusy.io",
"affiliation": {
"@type": "Organization",
"name": "cusy GmbH"
}
}
]
}
8 changes: 6 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = "Veit Schiele"

# The full version, including alpha/beta/rc tags
release = "0.9.0"
release = "1.0.0"


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -82,7 +82,7 @@
# documentation.
#
# Change default HTML title
html_title = "Jupyter Tutorial 0.9.0"
html_title = "Jupyter Tutorial 1.0.0"
#
# html_theme_options = {}
# html_sidebars = {}
Expand Down Expand Up @@ -161,6 +161,10 @@
"https://python-basics-tutorial.readthedocs.io/de/latest/",
None,
),
"python4datascience": (
"https://python4datascience.readthedocs.io/de/latest/",
None,
),
}


Expand Down
File renamed without changes.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,7 @@ Der Server kann mit folgenden drei Optionen konfiguriert werden:
zeigt andere Schaltflächen im App-Modus an, z.B. :menuselection:`Logout`;
Voreinstellung: ``True``

Weitere Infos zur Server-Konfiguration erhaltet ihr in
:doc:`/workspace/jupyter/notebook/config`.
Weitere Infos zur Server-Konfiguration erhaltet ihr in :doc:`/notebook/config`.

Clientseitige Konfiguration
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
10 changes: 5 additions & 5 deletions docs/web/dashboards/index.rst → docs/dashboards/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Dashboards
einem Gestaltungsraster oder in Berichtform angeordnet werden können.
:doc:`appmode/index`
Jupyter-Erweiterung, die aus Notebooks Webanwendungen macht.
:doc:`/workspace/jupyter/nbviewer`
:doc:`/nbviewer`
Er eignet sich hervorragend zum Anzeigen statischer Berichte, kann
aber auch zusammen mit :doc:`interaktiven Widgets
</workspace/jupyter/ipywidgets/embedding>` verwendet werden, deren Status im
Notebook-Dokument selbst gespeichert werden.
aber auch zusammen mit :doc:`interaktiven Widgets </ipywidgets/embedding>`
verwendet werden, deren Status im Notebook-Dokument selbst gespeichert
werden.
:doc:`panel/index`
wurde auf Basis von `Bokeh <https://docs.bokeh.org/>`_ und
`Param <https://github.com/holoviz/param>`_ entwickelt und bietet ein
Expand Down Expand Up @@ -47,7 +47,7 @@ Lizenzen der verschiedenen Bibliotheken vergleichen.

jupyter-dashboards/index
appmode/index
/workspace/jupyter/nbviewer
/nbviewer
panel/index
voila/index
jupyter-flex/index
File renamed without changes.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Jupyter-Erweiterung, die aus Notebooks Dashboards macht:
und die Komponenten des Dashboards zu definieren
* flexible und einfache Möglichkeit, zeilen- und spaltenorientierte Layouts
festzulegen
* verwendet :doc:`/workspace/jupyter/nbconvert` für statische Berichte
* verwendet :doc:`/nbconvert` für statische Berichte
* verwendet :doc:`../voila/index` für dynamische Anwendungen mit einem
Jupyter-:doc:`/workspace/jupyter/kernels/index`
* Unterstützung von :doc:`/workspace/jupyter/ipywidgets/index`
Jupyter-:doc:`/kernels/index`
* Unterstützung von :doc:`/ipywidgets/index`

.. seealso::
* `Docs <https://jupyter-flex.extrapolations.dev/>`_
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ FastAPI-Integration
Panel läuft üblicherweise auf einem :doc:`pyviz:bokeh/bokeh-server`, der
wiederum auf `Tornado <https://www.tornadoweb.org/en/stable/>`_ läuft. Es ist
jedoch auch oft nützlich, eine Panel-App in eine große Webanwendung einzubetten,
wie :abbr:`z.B. (zum Beispiel)` einen
:doc:`/data-processing/apis/fastapi/index`-Webserver. Die Integration in FastAPI
ist einfacher im Vergleich zu anderen wie :abbr:`z.B. (zum Beispiel)`
wie :abbr:`z.B. (zum Beispiel)` einen FastAPI-Webserver. Die Integration in
FastAPI ist einfacher im Vergleich zu anderen wie :abbr:`z.B. (zum Beispiel)`
:doc:`Flask <pyviz:bokeh/embedding-export/flask>`, da es ein leichtgewichtigeres
Framework ist. Die Verwendung von Panel mit FastAPI erfordert nur ein wenig mehr
Aufwandals bei Notebooks und Bokeh-Servern.
Expand All @@ -23,7 +22,6 @@ beginnen, müssen wir einige der grundlegenden Konfigurationen in
.. literalinclude:: fastAPI/main.py
:caption: fastAPI/main.py
:name: fastAPI/main.py

:linenos:
:lines: 1-3, 5-7

Expand Down Expand Up @@ -59,7 +57,6 @@ beginnen, müssen wir einige der grundlegenden Konfigurationen in
.. literalinclude:: fastAPI/main.py
:caption: fastAPI/main.py
:name: fastAPI/main.py

:lineno-start: 22
:lines: 22-

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ Features
--------

* Voilà unterstützt :doc:`interaktive Jupyter-Widgets
</workspace/jupyter/ipywidgets/index>`, einschließlich der Roundtrips zum
</ipywidgets/index>`, einschließlich der Roundtrips zum
Kernel. Auch benutzerdefinierte Widgets wie
:doc:`pyviz:d3js/bqplot/index`,
:doc:`pyviz:js/ipyleaflet`,
:doc:`pyviz:js/ipyvolume`,
`ipympl <https://github.com/matplotlib/ipympl>`_,
:doc:`ipysheet </workspace/jupyter/ipywidgets/libs/ipysheet>`,
:doc:`ipysheet </ipywidgets/libs/ipysheet>`,
`plotly <https://github.com/plotly/plotly.py>`_,
`ipywebrtc <https://github.com/maartenbreddels/ipywebrtc>`_ usw. werden
unterstützt.
* Voilà erlaubt keine willkürliche Ausführung von Code durch Nutzer von
Dashboards.
* Voilà basiert auf Jupyter-Standardprotokollen und -Dateiformaten und
funktioniert mit jedem
:doc:`Jupyter-Kernel </workspace/jupyter/kernels/index>`: C++, Python, Julia.
:doc:`Jupyter-Kernel </kernels/index>`: C++, Python, Julia.
Dies macht es zu einem sprachunabhängigen Dashboard-System.
* Voilà ist erweiterbar. Es enthält ein flexibles :doc:`Template
<templating>`-System zur Erstellung
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ Ein Voilà-Template ist ein Ordner, der sich im Virtual-environment unter
{"base_template": "default"}
``nbconvert_templates``
Benutzerdefinierte Templates für :doc:`/workspace/jupyter/nbconvert`.
Benutzerdefinierte Templates für :doc:`/nbconvert`.
``static``
Verzeichnis für statische Dateien.
``templates``
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/workspace/jupyter/hub/index.rst → docs/hub/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ JupyterHub
==========

`JupyterHub <https://jupyterhub.readthedocs.io/>`_ ist ein Multi-User Server für
:doc:`Jupyter Notebooks </workspace/jupyter/notebook/index>`, der viele
verschiedene Instanzen von Jupyter Notebooks erzeugen und verwalten kann und der
als Proxy fungiert.
:doc:`Jupyter Notebooks </notebook/index>`, der viele verschiedene Instanzen von
Jupyter Notebooks erzeugen und verwalten kann und der als Proxy fungiert.

.. toctree::
:hidden:
Expand All @@ -15,3 +14,4 @@ als Proxy fungiert.
config
systemdspawner
nbviewer-service
ipyparallel/index
File renamed without changes.

0 comments on commit b97f868

Please sign in to comment.