File: environment.rst

package info (click to toggle)
sasview 6.1.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 152,244 kB
  • sloc: python: 58,639; cpp: 6,412; javascript: 173; makefile: 167; sh: 67; xml: 40
file content (39 lines) | stat: -rw-r--r-- 1,073 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.. _Environment_Variables:

Environment Variables
======================

SasView creates and uses a number of environment variables:

- **SAS_MODELPATH=path**
   - sets the directory containing custom models

- **SAS_DLL_PATH=path**
   - sets the path to the compiled modules
   
- **SAS_WEIGHTS_PATH=~/.sasview/weights**
   - sets the path to custom distribution files (see :ref:`polydispersityhelp`)

- **XDG_CACHE_HOME=~/.cache/**
   - sets the pyopencl cache root (on Linux)

- **XDG_CONFIG_HOME=~/.config**
   - sets configuration file location (on Linux)
   - used via the `platformdirs <https://github.com/tox-dev/platformdirs?tab=readme-ov-file#example-output>` package

- **SAS_COMPILER=tinycc|msvc|mingw|unix**
   - sets the DLL compiler

- **SAS_OPENCL=vendor:device|none**
   - sets the target OpenCL device for GPU computations
   - use *none* to disable

- **SAS_OPENMP=1|0**
   - turns on/off OpenMP multi-processing of the DLLs

.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

*Document History*

| 2018-07-20 Steve King