Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README should not steer new users to overriding submit script template #232

Open
mbmilligan opened this issue Mar 5, 2022 · 0 comments
Open

Comments

@mbmilligan
Copy link
Member

The current example configuration code in the README steers new users in an unhelpful direction:

batchspawner/README.md

Lines 84 to 93 in f465967

c.TorqueSpawner.batch_script = '''#!/bin/sh
#PBS -q {queue}@{host}
#PBS -l walltime={runtime}
#PBS -l nodes=1:ppn={nprocs}
#PBS -l mem={memory}
#PBS -N jupyterhub-singleuser
#PBS -v {keepvars}
module load python3
{cmd}
'''

If copied, this sample overrides the template script provided with the class, losing features that are implemented with template logic. The sample code should be replaced with one that uses the provided configuration variables (req_* etc) in accordance with recommended practice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant