Wolfram System File Organization
A full Wolfram System installation consists of thousands of separate files, arranged in several hundred directories under the main installation directory. The location of the main installation directory is determined at install time. From within a Wolfram Language kernel, its name is given by the value of $InstallationDirectory.
C:\Program␣Files\Wolfram␣Research\Wolfram\
14.1
| Windows |
/Applications/Wolfram.app/Contents
| macOS |
/usr/local/Wolfram/Wolfram/
14.1
| Linux |
The executable programs that launch the Wolfram System are typically in the main installation directory. Sometimes there may also be links to them, or scripts accessing them, in other locations. From within a Wolfram Language kernel, First[$CommandLine] gives the full name of the executable program corresponding to that kernel.
WolframNB | Wolfram System front end |
WolframKernel |
Wolfram Language kernel, usually with its own text-based interface
|
wolfram | Wolfram Language kernel to be run in a terminal or shell |
wscc | script for preprocessing and compiling WSTP C source files |
The main installation directory has three standard subdirectories that contain material distributed with the Wolfram System. Under normal circumstances, none of the contents of these directories should ever be modified, except, for example, if you choose to edit a shared stylesheet.
AddOns | bundled Wolfram System add-ons |
Documentation | Wolfram Language documentation |
SystemFiles | Wolfram System files |
Particularly on Linux systems, the Wolfram System often has executable files for different computer architectures and systems stored in a single overall directory structure. Each system is in a subdirectory with a name given by $SystemID. Some resource directories may also contain files specific both to particular languages and particular computing environments. These files are given in subdirectories such as Japanese/Windows.
Kernel/Binaries/
| kernel binaries or elements for each computer system |
Kernel/SystemResources/
| system-specific .mx files used by the kernel |
Kernel/TextResources
| message and text files used by the kernel |
FrontEnd/Binaries/
| front end binaries or elements for each computer system |
FrontEnd/SystemResources
| files used by the front end in each window system environment |
FrontEnd/TextResources
| message and text files used by the front end |
FrontEnd/StyleSheets
| default notebook stylesheets |
FrontEnd/Palettes
| default palette notebooks |
Libraries/
| WSTP and other libraries used by the kernel and front end |
Links
| developer kits for WSTP and other connection technologies |
Fonts
|
Wolfram System fonts, often copied to a central directory
|
CharacterEncodings
| specifications of character encodings |
SpellingDictionaries
| spelling dictionaries |
SystemDocumentation/
| Linux man pages and other environment-specific documentation |
Graphics/Binaries/
| PostScript interpreters and graphics programs |
Graphics/SystemResources
| PostScript definitions and other resources for graphics |
Graphics/Packages
| packages for setting up graphics |
Installation
|
various auxiliary programs used in installation, called automatically by the main installer program
|
IncludeFiles
| files for inclusion in other programs |
Java
|
files for the Java Runtime Environment (if needed)
|
Files of information to be displayed by the Wolfram System Help Viewer are installed separately and in a different location on most platforms.
C:\Users\
\AppData\Local\Programs\Common\Wolfram␣Research\Documentation.en-us\
14.1
\Documentation
| Windows |
/Library/Wolfram/Documentation/
14.1
/en-us
| macOS |
/usr/sharel/Wolfram/Documentation/
14.1
| Linux |
System/Guides
| pages that categorize and link to related functions |
System/ReferencePages/Symbols
| reference pages for each of the Wolfram System's built-in objects |
System/ReferencePages/Formats
| reference pages for file formats that the Wolfram System handles |
Packages/
/Guides
, etc.
| documentation for add-on items |
You can customize your Wolfram System by adding files that can be loaded into the system under different circumstances. Such files are conventionally placed in either systemwide or user‐specific base directories.
$BaseDirectory | systemwide base directory for files to be loaded by the Wolfram System |
$UserBaseDirectory | user-specific base directory for files to be loaded by the Wolfram System |
Typical values of $BaseDirectory.
Typical values of $UserBaseDirectory.
You can specify different locations for these directories by setting operating system environment variables when you launch the Wolfram System, as discussed in "Wolfram System Sessions".
Applications | Wolfram Language application packages |
Autoload | packages to be autoloaded on startup |
FrontEnd | front end initialization files |
Kernel | kernel initialization files |
Licensing | license management files |
SystemFiles | general system files |
Some files in base directories serve as configuration files, automatically used by the Wolfram Language kernel or front end.
Kernel/
init.m
| run when the kernel is started |
Kernel/end.m
| run when the kernel is terminated |
FrontEnd/
init.m
| read when the front end is started |
SystemFiles/FrontEnd/StyleSheets/
| customized notebook stylesheets |
SystemFiles/FrontEnd/Palettes/
| additional palettes to appear in the front end menu |
Kernel configuration files can contain any Wolfram Language commands. These commands can test global variables such as $SystemID and $MachineName to determine what operations to perform. Front end configuration files can contain only certain special commands, as described in "Input Syntax".
Applications/
/
| named add-on applications |
Autoload/
/
| add-ons to be loaded automatically when the Wolfram System is started |
With the default setting for the kernel $Path variable, an add‐on can be loaded from within a Wolfram System session simply by using the command <<name`. This will load the init.m file for the add‐on, which should in turn be set up to load other necessary files or packages.
By placing an add‐on under the Autoload subdirectory of $BaseDirectory or $UserBaseDirectory, you can have the Wolfram System automatically load the add‐on whenever you start the kernel or the front end.