2. Installation¶
This section contains installation information for supported platforms.
2.1. macOS¶
The macOS installer places the tools under
/usr/local. Simply double-click the installation package
to install the software.
After installation, files are in
/usr/local/calypsi-!targetLowercase-, where ```` is
the installed version. Each the Calypsi tool chain release creates a new
directory, preventing overwrites of previous installations.
To simplify tool invocation, the installer script adds symbolic links
from /usr/local/bin to the installation directory. Ensure
/usr/local/bin is in your PATH environment variable to
use the most recent installed version of the Calypsi tool chain.
The installer also creates a symbolic link from
/usr/local/lib/calypsi-!targetLowercase to the installation directory,
making it easy to refer to the installation without a version number.
Setting the PATH¶
To set the PATH environment variable on macOS, edit
/etc/paths and add /usr/local/bin.
Uninstalling¶
To uninstall the Calypsi tool chain, run the uninstall script:
$ sudo /usr/local/lib/calypsi-!targetLowercase-/uninstall
This will remove the installation and the links in /usr/local/bin.
2.2. Debian Linux¶
The Debian package (.deb extension) is built and tested on Ubuntu
20.04. Installation on other Debian-based systems may be possible,
but remains untested.
The package can be installed from the command line using:
$ sudo gdebi calypsi-nut-.deb
Note
Download the Debian package to a local file before installation.
gdebi does not fetch packages from a server.
If you do not have gdebi installed already, install it using:
$ sudo apt install gdebi-core
This installs the Calypsi tool chain in
/usr/local/lib/calypsi-!targetLowercase-, where ````
is the installed version number.
To simplify tool invocation, the installer script adds symbolic links
from /usr/local/bin to the installation directory. Ensure
/usr/local/bin is in your PATH to use the latest the Calypsi tool chain.
The installer also creates a symbolic link from
/usr/local/lib/calypsi-!targetLowercase to the installation directory.
This allows referring to the installation without a version number.
It is also possible to install using dpkg in the following way:
$ sudo dpkg -i calypsi-!targetLowercase-.deb
This may fail if package dependencies are missing. The output will advise on necessary steps before retrying installation.
After installing any requested dependencies, retry the sudo dpkg installation command.
Uninstalling¶
To uninstall the Calypsi tool chain, use dpkg with the -r flag:
$ sudo dpkg -r calypsi-!targetLowercase
2.3. Arch and Manjaro Linux¶
Manjaro is based on Arch Linux and uses pacman. Install the package
file from the command line using:
$ sudo pacman -U calypsi-!targetLowercase--x86_64.pkg.tar.zst
Note
Download the package file to your local file system before installation.
pacman -U does not fetch packages from a server.
This installs the Calypsi tool chain in
/usr/local/lib/calypsi-!targetLowercase-, where ````
is the installed version number.
To simplify tool invocation, the installer script adds symbolic links
from /usr/local/bin to the installation directory. Ensure
/usr/local/bin is in your PATH to use the latest the Calypsi tool chain.
The installer also creates a symbolic link from
/usr/local/lib/calypsi-!targetLowercase to the installation directory.
This allows referring to the installation without a version number.
Uninstalling¶
To uninstall the Calypsi tool chain, use pacman with the -R flag:
$ sudo pacman -R calypsi-!targetLowercase
2.4. Windows¶
Extract the Windows product calypsi-!targetLowercase-.zip
to a suitable location. It will expand into a folder
calypsi-!targetLowercase-, allowing easy management of
multiple versions.
Setting the PATH¶
To use the tools, add the bin folder inside the extracted archive to your system’s search path. Search for “path” in the Start menu, then select “Edit the system environment variables - control panel”.
Uninstalling¶
Uninstall by deleting the extracted archive via file explorer or command line.
2.5. Using multiple versions¶
On Linux, upgrading the software removes previous versions. On macOS, previously installed versions remain.
Sometimes it can be useful to have access to multiple versions of the software product. This can be done by copying the entire installation directory hierarchy to another location.
Use such copied installations by locally adjusting your PATH
environment variable or by using an explicit path in the command line.
To remove a copied product, simply delete it. Do not run the
uninstall script, as it will affect the normally installed copy.
Note
The software product is licensed under terms that govern copying and how it can be used.