Installation Methods

Using installation script (requires sudo access)

1. Dependencies i. Git

2. Clone the repository

   git clone https://github.com/TurakhiaLab/panman.git
   cd panman
   

3. Run the installation script

   chmod +x install/installationUbuntu.sh
   ./install/installationUbuntu.sh
   

4. Run panmanUtils

   cd build
   ./panmanUtils --help
   

Note

panmanUtils is built using CMake and depends upon libraries such as Boost, cap'n proto, etc, which are also installed in installationUbuntu.sh. If users face version issues, try using the docker methods detailed below.

Using Docker Image

To use panmanUtils in a docker container, users can create a docker container from a docker image, by following these steps

1. Dependencies i. Docker
2. Pull the PanMAN docker image from DockerHub

   docker pull swalia14/panman:latest
   

3. Build and run the docker container

   docker run -it swalia14/panman:latest
   

4. Run panmanUtils

   # Insider docker container
   cd /home/panman/build
   ./panmanUtils --help
   

Note

The docker image comes with preinstalled panmanUtils and other tools such as PanGraph, PGGB, and RIVET.

Using DockerFile

Docker container with preinstalled panmanUtils can also be built from DockerFile by following these steps

1. Dependencies i. Docker ii. Git
2. Clone the repository

   git clone https://github.com/TurakhiaLab/panman.git
   cd panman
   

3. Build a docker image

   cd docker
   docker build -t panman .
   

4. Build and run docker container

   docker run -it panman
   

5. Run panmanUtils

   # Insider docker container
   cd /home/panman/build
   ./panmanUtils --help