document "PACKMOL_GUI" option

m3g · Nov 12, 2024 · 0d4c795 · 0d4c795 · lmiq · Nov 12, 2024
1 parent e614c0f
commit 0d4c795
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -78,6 +78,12 @@ julia> import Pkg; Pkg.activate("Packmol"; shared=true); Pkg.update()
 
 (or type `] activate @Packmol` and then `] up`, at the `julia>` prompt). 
 
+Additionally, it is possible to disable the loading of the file-dialog machinery
+by setting the system environment variable `PACKMOL_GUI="false"`. This might be
+important to run packmol through this interface in computers without a GUI. 
+
+
+
 
 
 
diff --git a/src/packmol_runner.jl b/src/packmol_runner.jl
@@ -14,7 +14,9 @@ pre-compiled binary. The input file is a text file with the same syntax as
 the packmol input files.
 
 If no input file is provided, a file explorer will be opened to choose the 
-input file.
+input file. 
+
+To disable the file explorer, set the environment variable `PACKMOL_GUI="false"`.
 
 """
 function run_packmol end