v15 Config
Open
Nobody has claimed this yet.
v15
- Dominant language
- Python
- Stars
- 279
- Forks
- 177
- PR merge metrics
- No merged PRs in 30d
Description
Add global configuration settings
Allow py4DSTEM functions to search for globally defined settings rather than requiring args/kwargs set per function call.
py4DSTEM.config.set_GPU(True) or py4DSTEM.config = {'GPU' : True}, etc.
- Determine minimal implementation that will not break the existing code.
- Workout which settings should be stored in global config.
- Determine how ephemeral the config is - per session vs stored in a file and loaded.
- Determine how global config is overruled by local args/kwargs.
- create new functions that search for global config and args/kwargs.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing py4DSTEM function arguments and kwargs to identify settings that could be shared globally. Define the intended configuration scope, persistence, and precedence between global values and local arguments, then verify that affected functions can search and apply the configuration without breaking current calls.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100