Source code for odatse._initialize

# SPDX-License-Identifier: MPL-2.0
#
# ODAT-SE -- an open framework for data analysis
# Copyright (C) 2020- The University of Tokyo
#
# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
# If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

from typing import Optional, Sequence

import odatse



def initialize(argv: Optional[Sequence[str]] = None):
    """
    Initialize for main function by parsing commandline arguments and loading input files

    Parameters
    ----------
    argv : list of str, optional
        Argument list to parse. If None (default), sys.argv[1:] is used.
        Pass an explicit list to avoid modifying sys.argv when embedding
        odatse in a larger script that has its own argument parser.

    Returns
    -------
    Tuple(Info, str)
        an Info object having parameter values, and a run_mode string
    """
    import argparse
    import time

    # Record the start of the "init" phase for time.log. Everything from here
    # up to Algorithm.main() (argument parsing, input loading, solver and
    # algorithm construction) is attributed to "init".
    time_sta = time.perf_counter()

    parser = argparse.ArgumentParser(
        description="Open framework for data analysis"
    )
    parser.add_argument("inputfile", help="input file with TOML format")
    parser.add_argument("--version", action="version", version=odatse.__version__)

    mode_group = parser.add_mutually_exclusive_group()
    mode_group.add_argument("--init", action="store_true", help="initial start (default)")
    mode_group.add_argument("--resume", action="store_true", help="resume interrupted run")
    mode_group.add_argument("--cont", action="store_true", help="continue from previous run")

    parser.add_argument("--reset_rand", action="store_true", default=False, help="new random number series in resume or continue mode")
    
    parser.add_argument("--nalg", type=int, default=None, help="# of processes for search algorithm")
    parser.add_argument("--nsolve", type=int, default=None, help="# of processes for solver")

    args = parser.parse_args(argv)
    odatse.mpi.setup(nalg=args.nalg, nsolve=args.nsolve)


    if args.init is True:
        run_mode = "initial"
    elif args.resume is True:
        run_mode = "resume"
        if args.reset_rand is True:
            run_mode = "resume-resetrand"
    elif args.cont is True:
        run_mode = "continue"
        if args.reset_rand is True:
            run_mode = "continue-resetrand"
    else:
        run_mode = "initial"  # default

    info = odatse.Info.from_file(args.inputfile)
    info._start_time = time_sta

    return info, run_mode