FireSTARR
Loading...
Searching...
No Matches
run.Run Class Reference
Inheritance diagram for run.Run:
Collaboration diagram for run.Run:

Public Member Functions

None __init__ (self, dir_fires=None, dir=None, max_days=None, do_publish=None, do_merge=None, prepare_only=False, crs=CRS_COMPARISON, verbose=False, no_wait=False)
 
 load_rundata (self)
 
 save_rundata (self)
 
 is_running (self)
 
 check_rasters (self, remove=False)
 
 check_and_publish (self, ignore_incomplete_okay=True, run_incomplete=False, no_publish=None, force_copy=False, force=False, no_wait=True, require_all=False)
 
 process (self)
 
 run_until_successful_or_outdated (self, no_retry=False)
 
 run_until_successful (self, no_retry=False)
 
 save_fires (self, df_fires, save_to)
 
 prep_fires (self, force=False)
 
 load_fires (self)
 
 ran_all (self)
 
 prep_folders (self, remove_existing=False, remove_invalid=False)
 
 prioritize (self, df_fires, df_bounds=None)
 
 do_run_fire (self, dir_fire, prepare_only=False, run_only=False, no_wait=False)
 
 find_unprepared (self, df_fires, remove_directory=False)
 
 check_do_publish (self)
 
 check_do_merge (self)
 
 run_fires_in_dir (self, check_missing=True)
 

Public Attributes

dict _prepare_only = {}
 
list _is_batch = [os.path.join(self._dir_sims, x) for x in itertools.chain.from_iterable(dirs_sim.values())]
 

Protected Attributes

 _verbose = verbose
 
 _max_days = MAX_NUM_DAYS if not max_days else max_days
 
 _do_publish = do_publish
 
 _do_merge = do_merge
 
 _prepare_only = prepare_only
 
 _dir_fires = dir_fires
 
 _no_wait = no_wait
 
 _modelrun = None
 
str _name = get_model_marker(self._dir_sims)
 
str _prefix = "m3"
 
 _start_time = datetime.datetime.now()
 
str _id = self._start_time.strftime(FMT_RUNID)
 
 _dir_runs = ensure_dir(os.path.join(DIR_RUNS, self._name))
 
 _dir_sims = ensure_dir(os.path.join(DIR_SIMS, self._name))
 
 _log
 
 _log_order
 
 _dir_out = ensure_dir(os.path.join(self._dir_runs, "data"))
 
 _dir_model = ensure_dir(os.path.join(self._dir_runs, "model"))
 
 _dir_output = ensure_dir(os.path.join(DIR_OUTPUT, self._name))
 
 _crs = crs
 
 _file_fires = vector_path(self._dir_out, "df_fires_prioritized")
 
 _num_fires_initial = None
 
 _file_rundata = os.path.join(self._dir_out, "run.json")
 
 _origin = Origin(self._start_time)
 
 _simulation = Simulation(self._dir_out, self._dir_sims, self._origin)
 
 _src_fires = SourceFireGroup(self._dir_out, self._dir_fires, self._origin)
 
 _is_batch = assign_sim_batch()
 
bool _published_clean = False
 

Member Data Documentation

◆ _log

run.Run._log
protected
Initial value:
= add_log_file(
os.path.join(self._dir_runs, f"log_{self._name}.log"),
level=DEFAULT_FILE_LOG_LEVEL,
)

◆ _log_order

run.Run._log_order
protected
Initial value:
= add_log_file(
os.path.join(self._dir_runs, f"log_order_{self._name}.log"),
level=DEFAULT_FILE_LOG_LEVEL,
logger=LOGGER_FIRE_ORDER,
)

The documentation for this class was generated from the following file: