File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1212
1313
1414def parse_args ():
15- """Parses command-line arguments for the script."""
15+ """
16+ Parse command-line arguments for the main processing script.
17+
18+ Returns
19+ -------
20+ argparse.Namespace
21+ The parsed command-line arguments.
22+ """
1623 parser = argparse .ArgumentParser (
1724 description = "Download, process, and combine molecular data from an S3 bucket."
1825 )
@@ -94,6 +101,12 @@ def parse_args():
94101
95102
96103def main ():
104+ """
105+ Main entry point for molecular data processing.
106+
107+ This function coordinates MPI initialization, logging setup, and
108+ data processing across available workers.
109+ """
97110 args = parse_args ()
98111
99112 # Determine rank early for logging setup
Original file line number Diff line number Diff line change 2020except ImportError :
2121 # Fallback for if it's run as a standalone script outside the package
2222 def setup_logging (level = logging .INFO , ** kwargs ):
23+ """
24+ Setup basic logging configuration for standalone execution.
25+
26+ Parameters
27+ ----------
28+ level : int, optional
29+ The logging level to use, by default logging.INFO.
30+ **kwargs : dict
31+ Additional keyword arguments for basicConfig.
32+ """
2333 logging .basicConfig (
2434 level = level , format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
2535 )
@@ -29,6 +39,14 @@ def setup_logging(level=logging.INFO, **kwargs):
2939
3040
3141def parse_args ():
42+ """
43+ Parse command-line arguments for the verification script.
44+
45+ Returns
46+ -------
47+ argparse.Namespace
48+ The parsed command-line arguments.
49+ """
3250 parser = argparse .ArgumentParser (
3351 description = "Verify consistency between a Parquet dataset and its corresponding ExtXYZ file."
3452 )
@@ -54,6 +72,12 @@ def parse_args():
5472
5573
5674def main ():
75+ """
76+ Main entry point for verifying Parquet and ExtXYZ consistency.
77+
78+ This function coordinates the loading of both files, structural alignment,
79+ and property validation.
80+ """
5781 args = parse_args ()
5882 setup_logging ()
5983
You can’t perform that action at this time.
0 commit comments