Skip to content

Commit 7e0a31d

Browse files
author
Christopher Doris
committed
document config options
1 parent de6e122 commit 7e0a31d

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/src/juliacall.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,25 @@ Here is an example:
8585
Alternatively you can use `add`, `rm`, etc. from JuliaPkg to edit this file.
8686

8787
See [JuliaPkg](https://github.com/cjdoris/PyJuliaPkg) for more details.
88+
89+
## [Configuration](@id julia-config)
90+
91+
Some features of the Julia process, such as the optimization level or number of threads, may
92+
be configured in two ways:
93+
- As an `-X` argument to Python, such as `-X juliacall-optlevel=3`; or
94+
- As an environment variable, such as `PYTHON_JULIACALL_OPTLEVEL=3`.
95+
96+
| `-X` option | Environment Variable | Description |
97+
| :---------- | :------------------- | :---------- |
98+
| `-X juliacall-home=<dir> | `PYTHON_JULIACALL_BINDIR=<dir>` | The directory containing the julia executable. |
99+
| `-X juliacall-check-bounds=<yes|no|auto>` | `PYTHON_JULIACALL_CHECK_BOUNDS=<yes|no|auto>` | Enable or disable bounds checking. |
100+
| `-X juliacall-compile=<yes|no|all|min>` | `PYTHON_JULIACALL_COMPILE=<yes|no|all|min>` | Enable or disable JIT compilation. |
101+
| `-X juliacall-compiled-modules=<yes|no>` | `PYTHON_JULIACALL_COMPILED_MODULES=<yes|no>` | Enable or disable incrementally compiling modules. |
102+
| `-X juliacall-depwarn=<yes|no|error>` | `PYTHON_JULIACALL_DEPWARN=<yes|no|error>` | Enable or disable deprecation warnings. |
103+
| `-X juliacall-inline=<yes|no>` | `PYTHON_JULIACALL_INLINE=<yes|no>` | Enable or disable inlining. |
104+
| `-X juliacall-min-optlevel=<0|1|2|3>` | `PYTHON_JULIACALL_MIN_OPTLEVEL=<0|1|2|3>` | Optimization level. |
105+
| `-X juliacall-optimize=<0|1|2|3>` | `PYTHON_JULIACALL_OPTIMIZE=<0|1|2|3>` | Minimum optimization level. |
106+
| `-X juliacall-procs=<N|auto>` | `PYTHON_JULIACALL_PROCS=<N|auto>` | Launch N local worker process. |
107+
| `-X juliacall-sysimage=<file>` | `PYTHON_JULIACALL_SYSIMAGE=<file>` | Use the given system image. |
108+
| `-X juliacall-threads=<N|auto>` | `PYTHON_JULIACALL_THREADS=<N|auto>` | Launch N threads. |
109+
| `-X juliacall-warn-overwrite=<yes|no>` | `PYTHON_JULIACALL_WARN_OVERWRITE=<yes|no>` | Enable or disable method overwrite warnings. |

0 commit comments

Comments
 (0)