GenericMappingTools / GenericMappingTools/pygmt

Resetting default GMT parameters - pygmt.config

Open
#486 3 comments 0 reactions 0 assignees View on GitHub
feature request help wanted longterm upstream
Dominant language
Python
Stars
874
Forks
255
Avg merge
1d 21h
Merged PRs (30d)
40

Description

**Description of the desired feature**

The `pygmt.config` class/context manager allows the user to permanently or temporarily override default GMT config parameters. If a parameter is set permanently (particularly in a notebook), it would be useful to be able to reset back to the default without having to reset the kernel / use `pygmt.config` as a context manager. Motivated by https://github.com/GenericMappingTools/pygmt/pull/482#issuecomment-647040633

**Are you willing to help implement and maintain this feature?** Yes

I've been able to override and reset everything myself by terminating and restarting the global session:

```python
from pygmt import session_management

session_management.end()
session_management.begin()
```

but this is obviously not ideal, and I fear this may have unintended consequences of which I'm ignorant. I see this feature more as something to facilitate figure _development_ in a notebook, but not so much for finalised figure scripts/notebooks, so it's perhaps not a huge issue?

Ideal usage would be something like:

```python
pygmt.config().reset()
```

I'm still familiarising myself with the inner workings, so I apologise if I've missed/misunderstood something important.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.