|
1 | 1 | # Environmental Variables |
2 | 2 |
|
3 | | -Several environment variables can be used to control the behavior of PyGMT. These |
4 | | -environment variables can be set in your shell or in your Python script using the |
| 3 | +PyGMT's behavior can be controlled through various environment variables. These variables |
| 4 | +can be set either in your shell environment or within your Python script using the |
5 | 5 | :py:data:`os.environ` dictionary. |
6 | 6 |
|
7 | | -Here we list the environment variables that are used by PyGMT. The environment |
8 | | -variables are divided into three categories: system environment variables, GMT/PyGMT |
9 | | -environment variables, and module-specific environment variables. |
| 7 | +Here we list the environment variables used by PyGMT. The environment variables are |
| 8 | +categorized into three groups: |
| 9 | + |
| 10 | +1. System environment variables |
| 11 | +2. GMT/PyGMT environment variables |
| 12 | +3. Module-specific environment variables |
10 | 13 |
|
11 | 14 | ## System Environment Variables |
12 | 15 |
|
13 | 16 | ```{glossary} |
14 | 17 | TZ |
15 | | - Specify the time zone for the current calendar time. Refer to the |
16 | | - [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html) |
17 | | - for the valid format. |
| 18 | + Specify the time zone for the current calendar time. It can be set to a string that |
| 19 | + defines the timezone, such as `"UTC"`, `"America/New_York"`, or `"Europe/London"`. |
| 20 | + Refer to the [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html) |
| 21 | + for the valid format. If not set, the system's default timezone is used. |
18 | 22 | ``` |
19 | 23 |
|
20 | 24 | ## GMT/PyGMT Environment Variables |
21 | 25 |
|
22 | 26 | ```{glossary} |
23 | 27 | GMT_LIBRARY_PATH |
24 | | - Directory to the GMT library. |
| 28 | + Specify the directory where the GMT shared library is located. This is useful when |
| 29 | + GMT is installed in a non-standard location or when you want to use a specific |
| 30 | + version of GMT. If not set, PyGMT will attempt to find the GMT library in standard |
| 31 | + system locations. |
25 | 32 |
|
26 | 33 | PYGMT_USE_EXTERNAL_DISPLAY |
27 | | - Setting this environment variable to `"false"` can disable image preview in |
28 | | - external viewers. It's useful when running the tests and building the documentation |
29 | | - to avoid popping up windows. |
| 34 | + Whether to use external viewers for displaying images. If set to `"false"`, PyGMT |
| 35 | + will not attempt to open images in external viewers. This can be useful when running |
| 36 | + tests or building the documentation to avoid popping up windows. |
30 | 37 | ``` |
31 | 38 |
|
32 | 39 | ## Module-Specific Environment Variables |
33 | 40 |
|
34 | 41 | ```{glossary} |
35 | 42 | X2SYS_HOME |
36 | | - Specify the directory where the x2sys-related functions (e.g., |
37 | | - {func}`pygmt.x2sys_init`) can keep track of the x2sys settings. |
| 43 | + Specify the directory where x2sys databases and related settings will be stored. |
| 44 | + This environment variable is used by x2sys-related functions (e.g., |
| 45 | + {func}`pygmt.x2sys_init`) to manage and access x2sys data. If not set, these |
| 46 | + functions will use a default directory or prompt for a location. |
38 | 47 | ``` |
0 commit comments