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

Modify external function interface to pass ADF object #66

Closed
nusbaume opened this issue Nov 17, 2021 · 1 comment · Fixed by #76
Closed

Modify external function interface to pass ADF object #66

nusbaume opened this issue Nov 17, 2021 · 1 comment · Fixed by #76
Assignees
Labels
code clean-up Made code simpler and/or easier to read. enhancement New feature or request

Comments

@nusbaume
Copy link
Collaborator

Currently in the ADF a set of specific variables is passed to each external script. However, this makes certain parts of the internal ADF code quite complex, and makes the python ADF/script interface overly rigid and potentially difficult to work with.

To alleviate this, it might be better to pass either the main ADF object itself, or another script-specific object, into each external script. This would make the ADF/script interface simple and common to essentially all scripts, give the scripts access to every variable that the ADF holds (that isn't private), and would make the ADF lib code itself a lot cleaner. The downside is that a script developer would need to learn how to use this object, but with good documentation that learning effort will hopefully be minimal.

For the discussion that helped initiate this issue, please see: #65

@nusbaume nusbaume added enhancement New feature or request code clean-up Made code simpler and/or easier to read. labels Nov 17, 2021
@nusbaume nusbaume self-assigned this Nov 17, 2021
@andrewgettelman
Copy link
Collaborator

Thanks @nusbaume . I support this idea, but want to make sure the object is easy to use by the developers. So maybe we need an example of how it might be used by a plotting routine. It doesn't have to be implemented to do this, but how would I write a simple plot routine to use the data? Maybe a short session for those interested would be useful. I'm happy to help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code clean-up Made code simpler and/or easier to read. enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants