Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "zeroth" tutorial as an extended version of the README for the first steps with Trixi #1292

Closed
sloede opened this issue Dec 10, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers possible student project

Comments

@sloede
Copy link
Member

sloede commented Dec 10, 2022

@torrilhon suggested to add a "zeroth" tutorial that guides users through the first steps of using Trixi, e.g.,

  1. Install Trixi and additional required packages
  2. Run a first simulation
  3. Visualize it
  4. Get an elixir from GitHub
  5. Run it
  6. Modify the elixir by, e.g., adding your own initial condition (advection with two Gaussian pulses?)

Basically an extended version of the stuff in the README, geared towards new(er) Julia users.

@sloede sloede added documentation Improvements or additions to documentation good first issue Good for newcomers possible student project labels Dec 10, 2022
@starlightknown
Copy link

starlightknown commented Dec 12, 2022

Hello, I would like to contribute to this issue, is there any style guide to follow?

@ranocha
Copy link
Member

ranocha commented Dec 12, 2022

We have a brief style guide in our docs at https://trixi-framework.github.io/Trixi.jl/stable/styleguide/

You are welcome to prepare a PR 👍 We will review it and give you feedback if another approach/style would be preferred. You can of course also start with one part in the PR, ask for feedback, and finish it based on the comments you receive.

@sloede
Copy link
Member Author

sloede commented Jan 13, 2023

@starlightknown it would be great if you could let me know if you are actively working on this yet or not? If not, we have a new student starting to work with Trixi who'd be ideal to work on this.

@JoshuaLampert
Copy link
Member

Completed in #1343.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers possible student project
Projects
None yet
Development

No branches or pull requests

5 participants