Skip to content

doc: add Windows Terminal profile setup to INSTALL-win #666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xdelaruelle merged 1 commit into from
Aug 3, 2026
+21 −0
Merged

doc: add Windows Terminal profile setup to INSTALL-win #666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .hunspell.en.dic
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ MySoftware
Nagelfar
NetCDF
Neumärker
NoExit
OPTLIST
OSPS
OpenMPI
Expand Down
18 changes: 18 additions & 0 deletions INSTALL-win.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,24 @@ For PowerShell, you may adapt profile script to make ``envmodule`` command
initialized when ``pwsh`` shell starts. See the PowerShell documentation on
how to `customize your shell environment <https://learn.microsoft.com/en-us/powershell/scripting/learn/shell/creating-profiles>`_.

Alternatively, if you use `Windows Terminal`_, a PowerShell or ``pwsh``
profile can be set to initialize Modules on startup without altering the
system-wide ``PATH`` environment variable and without running an install
script. Once the Windows-specific distribution zipball has been unpacked to
a directory of your choice (for instance ``C:\Program Files\Environment
Modules``), open the Windows Terminal settings, select the profile to
adapt and set its *Command line* to::

pwsh.exe -NoExit -Command "& Import-Module 'C:\Program Files\Environment Modules\init\pwsh.ps1'"

Use ``powershell.exe`` instead of ``pwsh.exe`` to rely on the Windows
built-in PowerShell rather than PowerShell Core, and adapt the path passed
to ``Import-Module`` to match where the distribution zipball was unpacked.
The ``envmodule`` command then gets initialized every time this profile
starts.

.. _Windows Terminal: https://learn.microsoft.com/en-us/windows/terminal/

Modules installation is now operational and you can setup your modulefiles. By
default, the ``modulefiles`` directory in installation directory is defined as
a modulepath and contains few modulefile examples::
Expand Down
2 changes: 2 additions & 0 deletions NEWS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ Modules 5.7.0 (not yet released)
* Doc: fix favicon rendering with a black background instead of white on
viewers that ignore transparency, by setting its transparent pixels to a
white matte color instead of black.
* Doc: document Windows Terminal profile setup as an alternative way to
initialize Modules on Windows without an install script. (fix issue #634)


.. _5.6 release notes:
Expand Down
Loading