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

Naming Conventions for Sub-Model Specification Files #320

Open
danielsclint opened this issue May 18, 2020 · 0 comments
Open

Naming Conventions for Sub-Model Specification Files #320

danielsclint opened this issue May 18, 2020 · 0 comments
Labels
Chore Changes don't modify src or test files Usability Changes that improve usability

Comments

@danielsclint
Copy link

danielsclint commented May 18, 2020

At some point, it may be useful to develop and settle on official names for the sub-model specification files types used in ActivitySim. The documentation does a good job laying out the specific files used for each model, but it always feels a bit clunky trying to reference the overarching theme of the model sub-files in emails, documentation, or general conversation.

Coming up with formal file type references (to the extent they do not already exist informally) might also help with formal definitions of what belongs in each file. For example, model constants are allowed in both the model specification (YAML) (bottom of tour mode choice) and the Coefficient Definition Files (CSV) (tour mode choice coefficients). Given the flexible nature of ActivitySim, numerous approaches and permutations will always exist, but documentation of preferred or recommended approaches will improve the ability to discuss and share across the community.

I currently see at least five specific types of model specification files.

  1. Model Specification (YAML) (School Location Example)
  2. Initialize (Orcas) Relationships (YAML) (Initialize Households Example)
  3. Annotation Definitions (CSV) (Annotate Person Example)
  4. Coefficient (Constants) Definitions (CSV) (Tour Mode Choice Example)
  5. ActivitySim Model Descriptions (CSV) (Workplace Location Example) - Numpy Model Defintions

Just a thought from an outside observer, and I may have missed this in the documentation if it exist already. Happy to help if there is an interest in this one though.

Clint

@danielsclint danielsclint added Chore Changes don't modify src or test files Usability Changes that improve usability labels Dec 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Chore Changes don't modify src or test files Usability Changes that improve usability
Projects
None yet
Development

No branches or pull requests

1 participant