Skip to content

Commit

Permalink
add docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
aoymt committed Oct 31, 2024
1 parent 3db2a15 commit 7bfd3c9
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/odatse/_initialize.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
import odatse

def initialize():
"""
Initialize for main function by parsing commandline arguments and loading input files
Returns
-------
Tuple(Info, str)
an Info object having parameter values, and a run_mode string
"""
import argparse

parser = argparse.ArgumentParser(
Expand Down
14 changes: 14 additions & 0 deletions src/odatse/algorithm/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@
from ._algorithm import AlgorithmBase

def choose_algorithm(name):
"""
Search for algorithm module by name
Parameters
----------
name : str
name of the algorithm
Returns
-------
module
algorithm module
"""

alg_table = {
"mapper": "mapper_mpi",
"minsearch": "min_search",
Expand Down

0 comments on commit 7bfd3c9

Please sign in to comment.