{"id":21044317,"url":"https://github.com/trixi-framework/tutorial-2021-icosahom","last_synced_at":"2025-05-15T17:32:38.270Z","repository":{"id":48803776,"uuid":"383198344","full_name":"trixi-framework/tutorial-2021-icosahom","owner":"trixi-framework","description":"Trixi.jl: High-Order Numerical Simulations of Hyperbolic PDEs in Julia","archived":false,"fork":false,"pushed_at":"2023-02-21T07:48:58.000Z","size":841,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-11-10T00:53:09.153Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trixi-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-05T16:12:13.000Z","updated_at":"2023-11-15T08:59:09.000Z","dependencies_parsed_at":"2022-07-26T14:18:12.201Z","dependency_job_id":null,"html_url":"https://github.com/trixi-framework/tutorial-2021-icosahom","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trixi-framework%2Ftutorial-2021-icosahom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trixi-framework%2Ftutorial-2021-icosahom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trixi-framework%2Ftutorial-2021-icosahom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trixi-framework%2Ftutorial-2021-icosahom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trixi-framework","download_url":"https://codeload.github.com/trixi-framework/tutorial-2021-icosahom/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225365735,"owners_count":17462973,"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":[],"created_at":"2024-11-19T14:16:17.782Z","updated_at":"2024-11-19T14:16:18.440Z","avatar_url":"https://github.com/trixi-framework.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Trixi.jl: High-Order Numerical Simulations of Hyperbolic PDEs in Julia\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7659914.svg)](https://doi.org/10.5281/zenodo.7659914)\n\nThis is the companion repository for the tutorial on\n[Trixi.jl](https://github.com/trixi-framework/Trixi.jl) at\n[ICOSAHOM 2021](https://www.icosahom2020.org):\n\n**Tutorial 2: Trixi.jl**\u003cbr /\u003e\n*Venue:* gather.town\u003cbr /\u003e\n*Date \u0026 time:* Wednesday, 14th July 2021, 6:10pm - 8:10pm (CEST)\u003cbr /\u003e\n*Chaired by:* Hendrik Ranocha, Michael Schlottke-Lakemper\u003cbr /\u003e\n*Link:* [conference agenda](https://www.conftool.com/icosahom2020/index.php?page=browseSessions\u0026form_session=71\u0026presentations=show)\n\nThe `gather.town` link will be available in the conference agenda just shortly\nbefore the official start.\n\nIn case of questions before the beginning of the tutorial, please get in touch with\n[Hendrik](https://ranocha.de) or\n[Michael](https://www.mi.uni-koeln.de/NumSim/schlottke-lakemper),\n[create an issue](https://github.com/trixi-framework/tutorial-2021-icosahom/issues/new),\nor\n[join the Trixi.jl Slack workspace](https://join.slack.com/t/trixi-framework/shared_invite/zt-sgkc6ppw-6OXJqZAD5SPjBYqLd8MU~g).\n\n**Table of contents**\n1. [Schedule](#schedule)\n2. [Floor plan](#floor-plan)\n3. [Tutorial files](#tutorial-files)\n4. [Abstract](#abstract)\n5. [Getting started](#getting-started)\n   1. [Using mybinder.org](#using-mybinderorg)\n   2. [Setting up a local Julia/Jupyter installation](#setting-up-a-local-juliajupyter-installation)\n6. [Authors](#authors)\n7. [License](#license)\n\n\n## Schedule\n\nThe [Auditorium](#auditorium) will be used to give a few guided sessions on how\nto use Trixi.jl and Julia. The [Computer Lab](#computer-lab) has work spaces to\ntry out Trixi.jl on your own and with the help of our instructors. Please check\nout the [floor plan](#floor-plan) to help with finding out where everything is\nlocated.\n\n*Note:* All times are in Central European Summer Time (CEST).\n\n### Auditorium\n1. **6:20pm: What is Trixi.jl and how can I use it for my own projects?**\u003cbr /\u003e\n   *Speaker:* Hendrik Ranocha\u003cbr /\u003e\n   *Duration:* approx. 15 minutes + Q\u0026A\u003cbr /\u003e\n\n   * Overview of Trixi's capabilities\n   * Learn how to set up and run simulations\n   * Extend Trixi for your own research\n   * Q\u0026A\n\n   *Hands-on:* the Jupyter notebook `introduction_to_trixi.ipynb` (see\n   [below](#tutorial-files)) can be used to simultaneously try out the\n   examples in the presentation\n\n2. **6:45pm: Getting started with Julia**\u003cbr /\u003e\n   *Speaker:* Hendrik Ranocha\u003cbr /\u003e\n   *Duration:* approx. 10 minutes + Q\u0026A\n\n   * Brief introduction to Julia for newcomers\n   * Learn about the syntax, the type model, and multiple dispatch\n   * Q\u0026A\n\n   *Hands-on:* the Jupyter notebook `introduction_to_julia.ipynb` (see\n   [below](#tutorial-files)) can be used to simultaneously try out the\n   examples in the presentation\n\n3. **7:05pm: From grid generation to visualization: Working with unstructured curved meshes in Trixi.jl**\u003cbr /\u003e\n   *Speaker:* Andrew R. Winters\u003cbr /\u003e\n   *Duration:* approx. 15 minutes + Q\u0026A\n\n   * Introduction to using HOHQMesh.jl to generate high-order meshes\n   * Understand how to set up an unstructured simulation in Trixi\n   * Learn about the visualization pipeline with Trixi2Vtk.jl and ParaView\n   * Q\u0026A\n\n### Computer Lab\nThe Computer Lab can be used any time to try out Julia and Trixi.jl in a\nhands-on session either in small groups or alone. There are 18 lab tables\navailable (see [floor plan](#floor-plan)), each being a private space where you\ncan talk to all people at the same table.  Throughout the room and/or at the\norganizer table near the south wall, you will find a number of instructors who\nyou can ask for assistance with using Trixi.jl or Julia (just walk up to us and\nask away!):\n\n* Christof Czernik\n* Erik Faulhaber\n* Hendrik Ranocha\n* Michael Schlottke-Lakemper\n* Andrew R. Winters\n\n\n## Floor plan\n![floorplan-icosahom-tutorial](https://user-images.githubusercontent.com/3637659/125036952-e1eaae00-e093-11eb-8b98-95d8b547e5c6.jpg)\n\n\n## Tutorial files\n| Item | [nbviewer](https://nbviewer.jupyter.org/) | [mybinder](https://mybinder.org/) |\n|:-|:-:|:-:|\n| [`introduction_to_trixi.ipynb`](introduction_to_trixi.ipynb) | [![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.jupyter.org/github/trixi-framework/tutorial-2021-icosahom/blob/main/introduction_to_trixi.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trixi-framework/tutorial-2021-icosahom/HEAD?filepath=introduction_to_trixi.ipynb) |\n| [`introduction_to_julia.ipynb`](introduction_to_julia.ipynb) | [![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.jupyter.org/github/trixi-framework/tutorial-2021-icosahom/blob/main/introduction_to_julia.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trixi-framework/tutorial-2021-icosahom/HEAD?filepath=introduction_to_julia.ipynb) |\n| [`exercises_linear_advection.ipynb`](exercises_linear_advection.ipynb) | [![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.jupyter.org/github/trixi-framework/tutorial-2021-icosahom/blob/main/exercises_linear_advection.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trixi-framework/tutorial-2021-icosahom/HEAD?filepath=exercises_linear_advection.ipynb) |\n| [`exercises_euler.ipynb`](exercises_euler.ipynb) | [![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.jupyter.org/github/trixi-framework/tutorial-2021-icosahom/blob/main/exercises_euler.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trixi-framework/tutorial-2021-icosahom/HEAD?filepath=exercises_euler.ipynb) |\n| [`unstructured_mesh/exercises_unstructured_mesh.ipynb`](unstructured_mesh/exercises_unstructured_mesh.ipynb) | [![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.jupyter.org/github/trixi-framework/tutorial-2021-icosahom/blob/main/unstructured_mesh/exercises_unstructured_mesh.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trixi-framework/tutorial-2021-icosahom/HEAD?filepath=unstructured_mesh/exercises_unstructured_mesh.ipynb) |\n\nAdditional tutorials are available in the\n[documentation of Trixi.jl](https://trixi-framework.github.io/Trixi.jl/stable/).\n\n\n## Abstract\n\nTrixi.jl is a numerical simulation framework for adaptive, high-order\ndiscretizations of conservation laws. It has a modular architecture that\nallows users to easily extend its functionality and was designed to be\nuseful to experienced researchers and new users alike.\nIn this tutorial we will demonstrate what you can do with Trixi.jl and\nhow you can use it (and extend it) for your own research. Furthermore,\nthere will be a hands-on session to try out Trixi for yourself, and time\nto talk to the Trixi developers. We will also include a short\nintroduction to Julia for those who have not used the language before.\n\n\n## Getting started\n\nYou can view a static version of the Jupyter notebooks `*.ipynb`\n\n- directly on GitHub (select the notebook; this may fail sometimes)\n- or on [nbviewer.jupyter.org](https://nbviewer.jupyter.org/)\n  (select the \"render\" badges in the table of contents above)\n\nThese static versions do not contain output of the code cells.\n\nBelow you will find information on how to use the notebooks either via\n[mybinder.org](#using-mybinderorg) or by\n[setting up a local installation](#setting-up-a-local-juliajupyter-installation).\nIf you are only interested in installing Julia and Trixi without the Jupyter\nsetup, you can also watch a [video on YouTube](https://www.youtube.com/watch?v=gfnodCRU2As).\n\n### Using mybinder.org\nThe easiest way to get started is to click on the *Launch Binder* badges\nin the table of contents above.\nThis launches the notebook for interactive use in your browser without the need\nto download or install anything locally.\n\nIn this case, you can skip the rest of this *Getting started* section. A\nJupyter instance will be started automagically in the cloud via\n[mybinder.org](https://mybinder.org), and the notebook will loaded directly from\nthis repository.\n\n*Note:*  Depending on current usage and available resources, it typically takes\na few minutes to launch a notebook with [mybinder.org](https://mybinder.org)\n(sometimes a little longer), so try to remain patient. Similarly, the first two\ncells of the notebook take much longer to execute than usual (around 1.5 minutes\nfor the first Trixi simulation and about 1 minute for the first plot), since\nJulia compiles all methods \"just-ahead-of-time\" at first use. Subsequent runs\nwill be much faster.\n\n### Setting up a local Julia/Jupyter installation\nAlternatively, you can also clone this repository and open the notebook on your\nlocal machine. This is recommended if you already have a Julia + Jupyter setup\nor if you plan to try out Julia anyways.\n\n#### Installing Julia and IJulia\nTo obtain Julia, go to https://julialang.org/downloads/ and download the latest\nstable release (v1.6.1 as of 2021-07-07; neither use the LTS release nor\nJulia Pro). Then, follow the\n[platform-specific instructions](https://julialang.org/downloads/platform/)\nto install Julia on your machine. Note that there is no need to compile anything\nif you are using Linux, MacOS, or Windows.\n\nAfter the installation, open a terminal and start the Julia *REPL*\n(i.e., the interactive prompt) with\n```shell\njulia\n```\nTo use the notebook, you also need to get the\n[IJulia](https://github.com/JuliaLang/IJulia.jl) package, which provides a Julia\nbackend for Jupyter. In the REPL, execute\n```julia\nusing Pkg\nPkg.add(\"IJulia\")\n```\nto install IJulia. For more details, especially on how to use an existing Jupyter\ninstallation, please refer to the\n[IJulia documentation](https://julialang.github.io/IJulia.jl/stable/).\nFrom here on, we assume that you have a working installation of Julia, Jupyter,\nand the Julia kernel for Jupyter.\n\n#### Installing the required Julia packages\nTo make the notebook fully reproducible, we have used Julia's package manager\nto pin all packages to a fixed release. This ensures that you always have a\nJulia environment in which all examples in this notebook work. Later you can\nalways install the latest versions of Trixi and its dependencies by following\nthe instructions in the Trixi\n[documentation](https://trixi-framework.github.io/Trixi.jl/stable/).\n\nIf you have not done it yet, clone the repository where this notebook is stored:\n```shell\ngit clone https://github.com/trixi-framework/tutorial-2021-icosahom.git\n```\nThen, navigate to your repository folder and install the required packages:\n```shell\ncd tutorial-2021-icosahom\njulia --project=. -e 'using Pkg; Pkg.instantiate()'\n```\nThis will download and build all required packages, including the ODE package\n[OrdinaryDiffEq](https://github.com/SciML/OrdinaryDiffEq.jl), the visualization\npackage [Plots](https://github.com/JuliaPlots/Plots.jl), and of course\n[Trixi](https://github.com/trixi-framework/Trixi.jl).\nThe `--project=.` argument tells Julia to use the `Project.toml`\nand `Manifest.toml` files from this repository to figure out which packages to install.\n\nAs an alternative to running the examples in the notebook directly, you may\nalso just view the notebook *statically* by opening it within\n[Jupyter NBViewer](https://nbviewer.jupyter.org/github/trixi-framework/talk-2021-Introduction_to_Julia_and_Trixi/blob/main/Talk.ipynb?flush_cache=true).\n\n*General note:* Make sure that you execute the examples (either in the notebook\nor in the REPL) *in order*, at least for the first time. Both the notebook and\nthe Julia REPL maintain an internal state and and some snippets depend on\nearlier statements having been executed.\n\n#### Displaying the presentation\n\nTo display the presentation as in the talk (skipping some cells/slides that\nprovide further information), you need the\n[Jupyter extension RISE](https://rise.readthedocs.io/en/stable),\nthat you can install via\n```shell\npip3 install --user RISE\n```\nAfter opening the Jupyter notebook, you can enter the RISE presentation mode\nwith `Alt + R`.\n\n\n## Authors\nThis repository was initiated by\n[Hendrik Ranocha](https://ranocha.de),\n[Michael Schlottke-Lakemper](https://www.mi.uni-koeln.de/NumSim/schlottke-lakemper)\nand [Andrew R. Winters](https://liu.se/en/employee/andwi94).\n\n\n## License\nThe contents of this repository are licensed under the MIT license\n(see [LICENSE.md](LICENSE.md)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrixi-framework%2Ftutorial-2021-icosahom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrixi-framework%2Ftutorial-2021-icosahom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrixi-framework%2Ftutorial-2021-icosahom/lists"}