PelicanHPC Files

=====================
PelicanHPC 5.1 README
=====================

Licence and contact
===================
This copyright and licence applies to all material in this directory except
for a few pieces of software which have specific copyright and licence
information provided with them.

Copyright 2007, 2008, 2009, 2010, 2011, 2014 Michael Creel <michael.creel@uab.es>
Copyright 2014 2015 2016 Aissam Hidoussi <hidoussiaissam@gmail.com>
Copyright 2010, 2024 Robert G. Petry <robert.petry@uregina.ca>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
set this to the network you'd like to use for the cluster

Full documentation
==================

make_pelican-v*: this script allows you to make a custom version
of the PelicanHPC live CD/USB image for creation of high performance
computing clusters.

This version is built on Debian 12 (Bookworm).

Setup
=====

Requirements
------------

You need to install live-build, debootstrap, and rsync to use
it. These packages are installed on PelicanHPC released images, so you can use
this script on PelicanHPC. It can be used on any other GNU/Linux distro as long
as these packages are installed.

Download the source
-------------------

You can download the archive which contains the source code at the following adress :
    * on the repository https://sourceforge.net/projects/pelicanhpc

You can download the iso at the following adress :

    * on the repository https://sourceforge.net/projects/pelicanhpc
    
ISO generation procedure
------------------------

There is not automated setup procedure. You have to do the following :

1. Download the package make_pelican-v*.tar.bz2 (see above) into some ``**PATH**`` and extract it with
tar xjf make_pelican-v*.tar.bz2
This will provide
make_pelican-v* (the compile script)
make_pelican (directory of components used in the compile)
pelicanhome.tar.gz (examples, etc. used to construct the user home directory.)
README (this file)

2. Assume you have extracted them into **PATH**/ . Run the commands:

        cd **PATH**/
        sudo ./make_pelican-v*

Don't forgot to to replace **PATH** with your path, and
make_pelican-v* with the correct version.

Further details on how to customize your build are given within the
make_pelican-v* script, scripts within the make_pelican directory, and
the README within the pelicanhome directory.