precice / precice/tutorials

Tutorial needed for Python Actions

Open Beginner friendly
#617 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
C
Stars
142
Forks
167
Avg merge
20h 24m
Merged PRs (30d)
11

Description

We already have an example for the elastic-tube-1d in the documentation: https://precice.org/configuration-action.html#python-callback-interface

We could convert this into a proper tutorial.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing elastic-tube-1d example and the Python callback interface section at precice.org/configuration-action.html#python-callback-interface. Turn the example into a standalone tutorial with clear steps and expected results, using the repository's tutorial rendering conventions; done means the tutorial is complete and renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.