@@ -29,6 +29,36 @@ To start a Jupyter Notebook instead of a Sage console, run the command
29
29
instead of just ``sage ``. To quit the Jupyter Notebook press ``<Ctrl> + <c> ``
30
30
twice in the console where you launched the command.
31
31
32
+ Environment variables
33
+ ---------------------
34
+
35
+ Sage uses the following environment variables when it runs:
36
+
37
+ - :envvar: `DOT_SAGE ` - this is the directory, to which the user has read and
38
+ write access, where Sage stores a number of files.
39
+ The default location is :file: `$HOME/.sage/ `.
40
+
41
+ - :envvar: `SAGE_STARTUP_FILE ` - a file including commands to be executed every
42
+ time Sage starts.
43
+ The default value is :file: `$DOT_SAGE/init.sage `.
44
+
45
+ - :envvar: `BROWSER ` - on most platforms, Sage will detect the command to
46
+ run a web browser, but if this doesn't seem to work on your machine, set this
47
+ variable to the appropriate command.
48
+
49
+ - :envvar: `TMPDIR ` - this variable is used by Python, and hence by
50
+ Sage; it gives the directory in which temporary files should be
51
+ stored. This includes files used by the notebook. Some browsers have
52
+ security settings which restrict the locations of files that they
53
+ will access, and users may need to set this variable to handle this
54
+ situation.
55
+
56
+ - See
57
+ https://docs.python.org/3/using/cmdline.html#environment-variables
58
+ for more variables used by Python (not an exhaustive list). With
59
+ Python 3.11 or later, a brief summary can also be obtained by
60
+ running `python3 --help-env `.
61
+
32
62
Using a Jupyter Notebook remotely
33
63
---------------------------------
34
64
0 commit comments