Aviti manifest upload

VERSIONLOG.md

@@ -1,5 +1,9 @@
 # Scilifelab_epps Version Log
 
+## 20251007.1
+
+Add EPP to upload AVITI manifests to ngi-nas-ns that have been manually uploaded to LIMS.
+
 ## 20250919.1
 
 Remove unused scripts and associated modules.

scripts/upload_manifest.py

@@ -0,0 +1,135 @@
+#!/usr/bin/env python
+
+import logging
+import os
+import shutil
+from argparse import ArgumentParser, Namespace
+from datetime import datetime as dt
+from zipfile import ZipFile
+
+from genologics.config import BASEURI, PASSWORD, USERNAME
+from genologics.entities import Process
+from genologics.lims import Lims
+
+from scilifelab_epps.wrapper import epp_decorator
+
+TIMESTAMP = dt.now().strftime("%y%m%d_%H%M%S")
+
+
+def get_flowcell_id(process: Process) -> str:
+    """Get the Element flowcell ID from the process."""
+    flowcell_ids = [
+        op.container.name for op in process.all_outputs() if op.type == "Analyte"
+    ]
+
+    assert len(set(flowcell_ids)) == 1, "Expected one flowcell ID."
+    flowcell_id = flowcell_ids[0]
+
+    if "-" in flowcell_id:
+        logging.warning(
+            f"Container name {flowcell_id} contains a dash, did you forget to set the name of the LIMS container to the flowcell ID?"
+        )
+
+    return flowcell_id
+
+
+@epp_decorator(script_path=__file__, timestamp=TIMESTAMP)
+def main(args: Namespace):
+    """takes a uploaded manifest from the LIMS process, zips the file and puts the re-named zip file on ngi-nas-ns"""
+    lims = Lims(BASEURI, USERNAME, PASSWORD)
+    process = Process(lims, id=args.pid)
+
+    # identify the correct file slot to take the manually uploaded manifest from
+    matching_file_slots = [
+        art
+        for art in process.all_outputs()
+        if art.name == args.file and art.type == "ResultFile"
+    ]
+    assert len(matching_file_slots) == 1, (
+        f"Could not find single file slot matching to '{args.file}'."
+    )
+
+    matching_file_slot = matching_file_slots[0]
+    assert matching_file_slot.files, f"'{matching_file_slot.name}' file slot is empty."
+
+    # identify original file name and content
+    manifest_file_name = matching_file_slot.files[0].original_location
+    file_id = matching_file_slot.files[0].id
+    manifest_file_contents = lims.get_file_contents(id=file_id)
+    manifest_file_contents_list = manifest_file_contents.split("\n")
+
+    # add information of old filename to manifest
+    for keyname_index, line in enumerate(manifest_file_contents_list):
+        if "KeyName" in line and "Value" in line:
+            break
+    manifest_file_contents_list.insert(
+        keyname_index + 1, f"copy from original file,{manifest_file_name}"
+    )
+    manifest_file_contents_altered = "\n".join(manifest_file_contents_list)
+
+    flowcell_id = get_flowcell_id(process)
+
+    # check whether we are in an AVITI LIMS step
+    if "AVITI" in process.type.name.upper():
+        samplesheet_type = "Aviti"
+        # samplesheet_type needs to be spelled exactly like the sequencer directories in ngi-nas-ns
+    else:
+        # TODO: implement for other sequencers
+        raise AssertionError(
+            "LIMS step is not part of the  Aviti protocol. This is not implemented for other protocols (yet)"
+        )
+
+    # generate new file names
+    new_root_manifest_file_name = f"AVITI_run_manifest_{flowcell_id}_{process.id}_{TIMESTAMP}_{process.technician.name.replace(' ', '')}"
+    new_manifest_csv_file_name = f"{new_root_manifest_file_name}.csv"
+    new_manifest_zip_file_name = f"{new_root_manifest_file_name}.zip"
+
+    # Write and zip manifest(s)
+    with ZipFile(new_manifest_zip_file_name, "w") as zip_stream:
+        zip_stream.writestr(new_manifest_csv_file_name, manifest_file_contents_altered)
+    logging.info(
+        f".csv file '{manifest_file_name}' has been saved as .zip file '{new_manifest_zip_file_name}'"
+    )
+
+    # Move manifest(s)
+    logging.info("Moving run manifest to ngi-nas-ns...")
+    try:
+        dst = f"/srv/ngi-nas-ns/samplesheets/{samplesheet_type}/{dt.now().year}"
+        if not os.path.exists(dst):
+            logging.info(f"Happy new year! Creating {dst}")
+            os.mkdir(dst)
+        shutil.copyfile(
+            new_manifest_zip_file_name,
+            f"{dst}/{new_manifest_zip_file_name}",
+        )
+        os.remove(new_manifest_zip_file_name)
+    except:
+        logging.error("Failed to move run manifest to ngi-nas-ns.", exc_info=True)
+    else:
+        logging.info("Run manifest moved to ngi-nas-ns.")
+
+
+if __name__ == "__main__":
+    # Parse args
+    parser = ArgumentParser()
+    parser.add_argument(
+        "--pid",
+        required=True,
+        type=str,
+        help="Lims ID for current Process.",
+    )
+    parser.add_argument(
+        "--log",
+        required=True,
+        type=str,
+        help="Which file slot to use for the script log.",
+    )
+    parser.add_argument(
+        "--file",
+        required=True,
+        type=str,
+        help="Which file slot to take the run manifest from.",
+    )
+    args = parser.parse_args()
+
+    main(args)