From 798b41ecd45e34ffb797e3a577414f0083509616 Mon Sep 17 00:00:00 2001 From: matt smith Date: Tue, 7 Jan 2025 20:29:32 -0500 Subject: [PATCH] removed 1_ and 0_ from into and getting started files --- astro.config.mjs | 4 ++-- src/content/docs/blogs/nmm_template.mdx | 4 ++-- src/content/docs/blogs/simple_notifications.mdx | 2 +- .../guides/{1_getting_started.mdx => getting_started.mdx} | 0 src/content/docs/guides/{0_intro.mdx => intro.mdx} | 2 +- src/content/docs/guides/simple_template_file.mdx | 2 +- src/content/docs/guides/submit_slurm_job.mdx | 4 ++-- src/content/docs/index.mdx | 2 +- src/content/docs/reference/submit_slurm_job_reference.mdx | 6 +++--- 9 files changed, 13 insertions(+), 13 deletions(-) rename src/content/docs/guides/{1_getting_started.mdx => getting_started.mdx} (100%) rename src/content/docs/guides/{0_intro.mdx => intro.mdx} (90%) diff --git a/astro.config.mjs b/astro.config.mjs index e3c2ebc..2733266 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -20,8 +20,8 @@ export default defineConfig({ label: 'User Guide', // introduce slurmtools and describe what it does items: [ - { label: 'Introduction', slug: 'guides/0_intro'}, - { label: 'Getting started', slug: 'guides/1_getting_started' }, + { label: 'Introduction', slug: 'guides/intro'}, + { label: 'Getting started', slug: 'guides/getting_started' }, // introduce submit functionality and how the tutorials work together { label: 'Submitting a job', diff --git a/src/content/docs/blogs/nmm_template.mdx b/src/content/docs/blogs/nmm_template.mdx index b19c3bf..2c28fa1 100644 --- a/src/content/docs/blogs/nmm_template.mdx +++ b/src/content/docs/blogs/nmm_template.mdx @@ -14,13 +14,13 @@ This guide describes how to create a template file that uses [`nmm`](https://git ## nmm template file -Below is a simple template file that can be used to submit NONMEM jobs to slurm with [`nmm`](https://github.com/a2-ai/nonmem-monitor). +Below is a simple template file that can be used to submit NONMEM jobs to slurm with [`nmm`](https://github.com/a2-ai/nonmem-monitor). import tmpl from '/src/code/nmm-template.tmpl?raw'; -The template file uses the [whisker package](https://github.com/edwindj/whisker?tab=readme-ov-file) to fill in variables according to the [Mustache templating standard](https://mustache.github.io). When `submit_slurm_job` is called, it reads the template file and injects both the [default values provided to the template](/reference/values_provided_to_template) and any values passed in via the [`slurm_template_opts` argument](/reference/submit_slurm_job_reference#using-the-slurm_template_opts-argument). Variables in the template file are denoted with double curly brackets, such as `{{ injected_variable }}`, and these placeholders are replaced with the respective values when submit_slurm_job runs. +The template file uses the [whisker package](https://github.com/edwindj/whisker?tab=readme-ov-file) to fill in variables according to the [Mustache templating standard](https://mustache.github.io). When `submit_slurm_job` is called, it reads the template file and injects both the [default values provided to the template](/reference/values_provided_to_template) and any values passed in via the [`slurm_template_opts` argument](/reference/submit_slurm_job_reference#using-the-slurm_template_opts-argument). Variables in the template file are denoted with double curly brackets, such as `{{ injected_variable }}`, and these placeholders are replaced with the respective values when submit_slurm_job runs. ### Using the `bbi_config_path` argument -If you are using [`bbi`](https://github.com/metrumresearchgroup/bbi) to submit nonmem jobs this specifies the path to the bbi config file `bbi.yaml`. By default, `submit_slurm_job` uses the `slurmtools` option `options('slurmtools.bbi_config_path)` (see the [Getting Started Guide](/slurmtools-docs/guides/1_getting_started) if you are unfamiliar with this option). If you would like to use a different configuration for `bbi` you can specify the path to a new config file and use that. +If you are using [`bbi`](https://github.com/metrumresearchgroup/bbi) to submit nonmem jobs this specifies the path to the bbi config file `bbi.yaml`. By default, `submit_slurm_job` uses the `slurmtools` option `options('slurmtools.bbi_config_path)` (see the [Getting Started Guide](/slurmtools-docs/guides/getting_started) if you are unfamiliar with this option). If you would like to use a different configuration for `bbi` you can specify the path to a new config file and use that. import submit_code_bbi from '/src/code/submit_bbi.R?raw';