Quickstart¶
Usage
Development
Release
Hopla!¶
What Is Hopla?¶
Hopla is a lightweight tool for submitting script for computation within different clusters. It basically wraps submission and provide access to logs.
Important Links¶
Official source code repo: https://github.com/AGrigis/hopla
HTML documentation (stable release): http://AGrigis.github.io/hopla/stable
HTML documentation (dev): http://AGrigis.github.io/hopla/dev
Install¶
Latest release¶
1. Setup a virtual environment
We recommend that you install hopla in a virtual Python environment,
either managed with the standard library venv or with conda.
Either way, create and activate a new python environment.
With venv:
python3 -m venv /<path_to_new_env>
source /<path_to_new_env>/bin/activate
Windows users should change the last line to \<path_to_new_env>\Scripts\activate.bat
in order to activate their virtual environment.
With conda:
conda create -n hopla python=3.12
conda activate hopla
2. Install hopla with pip
Execute the following command in the command prompt / terminal in the proper python environment:
python3 -m pip install -U hopla
Check installation¶
Try importing hopla in a python / iPython session:
import hopla
If no error is raised, you have installed hopla correctly.
Dependencies¶
The required dependencies to use the software are listed in the file pyproject.toml.