Deltares / Deltares/imod-python

Modflow6Simulation.split example has n_partitions instead of npartitions

Open Beginner friendly
#1,684 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
41
Forks
12
Avg merge
21h 8m
Merged PRs (30d)
1

Description

Copy-pasting the example doesn't work, since it mentions:

submodel_labels = mf6_sim.create_partition_labels(n_partitions=4)
m6_splitted = mf6_sim.split(submodel_labels)

The argument name is npartitions without an underscore.

Also "Splitted" is an archaic, nonstandard, or incorrect past tense form of the verb "to split"

Contributor guide

No contributing guide indexed for this repository

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

Locate the Modflow6Simulation.split example containing create_partition_labels(n_partitions=4) and the “Splitted” wording. Check the API spelling shown in the issue, update the example and wording, then verify that the copied example uses the correct argument and terminology.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.