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

Standardize variable naming conventions for all the ways we refer to invest models #1536

Open
davemfish opened this issue Mar 1, 2024 · 0 comments
Assignees
Labels
on hold There's a reason we're not working on this yet task Something needs to be done workbench For issues relating to the workbench front-end of invest

Comments

@davemfish
Copy link
Contributor

This a task for feature/plugins

Throughout invest & workbench code, we need to refer to model names in various ways:

  1. the module name (i.e. 'natcap.invest.carbon')
  2. an identifier ('carbon')
  3. an even shorter alias for the identifier, for some models ('cbc')
  4. the official title ('Carbon Storage and Sequestration')

If we always use the same variable names when storing these values, it's easier to reason about the code.

@emlys is doing a bunch of this standardization already on the natcap.invest side in #1532 , which will merge into feature/plugins. The variable names used are:

  1. pyname
  2. model_id
  3. model_alias
  4. model_name

The Workbench (starting at payloads in ui_server.py, actually) should adopt these same conventions.

@davemfish davemfish added task Something needs to be done on hold There's a reason we're not working on this yet workbench For issues relating to the workbench front-end of invest labels Mar 1, 2024
@davemfish davemfish self-assigned this Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
on hold There's a reason we're not working on this yet task Something needs to be done workbench For issues relating to the workbench front-end of invest
Projects
None yet
Development

No branches or pull requests

1 participant