[Documentation] Cores and threads_per_core

Open
#999 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation, hpc

Research direction

Review the current documentation and the proposed changes in pull request 998, with attention to the cores and threads_per_core parameters and existing examples. Determine whether the documentation sufficiently explains their relationship; done means the behavior and terminology are clear without requiring a parameter rename.

Written by the indexing model from the issue text.

Description

documentation

The cores parameter is only useful when being used with mpi4py which is still a minority of the users of executorlib. So one suggestion would be to rename cores to mpi4py_cores and have the product of cores and threads_per_core accessible to the user under the variable name cores. But such a change would break the current examples and be confusing for users who are familiar with the current functionality, so it is not something I can do easily at the moment.

At the moment I extended the current documentation, to help clarify the confusion:
https://github.com/pyiron/executorlib/pull/998

Dominant language
Python
Stars
77
Forks
7
Avg merge
10h 32m
Merged PRs (30d)
12

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.

More from pyiron/executorlib

All issues in pyiron/executorlib

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.