Getting Started

1. Before using the hpc-client, you need to decide how it will run on your cluster.
   
   Choose an integration method and keep it in mind for later. This sets how frequently the hpc-client will look for, pull, and queue hpc jobs to your HPC from your Flywheel site.

2. It is strongly recommended that you make a private GitHub repo to track your changes.
   
   This will make the hpc-client much easier to manage.

3. Perform the initial cluster setup. If you are unfamiliar with singularity, it is recommended that you read--at a minimum--SingularityCE's introduction and quick start guides.

4. Create an authorization token so Singularity and Flywheel can work with each other.

5. If your queue type is not in the above table, or is sufficiently different, review the guide for adding a queue type.

6. Collaborate with Flywheel staff to install the Flywheel engine in your HPC repo. They will also configure the hold engine on your Flywheel site to ensure that other engines do not pick up gear jobs that are tagged with "hpc".

7. Complete the integration method you chose in step one.
   
   Confirm the hpc-client is running regularly by monitoring logs/cast.log and the Flywheel user interface.

8. Test and run your first HPC job tests in collaboration with Flywheel. It is recommended that you test with MRIQC (non-BIDS version), a gear that's available from Flywheel's Gear Exchange.
   
   Note: as of 11 May 2022, Flywheel will have to change the rootfs-url (location of where the Docker image resides) for any gears installed from the Gear Exchange. For more about how the hpc-client uses a rootfs-url, see Background/Motivation of this article.

9. Enjoy!