Skip to main content

A toolkit to make paramsurvey easy to use on clusters and cloud

Project description

paramsurvey-tooling

Install

pip install paramsurvey-tooling

paramsurvey usage on clusters with batch queues

Make 3 batch scripts: head, driver, and child. They all have a similar header:

#FOO batch header lines

. ~/setup-my-software-environment.sh

The script to set up your environment should activate your Conda environment, or load modules or whatever.

Then each of these scripts gets one of the following commands:

  • pstool start head
  • pstool start driver ./my-script.py foo bar baz
  • pstool start child

Finally, submit the head job, then the driver, and finally a bunch of children.

Instead of using a driver batch script, you can also run the driver on a head node:

pstool submit ./my-script.py foo bar baz  # NOT YET WORKING

Containers and paramsurvey

Many compute clusters do not support Docker containers, for security reasons. These clusters often do support Singularity containers, and it's not hard to turn an arbitrary Docker container into a Singularity container. Build the Docker container on a machine that does have docker installed, and then export it to a file:

docker save IMAGE_ID | gzip > my_docker_image.tar.gz

Transfer that file to a host with paramsurvey-tooling and singularity installed, and do:

pstool build my_docker_image.tar.gz

If you find a bug

This tool attempts to support many systems that the author can not directly test. If you find a bug in your environment, run this:

pstool debug > DEBUG

and attach this file DEBUG to your bug report.

Documentation

Installing code in an environment:

  • Conda
  • OS packages
  • modules

Containerized environments:

  • Docker
  • Singularity

Execution environment:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paramsurvey_tooling-0.3.5.tar.gz (12.9 kB view details)

Uploaded Source

File details

Details for the file paramsurvey_tooling-0.3.5.tar.gz.

File metadata

  • Download URL: paramsurvey_tooling-0.3.5.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.10

File hashes

Hashes for paramsurvey_tooling-0.3.5.tar.gz
Algorithm Hash digest
SHA256 f86af8f53dad09cafe161e550051e14e2a033c10c2b81081e8a2aeb73f6aa043
MD5 23799532ab2d429d709deb968748d511
BLAKE2b-256 08bc40844679f5443895cd1c028f5f418e5bb0c026aac39654ce17ebbdca356c

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page