Changelog#

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v0.3.0 - 2023-09-27#

readme CI badge (#248)
plan cropping as per issue #241 (#240).
(#239).
TourPlanner prevents sampling of duplicate destinations, and prevents origin being sampled as a destination (#231).
as per issue #221, improving "pt simplification" (#222)
Slow loading of data with e.g., pam.read.load_travel_diary when using pandas v2.1.1 (caused by pandas.MultiIndex.groupby, see pandas issue #55256). (#258)

MATSim warm starting example (#239).
Support for MATSim vehicles files (#215).
Anaconda package of PAM, available on the city-modelling-lab channel (#211).
Python versions 3.9 to 3.11 support (#192, #210).
Documentation, now available at https://arup-group.github.io/pam (#197).
Time-space prism method for selecting the location of non-mandatory activities (#252).
Simple IPF approach for generating synthetic populations (#253).
More control over the look of activity plan plots, with keyword arguments for (accessed via e.g. [pam.core.Person.plot]) extended to allow figure width and per-activity label font sizes to be updated (#249).
internal Codecov and pre-commit CI bots (#202).
internal Github action job to build PAM and run tests on Windows and MacOS machines (#192).
internal Contribution guidelines and issue/pull request templates (#207).

Documentation and examples improved (#239).
TourPlanner class sequences stops using GreedyTSP algorithm, rather than previous method sorting by distance from depot (#231).
Minor changes to docs for zsh users (eg pip install '.[dev]')(#219).
Recommended installation instructions, to use mamba instead of pip (#192, #211).
Docker image entry point from python to bash (#230).
internal Source code and example notebook code layout to align with pep8 guidelines and to remove unused dependency imports (#196, #201).
internal Docstrings to Google style (#208)
internal development toolkit, moving from internal scripts to pytest plugins (#193).
internal CI actions link to reusable ones from arup-group/actions-city-modelling-lab/, including new memory profiling and multi-OS / python version tests (#243).

Example data files not accessed by any example notebook (#196).
ActivityDuration class, replaced with methods in TourPlanner and in pam.samplers.tour (#231).
internal Unused scripts that were outside the source code directory (#199).

This version is a pre-release

Option to skip existing facility locations during facility sampling, by adding the location_override argument to the sample_locs method (#190).

This version is a pre-release

A bug when creating origin-destination (OD) matrices within the ODFactory class (#191).

Abstract mode and location choice modules, available within the pam.planner.choice_location module (#189).

internal Docker base image to ensure successful CodeBuild CD pipeline builds (#188).

internal initialisation files, such that PAM submodules can be accessed after installing the repository as a package with pip (#187).

This is the first version of PAM which follows semantic versioning and can be considered the first official release of the package.