Skip to content

Commit

Permalink
removed singularity and docker container README and integrated to doc…
Browse files Browse the repository at this point in the history
…umentation
  • Loading branch information
Haaaaron committed Jun 7, 2023
1 parent 685e50b commit c1a4d92
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 76 deletions.
20 changes: 1 addition & 19 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
# Docker image for HILA

Create docker image:

docker build -t hila -f Dockerfile .

Launch image interactively with docker compose

docker compose run --rm hila-applications

## Developing with docker

The applications folder is automatically mounted from the local host to the docker image when launching the service hila-applications

../applications:/HILA/applications

This allows one to develop HILA applications directly from source and launch them in the docker image with ease.

When developing hila libraries and hilapp one can also launch the service hila-source which mounts the HILA/libraries and HILA/hilapp/src folders to the container

docker compose run --rm hila-source
See instructions on usage of docker container in [web documentation](https://cft-hy.github.io/HILA/#containers)
2 changes: 1 addition & 1 deletion docs/config
Original file line number Diff line number Diff line change
Expand Up @@ -864,7 +864,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ./docs/guide/ ./docs/images/workflowV1.png ./applications ./libraries ./singularity ./docker
INPUT = ./docs/guide/ ./docs/images/workflowV1.png ./applications ./libraries
USE_MDFILE_AS_MAINPAGE = ./docs/guide/README.md

# This tag can be used to specify the character encoding of the source files
Expand Down
57 changes: 1 addition & 56 deletions singularity/README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,3 @@
# Singularity container for HILA pre-processor

Definition file for HILA pre-processor [singularity](https://sylabs.io/singularity/) container. This container is meant to be a portable solution for compiling the first half of HILA code which is the parsing for specific architectures.

Singularity is a tailor made containerizing software often supported by HPC platforms such as CSC supercomputers.

One can download the singularity container hilapp.sif directly from this github repositories release page or build it from scratch. If downloaded skip directly to **Using singulartiy container** section:

```
wget https://github.com/CFT-HY/HILA/releases/download/0.0.1/hilapp.sif
```

## Building container from scratch ##

### 1. Installing singularity ###

Install singularity either from source of via any given package manager which is supported. Documentation can be found on the [GitHub page](https://github.com/sylabs/singularity)

You can simply download latest .deb or .rpm from github [release page](https://github.com/sylabs/singularity/releases) and install directly with package manager

Ubuntu:
```
dpkg -i singularity-ce_$(SINGULARITY_VERSION)-$(UBUNTU_VERSION)_amd64.deb
```

### 2. Building singularity container ###

Note: sudo privileges are necessary for building singularity containers

For building the container we have two options. One can either build the container using the release version of hilapp from github or one can build using the local hilapp source. Especially in the situation that one is developing the hila preprocessor and would like to test it on a HPC platform then building the singularity container from a local source is the preferred option. There are two different singularity definition files for both cases.

Building using release version:
```
sudo singularity build hilapp.sif hilapp_git.def
```

Building using local source
```
sudo singularity build hilapp.sif hilapp_local.def
```


## Using singulartiy container ##

The hilapp.sif file will act as a singularity container and equivalently as the hilapp binary and can be used as such when pre processing HILA code. Thus you can move it to your HILA projects bin folder

```
mkdir HILA/hilapp/bin
mv hilapp.sif HILA/hilapp/bin/hilapp
```

Now one can simply move the singularity container to any give supercomputer.

One needs to cre

Note that on supercomputers the default paths aren't the same as on default linux operating systems. Thus one will need to mount their HILA source folder to singularity using the APPTAINER_BIND environment variable. Simple navigate to the base of your HILA source directory and run

export APPTAINER_BIND=$(pwd)
See instructions on usage of singularity container in [web documentation](https://cft-hy.github.io/HILA/#containers)

0 comments on commit c1a4d92

Please sign in to comment.