Fix archive system

Author: kks32

dapi/client.py

@@ -425,23 +425,32 @@ def submit(
         cores_per_node: Optional[int] = None,
         max_minutes: Optional[int] = None,
         queue: Optional[str] = None,
+        archive_system: Optional[str] = "designsafe",
+        archive_path: Optional[str] = None,
         **kwargs,
     ):
         """Submit a PyLauncher sweep job.
 
         Translates *directory* to a Tapis URI, builds a job request with
         ``call_pylauncher.py`` as the script, and submits it.
 
+        Archives to the user's DesignSafe storage by default (not the
+        app's archive path, which may belong to the app owner).
+
         Args:
             directory: Path to the input directory containing
                 ``runsList.txt`` and ``call_pylauncher.py``
                 (e.g. ``"/MyData/sweep/"``).
-            app_id: Tapis application ID (e.g. ``"openseespy-s3"``).
+            app_id: Tapis application ID (e.g. ``"designsafe-agnostic-app"``).
             allocation: TACC allocation to charge.
             node_count: Number of compute nodes.
             cores_per_node: Cores per node.
             max_minutes: Maximum runtime in minutes.
             queue: Execution queue name.
+            archive_system: Archive system. Defaults to ``"designsafe"``
+                (the user's own storage).
+            archive_path: Archive directory path. If None, uses the
+                default ``tapis-jobs-archive/`` under the user's MyData.
             **kwargs: Additional arguments passed to
                 ``ds.jobs.generate()``.
 
@@ -459,6 +468,8 @@ def submit(
             max_minutes=max_minutes,
             queue=queue,
             allocation=allocation,
+            archive_system=archive_system,
+            archive_path=archive_path,
             **kwargs,
         )
         return jobs_module.submit_job_request(self._tapis, job_request)

docs/examples/pylauncher.md

@@ -59,7 +59,7 @@ ds.jobs.parametric_sweep.generate(
 ```python
 job = ds.jobs.parametric_sweep.submit(
     "/MyData/pylauncher_demo/",
-    app_id="agnostic",
+    app_id="designsafe-agnostic-app",
     allocation="your_allocation",
     node_count=1,
     cores_per_node=48,
@@ -104,7 +104,7 @@ ds.jobs.parametric_sweep.generate(
 
 job = ds.jobs.parametric_sweep.submit(
     "/MyData/opensees_sweep/",
-    app_id="openseespy-s3",
+    app_id="designsafe-agnostic-app",
     allocation="your_allocation",
     node_count=2,
     cores_per_node=48,
@@ -127,5 +127,5 @@ $WORK/sweep_$SLURM_JOB_ID/run_ALPHA_BETA
 ## Notes
 
 - **PyLauncher is NOT a dapi dependency** — it's pre-installed on TACC compute nodes. dapi only generates the input files.
-- **MPI is disabled** — PyLauncher's `ClassicLauncher` runs independent serial tasks. The apps used (`agnostic`, `openseespy-s3`) already have `isMpi: false`.
+- **MPI is disabled** — PyLauncher's `ClassicLauncher` runs independent serial tasks. The `designsafe-agnostic-app` already has `isMpi: false`.
 - **Works with any app** — OpenSees, Python, MATLAB, Fortran binaries. The task list is just shell commands.

docs/jobs.md

@@ -95,12 +95,20 @@ print(f"Default Cores: {app_details.jobAttributes.coresPerNode}")
 
 | Application | App ID | Description |
 |-------------|--------|-------------|
+| Agnostic | `designsafe-agnostic-app` | General-purpose Python/OpenSees/PyLauncher execution |
 | MATLAB | `matlab-r2023a` | MATLAB computational environment |
 | OpenSees | `opensees-express` | Structural analysis framework |
+| OpenSees MP | `opensees-mp-s3` | OpenSees parallel (MPI) analysis |
 | MPM | `mpm-s3` | Material Point Method simulations |
 | ADCIRC | `adcirc-v55` | Coastal circulation modeling |
 | LS-DYNA | `ls-dyna` | Explicit finite element analysis |
 
+The **Agnostic App** (`designsafe-agnostic-app`) is DesignSafe's general-purpose app for running Python scripts, OpenSeesPy, and PyLauncher parameter sweeps on TACC systems. It supports:
+- Python 3.12 with OpenSeesPy pre-installed
+- PyLauncher for running many independent tasks in a single allocation
+- Configurable TACC module loading
+- Serial execution (`isMpi: false`) — ideal for PyLauncher workflows
+
 ## Job Submission
 
 ### Basic Job Submission
@@ -461,7 +469,7 @@ ds.jobs.parametric_sweep.generate(
 # Submit the job
 job = ds.jobs.parametric_sweep.submit(
     "/MyData/sweep_demo/",
-    app_id="agnostic",
+    app_id="designsafe-agnostic-app",
     allocation="your_allocation",
     node_count=1,
     cores_per_node=48,

examples/pylauncher_sweep.ipynb

@@ -3,20 +3,7 @@
   {
    "cell_type": "markdown",
    "metadata": {},
-   "source": [
-    "# PyLauncher Parameter Sweeps with dapi\n",
-    "\n",
-    "This notebook demonstrates how to use dapi's parameter sweep utilities to generate\n",
-    "PyLauncher task lists and submit sweep jobs on DesignSafe.\n",
-    "\n",
-    "**PyLauncher** runs many independent serial tasks within a single SLURM allocation —\n",
-    "ideal for parameter studies, Monte Carlo simulations, and batch processing.\n",
-    "\n",
-    "**What this notebook covers:**\n",
-    "\n",
-    "1. **Generic demo** — a minimal `simulate.py` with `--alpha`/`--beta` parameters\n",
-    "2. **OpenSees demo** — Silvia Mazzoni's cantilever pushover with `--NodalMass`/`--LCol` sweep"
-   ]
+   "source": "# PyLauncher Parameter Sweeps with dapi\n\nThis notebook demonstrates how to use dapi's parameter sweep utilities to generate\nPyLauncher task lists and submit sweep jobs on DesignSafe.\n\n**PyLauncher** runs many independent serial tasks within a single SLURM allocation —\nideal for parameter studies, Monte Carlo simulations, and batch processing.\n\n**What this notebook covers:**\n\n1. **Generic demo** — a minimal `simulate.py` with `--alpha`/`--beta` parameters\n2. **OpenSees demo** — cantilever pushover with `--NodalMass`/`--LCol` sweep"
   },
   {
    "cell_type": "code",
@@ -34,9 +21,14 @@
    "outputs": [],
    "source": [
     "import os\n",
+    "from pathlib import Path\n",
     "from dapi import DSClient\n",
     "\n",
-    "ds = DSClient()"
+    "ds = DSClient()\n",
+    "\n",
+    "# On DesignSafe JupyterHub, ~/MyData is /home/jupyter/MyData.\n",
+    "# Locally, we use a local directory but the Tapis path stays /MyData/...\n",
+    "MYDATA = Path(os.environ.get(\"JUPYTER_SERVER_ROOT\", os.path.expanduser(\"~\"))) / \"MyData\""
    ]
   },
   {
@@ -49,7 +41,6 @@
     "\n",
     "A simple example sweeping over two parameters (`--alpha`, `--beta`). The script\n",
     "computes `result = alpha * beta`, writes it to a JSON output file, and prints a summary.\n",
-    "This pattern works with any app — the commands in `runsList.txt` are just shell commands.\n",
     "\n",
     "### Write the script"
    ]
@@ -60,8 +51,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "input_dir_generic = os.path.expanduser(\"~/MyData/pylauncher_demo/\")\n",
-    "os.makedirs(input_dir_generic, exist_ok=True)\n",
+    "input_dir_generic = MYDATA / \"pylauncher_demo\"\n",
+    "input_dir_generic.mkdir(parents=True, exist_ok=True)\n",
     "\n",
     "simulate_script = '''\\\n",
     "\"\"\"simulate.py — minimal demo script for PyLauncher parameter sweeps.\n",
@@ -91,10 +82,8 @@
     "print(f\"alpha={args.alpha}, beta={args.beta} -> result={result:.4f} written to {outfile}\")\n",
     "'''\n",
     "\n",
-    "with open(os.path.join(input_dir_generic, \"simulate.py\"), \"w\") as f:\n",
-    "    f.write(simulate_script)\n",
-    "\n",
-    "print(f\"Wrote {input_dir_generic}simulate.py\")"
+    "(input_dir_generic / \"simulate.py\").write_text(simulate_script)\n",
+    "print(f\"Wrote {input_dir_generic}/simulate.py\")"
    ]
   },
   {
@@ -152,18 +141,16 @@
     "commands = ds.jobs.parametric_sweep.generate(\n",
     "    \"python3 simulate.py --alpha ALPHA --beta BETA --output out_ALPHA_BETA\",\n",
     "    sweep,\n",
-    "    input_dir_generic,\n",
+    "    str(input_dir_generic),\n",
     "    debug=\"host+job\",\n",
     ")\n",
     "\n",
     "print(f\"Generated {len(commands)} task commands\\n\")\n",
     "print(\"=== runsList.txt ===\")\n",
-    "with open(os.path.join(input_dir_generic, \"runsList.txt\")) as f:\n",
-    "    print(f.read())\n",
+    "print((input_dir_generic / \"runsList.txt\").read_text())\n",
     "\n",
     "print(\"=== call_pylauncher.py ===\")\n",
-    "with open(os.path.join(input_dir_generic, \"call_pylauncher.py\")) as f:\n",
-    "    print(f.read())\n",
+    "print((input_dir_generic / \"call_pylauncher.py\").read_text())\n",
     "\n",
     "print(\"=== Files in input directory ===\")\n",
     "for fn in sorted(os.listdir(input_dir_generic)):\n",
@@ -187,7 +174,7 @@
    "source": [
     "# job = ds.jobs.parametric_sweep.submit(\n",
     "#     \"/MyData/pylauncher_demo/\",\n",
-    "#     app_id=\"agnostic\",\n",
+    "#     app_id=\"designsafe-agnostic-app\",\n",
     "#     allocation=\"your_allocation\",\n",
     "#     node_count=1,\n",
     "#     cores_per_node=48,\n",
@@ -199,131 +186,14 @@
   {
    "cell_type": "markdown",
    "metadata": {},
-   "source": [
-    "---\n",
-    "\n",
-    "## Part 2: OpenSees Cantilever Pushover Sweep\n",
-    "\n",
-    "A real-world example based on Silvia Mazzoni's cantilever pushover analysis.\n",
-    "We sweep over `NodalMass` and `LCol` (column length) to study how these structural\n",
-    "parameters affect the pushover response.\n",
-    "\n",
-    "The cantilever model:\n",
-    "```\n",
-    "   ^Y\n",
-    "   |\n",
-    "   2       __\n",
-    "   |         |\n",
-    "   |         |\n",
-    "   |         |\n",
-    " (1)      LCol\n",
-    "   |         |\n",
-    "   |         |\n",
-    "   |         |\n",
-    " =1=    ----  -------->X\n",
-    "```\n",
-    "\n",
-    "- Node 1: fixed base\n",
-    "- Node 2: free top with `NodalMass`\n",
-    "- Elastic beam-column element\n",
-    "- Gravity load (2000 kip downward) followed by lateral pushover (displacement-controlled)\n",
-    "\n",
-    "### Write the analysis script\n",
-    "\n",
-    "This is the OpenSeesPy cantilever pushover script adapted from\n",
-    "[Silvia Mazzoni's example](https://opensees.berkeley.edu/wiki/index.php/Examples_Manual).\n",
-    "It accepts `--NodalMass`, `--LCol`, and `--outDir` as command-line arguments\n",
-    "so PyLauncher can run each parameter combination independently."
-   ]
+   "source": "---\n\n## Part 2: OpenSees Cantilever Pushover Sweep\n\nA real-world example using a 2D cantilever pushover analysis.\nWe sweep over `NodalMass` and `LCol` (column length) to study how these structural\nparameters affect the pushover response.\n\nThe cantilever model:\n```\n   ^Y\n   |\n   2       __\n   |         |\n   |         |\n   |         |\n (1)      LCol\n   |         |\n   |         |\n   |         |\n =1=    ----  -------->X\n```\n\n- Node 1: fixed base\n- Node 2: free top with `NodalMass`\n- Elastic beam-column element\n- Gravity load (2000 kip downward) followed by lateral pushover (displacement-controlled)\n\n### Write the analysis script\n\nAn OpenSeesPy cantilever pushover script based on the\n[OpenSees Examples Manual](https://opensees.berkeley.edu/wiki/index.php/Examples_Manual).\nIt accepts `--NodalMass`, `--LCol`, and `--outDir` as command-line arguments\nso PyLauncher can run each parameter combination independently."
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "input_dir_opensees = os.path.expanduser(\"~/MyData/opensees_sweep/\")\n",
-    "os.makedirs(input_dir_opensees, exist_ok=True)\n",
-    "\n",
-    "cantilever_script = \"\"\"\\\n",
-    "# Ex1a.Canti2D.Push — OpenSeesPy cantilever pushover\n",
-    "# Adapted from Silvia Mazzoni & Frank McKenna, 2006/2020\n",
-    "# Units: kip, inch, second\n",
-    "#\n",
-    "# Command-line arguments (set by PyLauncher per task):\n",
-    "#   --NodalMass  mass at free node\n",
-    "#   --LCol       column length\n",
-    "#   --outDir     output directory for this run\n",
-    "\n",
-    "import argparse\n",
-    "import os\n",
-    "\n",
-    "if os.path.exists(\"opensees.so\"):\n",
-    "    import opensees as ops\n",
-    "else:\n",
-    "    import openseespy.opensees as ops\n",
-    "\n",
-    "parser = argparse.ArgumentParser()\n",
-    "parser.add_argument(\"--NodalMass\", type=float, required=True)\n",
-    "parser.add_argument(\"--LCol\", type=float, required=True)\n",
-    "parser.add_argument(\"--outDir\", type=str, required=True)\n",
-    "args = parser.parse_args()\n",
-    "\n",
-    "NodalMass = args.NodalMass\n",
-    "LCol = args.LCol\n",
-    "outDir = args.outDir\n",
-    "\n",
-    "os.makedirs(outDir, exist_ok=True)\n",
-    "print(f\"Running: NodalMass={NodalMass}, LCol={LCol}, outDir={outDir}\")\n",
-    "\n",
-    "ops.wipe()\n",
-    "ops.model(\"basic\", \"-ndm\", 2, \"-ndf\", 3)\n",
-    "\n",
-    "# Geometry\n",
-    "ops.node(1, 0, 0)\n",
-    "ops.node(2, 0, LCol)\n",
-    "ops.fix(1, 1, 1, 1)\n",
-    "ops.mass(2, NodalMass, 0.0, 0.0)\n",
-    "\n",
-    "# Element\n",
-    "ops.geomTransf(\"Linear\", 1)\n",
-    "ops.element(\"elasticBeamColumn\", 1, 1, 2, 3600000000, 4227, 1080000, 1)\n",
-    "\n",
-    "# Recorders\n",
-    "ops.recorder(\"Node\", \"-file\", f\"{outDir}/DFree.out\", \"-time\", \"-node\", 2, \"-dof\", 1, 2, 3, \"disp\")\n",
-    "ops.recorder(\"Node\", \"-file\", f\"{outDir}/RBase.out\", \"-time\", \"-node\", 1, \"-dof\", 1, 2, 3, \"reaction\")\n",
-    "ops.recorder(\"Element\", \"-file\", f\"{outDir}/FCol.out\", \"-time\", \"-ele\", 1, \"globalForce\")\n",
-    "\n",
-    "# Gravity analysis\n",
-    "ops.timeSeries(\"Linear\", 1)\n",
-    "ops.pattern(\"Plain\", 1, 1)\n",
-    "ops.load(2, 0.0, -2000.0, 0.0)\n",
-    "ops.wipeAnalysis()\n",
-    "ops.constraints(\"Plain\")\n",
-    "ops.numberer(\"Plain\")\n",
-    "ops.system(\"BandGeneral\")\n",
-    "ops.test(\"NormDispIncr\", 1.0e-8, 6)\n",
-    "ops.algorithm(\"Newton\")\n",
-    "ops.integrator(\"LoadControl\", 0.1)\n",
-    "ops.analysis(\"Static\")\n",
-    "ops.analyze(10)\n",
-    "ops.loadConst(\"-time\", 0.0)\n",
-    "\n",
-    "# Pushover analysis\n",
-    "ops.timeSeries(\"Linear\", 2)\n",
-    "ops.pattern(\"Plain\", 2, 2)\n",
-    "ops.load(2, 2000.0, 0.0, 0.0)\n",
-    "ops.integrator(\"DisplacementControl\", 2, 1, 0.1)\n",
-    "ops.analyze(1000)\n",
-    "\n",
-    "print(f\"Done: NodalMass={NodalMass}, LCol={LCol}\")\n",
-    "\"\"\"\n",
-    "\n",
-    "with open(os.path.join(input_dir_opensees, \"cantilever.py\"), \"w\") as f:\n",
-    "    f.write(cantilever_script)\n",
-    "\n",
-    "print(f\"Wrote {input_dir_opensees}cantilever.py\")"
-   ]
+   "source": "input_dir_opensees = MYDATA / \"opensees_sweep\"\ninput_dir_opensees.mkdir(parents=True, exist_ok=True)\n\ncantilever_script = '''\\\n# Ex1a.Canti2D.Push — OpenSeesPy cantilever pushover\n# Based on the OpenSees Examples Manual\n# Units: kip, inch, second\n#\n# Command-line arguments (set by PyLauncher per task):\n#   --NodalMass  mass at free node\n#   --LCol       column length\n#   --outDir     output directory for this run\n\nimport argparse\nimport os\n\nif os.path.exists(\"opensees.so\"):\n    import opensees as ops\nelse:\n    import openseespy.opensees as ops\n\nparser = argparse.ArgumentParser()\nparser.add_argument(\"--NodalMass\", type=float, required=True)\nparser.add_argument(\"--LCol\", type=float, required=True)\nparser.add_argument(\"--outDir\", type=str, required=True)\nargs = parser.parse_args()\n\nNodalMass = args.NodalMass\nLCol = args.LCol\noutDir = args.outDir\n\nos.makedirs(outDir, exist_ok=True)\nprint(f\"Running: NodalMass={NodalMass}, LCol={LCol}, outDir={outDir}\")\n\nops.wipe()\nops.model(\"basic\", \"-ndm\", 2, \"-ndf\", 3)\n\n# Geometry\nops.node(1, 0, 0)\nops.node(2, 0, LCol)\nops.fix(1, 1, 1, 1)\nops.mass(2, NodalMass, 0.0, 0.0)\n\n# Element\nops.geomTransf(\"Linear\", 1)\nops.element(\"elasticBeamColumn\", 1, 1, 2, 3600000000, 4227, 1080000, 1)\n\n# Recorders\nops.recorder(\"Node\", \"-file\", f\"{outDir}/DFree.out\", \"-time\", \"-node\", 2, \"-dof\", 1, 2, 3, \"disp\")\nops.recorder(\"Node\", \"-file\", f\"{outDir}/RBase.out\", \"-time\", \"-node\", 1, \"-dof\", 1, 2, 3, \"reaction\")\nops.recorder(\"Element\", \"-file\", f\"{outDir}/FCol.out\", \"-time\", \"-ele\", 1, \"globalForce\")\n\n# Gravity analysis\nops.timeSeries(\"Linear\", 1)\nops.pattern(\"Plain\", 1, 1)\nops.load(2, 0.0, -2000.0, 0.0)\nops.wipeAnalysis()\nops.constraints(\"Plain\")\nops.numberer(\"Plain\")\nops.system(\"BandGeneral\")\nops.test(\"NormDispIncr\", 1.0e-8, 6)\nops.algorithm(\"Newton\")\nops.integrator(\"LoadControl\", 0.1)\nops.analysis(\"Static\")\nops.analyze(10)\nops.loadConst(\"-time\", 0.0)\n\n# Pushover analysis\nops.timeSeries(\"Linear\", 2)\nops.pattern(\"Plain\", 2, 2)\nops.load(2, 2000.0, 0.0, 0.0)\nops.integrator(\"DisplacementControl\", 2, 1, 0.1)\nops.analyze(1000)\n\nprint(f\"Done: NodalMass={NodalMass}, LCol={LCol}\")\n'''\n\n(input_dir_opensees / \"cantilever.py\").write_text(cantilever_script)\nprint(f\"Wrote {input_dir_opensees}/cantilever.py\")"
   },
   {
    "cell_type": "markdown",
@@ -382,17 +252,15 @@
     "commands = ds.jobs.parametric_sweep.generate(\n",
     "    \"python3 cantilever.py --NodalMass NODAL_MASS --LCol LCOL --outDir out_NODAL_MASS_LCOL\",\n",
     "    sweep_opensees,\n",
-    "    input_dir_opensees,\n",
+    "    str(input_dir_opensees),\n",
     ")\n",
     "\n",
     "print(f\"Generated {len(commands)} task commands\\n\")\n",
     "print(\"=== runsList.txt ===\")\n",
-    "with open(os.path.join(input_dir_opensees, \"runsList.txt\")) as f:\n",
-    "    print(f.read())\n",
+    "print((input_dir_opensees / \"runsList.txt\").read_text())\n",
     "\n",
     "print(\"=== call_pylauncher.py ===\")\n",
-    "with open(os.path.join(input_dir_opensees, \"call_pylauncher.py\")) as f:\n",
-    "    print(f.read())\n",
+    "print((input_dir_opensees / \"call_pylauncher.py\").read_text())\n",
     "\n",
     "print(\"=== Files in input directory ===\")\n",
     "for fn in sorted(os.listdir(input_dir_opensees)):\n",
@@ -416,7 +284,7 @@
    "source": [
     "# job = ds.jobs.parametric_sweep.submit(\n",
     "#     \"/MyData/opensees_sweep/\",\n",
-    "#     app_id=\"openseespy-s3\",\n",
+    "#     app_id=\"designsafe-agnostic-app\",\n",
     "#     allocation=\"your_allocation\",\n",
     "#     node_count=1,\n",
     "#     cores_per_node=48,\n",
@@ -439,4 +307,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}