@@ -8,39 +8,56 @@ configurations or code to fail to run correctly.
88
99## Upcoming Changes
1010
11- This section describes changes that are implemented in current development
12- branch (i.e., the main branch on GitHub), but not yet released in a stable version
13- of ActivitySim. See below under the various version headings for changes in
11+ This section describes changes that are implemented in current development
12+ branch (i.e., the main branch on GitHub), but not yet released in a stable version
13+ of ActivitySim. See below under the various version headings for changes in
1414released versions.
1515
16+ ### CDAP Estimation Mode
17+
18+ A bug has been fixed in the Larch portion of code for the re-estimation of CDAP
19+ parameters. Prior to this fix, interaction terms for 3 and 4 person households
20+ were not being correctly specified in the Larch model. Each of these household
21+ sizes is supposed to have three unique interaction terms, one each for the
22+ entire household adopting the same daily activity pattern (M, N or H). However,
23+ due to a coding error, the same parameter was being used across all three household
24+ sizes. This has now been fixed, and the correct interaction terms are now specified
25+ for each household size. Users who re-estimated CDAP parameters using Larch with
26+ prior versions of ActivitySim may want to review and/or re-estimate any CDAP
27+ parameters to ensure that they are correct. It is not expected that this error
28+ will have a significant impact on simulated travel behavior outcomes, as it is only
29+ a few parameters with a large and complex model, and the overall behavioral
30+ characteristics of 3, 4, and 5-person households are expected to be somewhat
31+ similar to each other in any case.
32+
1633
1734## v1.5.1
1835
19- This release includes a handful of minor updates and fixes, as well as enhancements
20- to the ActivtySim documentation. Users should generally not expect any breaking
21- changes relative to v1.5.0, except that when running a simulation there will be a
36+ This release includes a handful of minor updates and fixes, as well as enhancements
37+ to the ActivtySim documentation. Users should generally not expect any breaking
38+ changes relative to v1.5.0, except that when running a simulation there will be a
2239significant reduction in logging messages displayed on screen and written to the run log.
2340
2441
2542## v1.5
2643
27- This release includes most of the new features and enhancements developed as part
44+ This release includes most of the new features and enhancements developed as part
2845of the Phase 10 work.
2946
3047### Preprocessing & Annotation
3148
32- We have expanded preprocessing & annotation functionality, which is now standardized
33- in formatting and available on most model components. Existing model implementations
34- may need to make minor upgrades to model configuration files to conform with the new
35- standardized formatting.
49+ We have expanded preprocessing & annotation functionality, which is now standardized
50+ in formatting and available on most model components. Existing model implementations
51+ may need to make minor upgrades to model configuration files to conform with the new
52+ standardized formatting.
3653
3754### Estimation Mode
3855
39- Estimation mode has been updated to work with Larch v6. This new version of Larch
40- is modernized and more stable across platforms, and is more consistent with ActivitySim
41- spec files (as both are now built on Sharrow). The overall workflow for re-estimating
42- model parameters is very similar to before, but users will need to use Larch v6 instead
43- of Larch v5. In addition, some new capabilities have been added for modifying model
56+ Estimation mode has been updated to work with Larch v6. This new version of Larch
57+ is modernized and more stable across platforms, and is more consistent with ActivitySim
58+ spec files (as both are now built on Sharrow). The overall workflow for re-estimating
59+ model parameters is very similar to before, but users will need to use Larch v6 instead
60+ of Larch v5. In addition, some new capabilities have been added for modifying model
4461specifications in Larch (instead of re-running ActivitySim).
4562
4663### Using UV for Dependency Management
@@ -52,21 +69,21 @@ for details on how to install ActivitySim using UV.
5269
5370### Skim Naming Conflict Resolution
5471
55- The SkimDataset structure (required when using sharrow, optional in legacy mode)
56- requires every skim variable to have a unique name. It also merges OMX variables
57- based on time period, so that e.g. ` BIKETIME__AM ` and ` BIKETIME__PM ` , which would
58- be 2-d arrays in the OMX file, become just two different parts of a 3-d array
59- called ` BIKETIME ` in the SkimDataset. This is problematic when the skims also
60- contain a 2-d array called ` BIKETIME ` , as that has no temporal dimension, and it
61- gets loaded into a 2-d array in the SkimDataset, with the same name as the 3-d array,
72+ The SkimDataset structure (required when using sharrow, optional in legacy mode)
73+ requires every skim variable to have a unique name. It also merges OMX variables
74+ based on time period, so that e.g. ` BIKETIME__AM ` and ` BIKETIME__PM ` , which would
75+ be 2-d arrays in the OMX file, become just two different parts of a 3-d array
76+ called ` BIKETIME ` in the SkimDataset. This is problematic when the skims also
77+ contain a 2-d array called ` BIKETIME ` , as that has no temporal dimension, and it
78+ gets loaded into a 2-d array in the SkimDataset, with the same name as the 3-d array,
6279and thus one is overwritten and lost.
6380
64- ActivitySim now includes a skims input check to identify this overwriting condition,
65- and raise an error if it is happening, so that the user can correct the condition
66- via (1) the ` omx_ignore_patterns ` setting, (2) revising the skim generation process
67- to not create the overlapping named skims in the file in the first place,
68- or (3) renaming one or both skims if the users actually wants both skims variables
69- in the model. The error message generated includes a link to instructions and
81+ ActivitySim now includes a skims input check to identify this overwriting condition,
82+ and raise an error if it is happening, so that the user can correct the condition
83+ via (1) the ` omx_ignore_patterns ` setting, (2) revising the skim generation process
84+ to not create the overlapping named skims in the file in the first place,
85+ or (3) renaming one or both skims if the users actually wants both skims variables
86+ in the model. The error message generated includes a link to instructions and
7087discussion of these alternatives.
7188
7289### Settings Checker
@@ -93,12 +110,12 @@ See [Expression Profiling](Expression-Profiling) for details.
93110
94111A new telecommute status model component has been added to ActivitySim. This component
95112models the telecommute status of workers, which can be used to determine
96- whether a worker telecommutes full-time, part-time, or not at all. A simple
97- implementation of the telecommute status model can be based on the worker's telecommute
98- frequency. For example, if a worker telecommutes 4 days a week, then there is
99- a 80% probability for them to telecommute on the simulation day. The telecommute
100- status model software can accommodate more complex model forms if needed. An example
101- telecommute status model specification can be found in
113+ whether a worker telecommutes full-time, part-time, or not at all. A simple
114+ implementation of the telecommute status model can be based on the worker's telecommute
115+ frequency. For example, if a worker telecommutes 4 days a week, then there is
116+ a 80% probability for them to telecommute on the simulation day. The telecommute
117+ status model software can accommodate more complex model forms if needed. An example
118+ telecommute status model specification can be found in
102119[ ActivitySim/sandag-abm3-example #30 ] ( https://github.com/ActivitySim/sandag-abm3-example/pull/30 ) .
103120
104121
0 commit comments