{"id":23988880,"url":"https://github.com/veit/jupyter-tutorial","last_synced_at":"2025-04-14T12:14:58.648Z","repository":{"id":40286004,"uuid":"199994535","full_name":"veit/jupyter-tutorial","owner":"veit","description":"Training materials for setting up and using a research infrastructure based on Jupyter notebooks: https://cusy.io/en/seminars","archived":false,"fork":false,"pushed_at":"2025-03-15T13:06:48.000Z","size":39417,"stargazers_count":23,"open_issues_count":44,"forks_count":12,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-14T12:14:52.088Z","etag":null,"topics":["ipython","ipython-widget","ipywidget","jupyter","jupyter-notebook","jupyterhub","notebook"],"latest_commit_sha":null,"homepage":"https://jupyter-tutorial.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/veit.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":"codemeta.json","zenodo":null}},"created_at":"2019-08-01T06:52:42.000Z","updated_at":"2025-03-15T13:06:52.000Z","dependencies_parsed_at":"2023-12-25T20:25:51.582Z","dependency_job_id":"1260c500-9f6c-435f-8e9f-f259d85ea78d","html_url":"https://github.com/veit/jupyter-tutorial","commit_stats":null,"previous_names":[],"tags_count":74,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veit%2Fjupyter-tutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veit%2Fjupyter-tutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veit%2Fjupyter-tutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veit%2Fjupyter-tutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/veit","download_url":"https://codeload.github.com/veit/jupyter-tutorial/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248877961,"owners_count":21176244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ipython","ipython-widget","ipywidget","jupyter","jupyter-notebook","jupyterhub","notebook"],"created_at":"2025-01-07T16:18:42.877Z","updated_at":"2025-04-14T12:14:58.622Z","avatar_url":"https://github.com/veit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Quick start\n===========\n\n.. _badges:\n\nStatus\n------\n\n.. image:: https://img.shields.io/github/contributors/veit/jupyter-tutorial.svg\n   :alt: Contributors\n   :target: https://github.com/veit/jupyter-tutorial/graphs/contributors\n.. image:: https://img.shields.io/github/license/veit/jupyter-tutorial.svg\n   :alt: License\n   :target: https://github.com/veit/jupyter-tutorial/blob/master/LICENSE\n.. image:: https://results.pre-commit.ci/badge/github/veit/jupyter-tutorial/main.svg\n   :alt: pre-commit.ci status\n   :target: https://results.pre-commit.ci/latest/github/veit/jupyter-tutorial/main\n.. image:: https://readthedocs.org/projects/jupyter-tutorial/badge/?version=latest\n   :alt: Docs\n   :target: https://jupyter-tutorial.readthedocs.io/en/latest/\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10961038.svg\n   :alt: DOI\n   :target: https://doi.org/10.5281/zenodo.10961038\n.. image:: https://img.shields.io/badge/dynamic/json?label=Mastodon\u0026query=totalItems\u0026url=https%3A%2F%2Fmastodon.social%2F@JupyterTutorial%2Ffollowers.json\u0026logo=mastodon\n   :alt: Mastodon\n   :target: https://mastodon.social/@JupyterTutorial\n\n.. _first-steps:\n\nInstallation\n------------\n\n#. Download and unpack:\n\n   .. code-block:: console\n\n    $ curl -O https://codeload.github.com/veit/jupyter-tutorial/zip/main\n    $ unzip main\n    Archive:  main\n    …\n       creating: jupyter-tutorial-main/\n    …\n\n#. Install Python packages:\n\n   .. code-block:: console\n\n      $ cd jupyter-tutorial-main\n      $ python3 -m venv .venv\n      $ . .venv/bin/activate\n      $ python -m pip install --upgrade pip\n      $ python -m pip install -e \".[dev]\"\n\n#. Install the `Jupyter Notebook Extensions\n   \u003chttps://jupyter-contrib-nbextensions.readthedocs.io/\u003e`_ Javascript and CSS\n   files:\n\n   .. code-block:: console\n\n    $ jupyter contrib nbextension install --user\n    jupyter contrib nbextension install --user\n    Installing jupyter_contrib_nbextensions nbextension files to jupyter data directory\n    …\n    Successfully installed jupyter-contrib-core-0.3.3 jupyter-contrib-nbextensions-0.5.1\n    jupyter-highlight-selected-word-0.2.0 jupyter-latex-envs-1.4.6\n    jupyter-nbextensions-configurator-0.4.1\n    …\n    $ jupyter nbextension enable latex_envs --user --py\n    Enabling notebook extension latex_envs/latex_envs...\n          - Validating: OK\n\n#. Create HTML documentation:\n\n   Note that pandoc has to be installed. On Debian/Ubuntu you can just run\n\n   .. code-block:: console\n\n    $  sudo apt install pandoc\n\n   To create the HTML documentation run these commands:\n\n   .. code-block:: console\n\n    $ cd docs/\n    $ make html\n\n#. Create a PDF:\n\n   For the creation of a PDF file you need additional packages.\n\n   For Debian/Ubuntu you get them with the following command:\n\n   .. code-block:: console\n\n    $ sudo apt install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk\n\n   or for macOS with:\n\n   .. code-block:: console\n\n    $ brew cask install mactex\n    …\n    🍺  mactex was successfully installed!\n    $ curl --remote-name https://www.tug.org/fonts/getnonfreefonts/install-getnonfreefonts\n    $ sudo texlua install-getnonfreefonts\n    …\n    mktexlsr: Updating /usr/local/texlive/2020/texmf-dist/ls-R...\n    mktexlsr: Done.\n\n   Then you can generate a PDF with:\n\n   .. code-block:: console\n\n    $ make latexpdf\n    …\n    The LaTeX files are in _build/latex.\n    Run 'make' in that directory to run these through (pdf)latex\n    …\n\n   You can find the PDF at ``docs/_build/latex/jupytertutorial.pdf``.\n\n#. Run Vale to check spelling\n\n   You can install download cusy-vale with:\n\n   .. code-block:: console\n\n      $ vale sync\n      Syncing cusy-vale [1/1] ██████████████████████████████████████████████ 100% | 0s\n       SUCCESS  Synced 1 package(s) to '/Users/veit/cusy/trn/jupyter-tutorial/styles'.\n\n   .. seealso::\n      * `Vale installation \u003chttps://docs.errata.ai/vale/install\u003e`_\n      * `Vale formats \u003chttps://docs.errata.ai/vale/scoping#formats\u003e`_\n\n   Now you can check the RestructuredText files with:\n\n   .. code-block:: console\n\n    $ vale .\n    ✔ 0 errors, 0 warnings and 0 suggestions in 201 files.\n\n.. _follow-us:\n\nFollow us\n---------\n\n* `GitHub \u003chttps://github.com/veit/jupyter-tutorial\u003e`_\n* `Twitter \u003chttps://twitter.com/JupyterTutorial\u003e`_\n* `Mastodon \u003chttps://mastodon.social/@JupyterTutorial\u003e`_\n\nPull-Requests\n-------------\n\nIf you have suggestions for improvements and additions, I recommend that you\ncreate a `Fork \u003chttps://github.com/veit/jupyter-tutorial/fork\u003e`_ of my `GitHub\nRepository \u003chttps://github.com/veit/jupyter-tutorial/\u003e`_ and make your changes\nthere. . You are also welcome to make a *pull request*. If the changes\ncontained therein are small and atomic, I’ll be happy to look at your\nsuggestions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveit%2Fjupyter-tutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveit%2Fjupyter-tutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveit%2Fjupyter-tutorial/lists"}