Skip to content

Commit 8878244

Browse files
committed
Updated descriptionof 'external_environment' field in MachineConfig
1 parent ae8a9fe commit 8878244

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/murfey/util/config.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,6 @@ class MachineConfig(BaseModel):
314314
"Murfey will look for the folders under the current visit."
315315
),
316316
)
317-
318317
initial_model_search_directory: str = Field(
319318
default="processing/initial_model", # User-uploaded electron density models
320319
description=(
@@ -345,9 +344,11 @@ class MachineConfig(BaseModel):
345344
external_environment: dict[str, str] = Field(
346345
default={},
347346
description=(
348-
"Dictionary containing full paths to supporting files and executables that "
349-
"are needed to run the executables to be used. These paths will be added "
350-
"to the $PATH environment variable."
347+
"Dictionary containing full paths to folders containing the supporting "
348+
"software needed to run the executables to be used. These paths will be "
349+
"appended to the $PATH environment variable, so if multiple paths are "
350+
"associated with a single executable, they need to be provided as colon-"
351+
"separated strings. E.g. /this/is/one/folder:/this/is/another/one"
351352
),
352353
)
353354
plugin_packages: dict[str, Path] = Field(

0 commit comments

Comments
 (0)