Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Idmtools should have clear document for PlatformAnalysis extra_args #1664

Open
shchen-idmod opened this issue Jan 24, 2022 · 3 comments
Open

Comments

@shchen-idmod
Copy link
Collaborator

shchen-idmod commented Jan 24, 2022

For example in this script:

if __name__ == "__main__":
    platform = Platform('Calculon')
    analysis = PlatformAnalysis(
        platform=platform, experiment_ids=["b0d9ad61-517a-ec11-a9f3-9440c9be2c51"],
        analyzers=[SimTags], #analyzers_args=[{'filenames': ["stderr.txt"],'output_path':'output' }],
        analysis_name="SSMT Analysis Simple 1",
        # You can pass any additional arguments needed to AnalyzerManager through the extra_args parameter
        extra_args=dict(partial_analyze_ok=True)
    )

    analysis.analyze(check_status=True)
    wi = analysis.get_work_item()
    print(wi)

if user want to analyzer with failed sim, they need to pass extra_args like above. But it seems no one know this. We should have document on what can be included in extra_args.

@shchen-idmod
Copy link
Collaborator Author

Josh Suresh is specifically asking this for document. @jgsuresh

@devclinton
Copy link
Member

Reference the examples in the documentation

@devclinton
Copy link
Member

This should just reference the AnalyzerManager arguments for extra args.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants