README.md

polaris_utils

Polaris submission utilities

For more details and specific examples of how to use polaris_utils, please see our documentation.

Table of Contents

• polaris_utils
  • Table of Contents
  • Installation
    • Install latest version with PyPI
  • Usage
  • Contributing
  • Acknowledgments
  • License

Installation

Install latest version

git clone https://github.com/ramanathanlab/polaris_utils.git
pip3 install -r requirements/requirements.txt
pip3 install .

Installing in develop mode

Recomended to use conda virtual environment

conda create -n [env_name] python=3.9
pip3 install --upgrade pip setuptools wheel
pip3 install -r requirements/dev.txt
pip3 install -r requirements/requirements.txt
pip3 install -e .

Usage

To run an arbitrary command through polaris using this package use the following command:

python -m polaris_utils.submit -a [ACCONT] -q [QUEU_NAME] -t [TIME] -n [NNODES] -j [JOBNAME] --extras "[PRERUN_COMMANDS]" --command "[COMMAND]"

Note: the --extras and --command arguments must be escaped with strings

An example is shown here:

python -m polaris_utils.submit -a [ACCOUNT] -q debug -t 1:00:00 -n 2 -j polaris_utils_ex --extras "module load conda/2022-09-08; conda activate my_env" --command "python -m genslm_develop.train --config /lus/eagle/projects/CVD-Mol-AI/github/genslm-develop/configs/polaris-multi.yaml"

Note: this example is not a valid command, but is meant to show the structure of the command

Contributing

Please report bugs, enhancement requests, or questions through the Issue Tracker.

If you are looking to contribute, please see CONTRIBUTING.md.

Acknowledgments

TODO

License