hpcchris/sit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix typos, improve formatting, and update text in documentation

Browse source 
Signed-off-by: Christoph Niethammer <niethammer@hlrs.de>
This commit is contained in:
Christoph Niethammer 2024-03-28 03:39:40 +01:00
parent fd3f68a474
commit 2dd3208723
1 changed files with 34 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
README.md
View file

@ -1,32 +1,34 @@
# Software Installation Tool (SIT) # Software Installation Tool (SIT)
## About ## About
SIT is a simple software installation tool inspired by gentoo's emerge script. SIT is a simple software installation tool inspired by Gentoo's emerge script.
It eases the installation process and helps to prevent errors during the It eases the installation process and helps to prevent errors during the
installation as well as helps with the documentation as it generates a lot of installation. Further sit helps with documenting software installations
log files and installes them together with the softwre package. by generating log files from the installation process, which are installed
along the software package itself.
## Getting started ## Getting started
### Basic usage ### Basic usage
In its current version it can only install a package using a package class file In its current version sit can only install a package using a package class file
including the necessary information including the necessary information.
The package tree resides per default in the directory $SIT_PATH/packages. For The package tree resides per default in the directory `$SIT_PATH/packages`. For
convenience it should look like following convenience it should look like follows:
```shell
$SIT_PATH/packages/CATEGORY/PACKAGE/PACKAGE-VERSION $SIT_PATH/packages/CATEGORY/PACKAGE/PACKAGE-VERSION
```
The global configuration file of SIT is `$SIT_PATH/etc/sit.conf`. It includes
The global configuration file of SIT is $SIT_PATH/etc/sit.conf a variety of default values:
It includes a variety of default values:
* PREFIX_BASE * PREFIX_BASE
* SRC_POOL * SRC_POOL
* SCLASS_DIR * SCLASS_DIR
* DEFAULT_PLATFORM * DEFAULT_PLATFORM
* DEFAULT_COMPILER * DEFAULT_COMPILER
A user specific configuration file $HOME/.sit" can be used to overwrite the A user specific configuration file `$HOME/.sit`" can be used to overwrite the
settings in the global configuration file. settings in the global configuration file.
The installation process is currently controled with the following environment The installation process is currently controled with the following environment
@ -38,9 +40,9 @@ variables:
* PLATFORM * PLATFORM
* HOSTNAME * HOSTNAME
Sit detects currently the build platform using the SITE_PLATFORM_NAME variable. Sit detects currently the build platform using the `SITE_PLATFORM_NAME` variable.
If sit cannot determine the PLATFORM it uses the default platform specified If sit cannot determine the PLATFORM it uses the default platform specified
in sit.conf. in `sit.conf`.
For each platform configuration files are stored unter For each platform configuration files are stored unter
```shell ```shell
$SIT_PATH/etc/platform-configs/$PLATFORM/* $SIT_PATH/etc/platform-configs/$PLATFORM/*
@ -48,18 +50,19 @@ $SIT_PATH/etc/platform-configs/$PLATFORM/*
At the moment only compiler configurations are supported. At the moment only compiler configurations are supported.
To install a package simply call sit with the necessary information provided by To install a package simply call sit with the necessary information provided by
these variables: these variables:
> [VARIABLE_DECLARATIONS] sit PACKAGE ```shell
[VARIABLE_DECLARATIONS] sit PACKAGE
```
e.g. e.g.
```shell
> PREFIX_BASE=/opt COMPILER=gnu COMPILER_VERSION=4.5 sit mpi/openmpi-1.5.1 PREFIX_BASE=/opt COMPILER=gnu COMPILER_VERSION=4.5 sit mpi/openmpi-1.5.1
```
or for a package to be installed with a specific compiler and mpi version or for a package to be installed with a specific compiler and mpi version
```shell
> PREFIX_BASE=/opt COMPILER=gnu COMPILER_VERSION=8.3.0 MPI=openmpi MPI_VERSION=4.0.1 ./sit performance/extrae/extrae-3.6.1 PREFIX_BASE=/opt COMPILER=gnu COMPILER_VERSION=8.3.0 MPI=openmpi MPI_VERSION=4.0.1 ./sit performance/extrae/extrae-3.6.1
```
### Package files ### Package files
@ -68,30 +71,31 @@ proces. The syntax of the package class files is inspired by gentoo's ebuild fil
A sit package file must contain at least the following variables A sit package file must contain at least the following variables
```
A archive (source tarball) A archive (source tarball)
P package (name of extracted source folder) P package (name of extracted source folder)
URL URL
INSTALLER INSTALLER
```
Optional varialbes to control the build process are Optional varialbes to control the build process are
```
CONFIGURE_OPTS options which will be passed to configure CONFIGURE_OPTS options which will be passed to configure
CMAKE_OPTS options which will be passed to cmake CMAKE_OPTS options which will be passed to cmake
MAKEOPTS options which will be passed to make (see sit.conf) MAKEOPTS options which will be passed to make (see sit.conf)
```
During the installation the following directory paths are used During the installation the following directory paths are used
```
WORKDIR working directory to which e.g. sources will be unpacked WORKDIR working directory to which e.g. sources will be unpacked
SRCDIR source directory SRCDIR source directory
BUILDDIR directory in which the package will be build ($WORKDIR/build) BUILDDIR directory in which the package will be build ($WORKDIR/build)
LOGDIR directory storing the temporary logfiles ($WORKDIR) LOGDIR directory storing the temporary logfiles ($WORKDIR)
```
For fine tuning of the installation process the user can overwrite the following For fine tuning of the installation process the user can overwrite the following
functions. If not other mentioned they are executed in $BUILDDIR functions. If not other mentioned they are executed in $BUILDDIR
```
src_unpack extract $SRC_POOL/${A} into $WORKDIR src_unpack extract $SRC_POOL/${A} into $WORKDIR
src_prepare prepare extracted sources src_prepare prepare extracted sources
src_configure configure src_configure configure
@ -99,11 +103,10 @@ src_build make
src_pretest tests to be performed before installation src_pretest tests to be performed before installation
src_install make install src_install make install
src_posttest tests to be done after installation src_posttest tests to be done after installation
```
The following helper functions can be used The following helper functions can be used
```
unpack recognize and extract a compressed tar file unpack recognize and extract a compressed tar file
```