Skip to content

Commit 77e445e

Browse files
added doc for GALAXY_MEMORY_MB
1 parent 7a65970 commit 77e445e

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

docs/_writing_clusters.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Cluster Usage
22
==============================
33

4-
--------------------------------------------
5-
Developing for Clusters - ``GALAXY_SLOTS``
6-
--------------------------------------------
4+
-----------------------------------------------------------------------------------------------------
5+
Developing for Clusters - ``GALAXY_SLOTS``, ``GALAXY_MEMORY_MB``, and ``GALAXY_MEMORY_MB_PER_SLOT``
6+
-----------------------------------------------------------------------------------------------------
77

88
``GALAXY_SLOTS`` is a special environment variable that is set in a Galaxy
99
tool's runtime environment. If the tool you are working on allows configuring
@@ -30,6 +30,14 @@ For information on how server administrators can configure this value for
3030
a particular tool, check out `the Galaxy wiki
3131
<https://wiki.galaxyproject.org/Admin/Config/GALAXY_SLOTS>`__.
3232

33+
Analogously ``GALAXY_MEMORY_MB`` and ``GALAXY_MEMORY_MB_PER_SLOT`` are special
34+
environment variables in a Galaxy tool's runtime environment that can be used
35+
to specify the amount of memory that a tool can use overall and per slot,
36+
respectively.
37+
38+
For an example see the samtools sort tool (`here https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/samtools/samtools_sort/samtools_sort.xml`__) which allows to specify the
39+
total memory with the -m parameter.
40+
3341
-----------------------------------------------
3442
Test Against Clusters - ``--job_config_file``
3543
-----------------------------------------------

0 commit comments

Comments
 (0)