202405221215
Status: #idea
Tags: Drishti

File Structure

• Python packaging[^1]
  • Manifest.in
  • setup.py

.github/

• Issue templates
• GitHub Actions for testing on each PR and push
  1. Install Darshan, PyDarshan, Drishti
  2. Run Drishti
     1. --help
     2. --issues with a sample
     3. --code with a sample
     4. How is the Run DXT explorer one different? What do they do?
        1. --verbose
        2. --path
        3. --html
        4. --svg
  3. Upload artifact
     • Why? Where is it uploaded to? What happens to the uploaded artifact?
       • Upload the generated artifacts/reports into GitHub. Stays there for a day.
  • No check for correctness
  • DXT - Traces every single call. Does it impair performance?
    • Drishti had 2 parts
      • DXT explorer and drishti
      • now it is merged
    • DXT calls Drishti to get visualisation. So the explorer does visualisation

drishti/

• reporter.py
  • Essentially main.py
  • Checks the log type and calls appropriate handler
  • Meaning of flow structure's 2nd line?
• __init__.py
  • Is it only to indicate it is a part of a package?

handlers/

• handle_darshan.py
  • handler()
    • init_console() -> All printing happens on the Rich console
    • PyDarshan's experimental features are enabled. What is it used for?
    • A PyDarshan report is generated
    • Each module is processed one by one
    • What do lines TODO

includes/

• parser.py
  • Parses CLI args and sets appropriate variables
• config.py
  • Is this where the user defines configs?
    • Not right now. Not expected rn.
  • Why are each of the thresholds pair<int, bool>? What is the purpose of the bool?
    • Bool is set to true to output the threshold in the report.
  • Why are the thresholds lists and not tuples?
  • Would be nice to see some type annotations for user defined attributes
    • Irrelevant
  • Line 144: We declare codes globally, but only seem to use it locally?
    • Might not need to be global...
  • Line 191: Use KiB in favour of KB?
    • Check if Darshan uses KB or KiB. Match it
  • Use f-strings instead of "".format()?
    • Can use.
  • Meaning of preload in line 278
    • Run before the rest of the program runs

References

1. Python Packaging User Guide