From 3747aefcbe334584fb802c51cdd59c64479be9e7 Mon Sep 17 00:00:00 2001
From: lkugler <lukas.kugler@gmail.com>
Date: Tue, 21 Feb 2023 10:30:32 +0100
Subject: [PATCH] docs
---
dartwrf/utils.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/dartwrf/utils.py b/dartwrf/utils.py
index 726c49b..4da09e3 100755
--- a/dartwrf/utils.py
+++ b/dartwrf/utils.py
@@ -34,6 +34,11 @@ class ClusterConfig(object):
@property
def archivedir(self):
+ """Path to the directory where data for the experiment is stored
+
+ Example:
+ `/users/abcd/data/sim_archive/experiment1/`
+ """
return self.archive_base+'/'+self.exp.expname
@property
@@ -67,7 +72,7 @@ class ClusterConfig(object):
return Shellslurm(*args)
def backup_scripts(self):
- """Copies scripts and configuration to archive dir output folder"""
+ """Copies scripts and configuration to cluster.archivedir folder"""
os.makedirs(self.archivedir, exist_ok=True)
try:
--
GitLab