upxo.surrModelOps.SModelJobs module

Batch 2D MCGS runs with LFI export for surrogate / ML training data.

Class mcgs2d_Surrogate repeatedly calls mcgs → simulate → detect_grains and saves each time-slice label field via ArrExp2d. Folder layouts: per-simulation or per-temporal-slice. Does not fit or persist a surrogate model — export only.

class upxo.surrModelOps.SModelJobs.mcgs2d_Surrogate(input_dashboard: str)

Bases: object

Batch 2D MCGS runs that export LFI arrays for surrogate / ML training.

Repeatedly runs mcgs → simulate → detect_grains and writes each temporal-slice label field via ArrExp2d. Folder layouts: one directory per simulation or per temporal slice. Does not fit or persist a surrogate model — data export only.

Workflow

1. job = mcgs2d_Surrogate(input_dashboard='...xls')

2. job.set_NumberOfSimulations(N)

3. job.set_export_parameters(basePath, baseFilename, fileType, ...)

4. job.makeImages(TemporalOrSimFolders='temporal'|'sim')

input_dashboard

Path to the Excel MCGS dashboard.

Type:

str

dim

Fixed to 2 for this job class.

Type:

int

Nsim

Number of independent MC runs.

Type:

int

basePath, baseFilename, fileType, fileNamePadLength

Export location and naming.

currentExportDirs

Directories created during the last export pass.

Type:

dict

input_dashboard

dim

currentExportDirs

set_NumberOfSimulations(Nsim: int)

Set or update NumberOfSimulations.

set_export_parameters(basePath: str, baseFilename: str, fileType: str, fileNamePadLength: int = 4)

Set or update export parameters.

makeImages(TemporalOrSimFolders='temporal', compression=False, fileLevelCompression=False)

Makeimages.

saveInSimulationFolders(simCount, UPXO_PXTAL, fileLevelCompression=False)

Saveinsimulationfolders.

saveInTemporalFolders(simCount, UPXO_PXTAL, fileLevelCompression=False)

Saveintemporalfolders.

Nsim

basePath

baseFilename

fileType

tslices

fileNamePadLength