Ratinabox

This will be unpinned as a soon as important associated packages (`matplotlib`, `scipy` etc.) support 2.0.0.

Minor bug fixes including:
* shade kwarg added to plot for easier plotting of large numbers of neurons
* Motion model update to prevent rat escaping _internal_ boxes (an edge case I'd never thought to consider but was brought to my attention by romanpogodin)
* Better commenting of speed params in 2D
* Vector cell coloring bug

What's Changed
* Added shade_kwargs to utils.mountain_plot(). by colleenjg in https://github.com/RatInABox-Lab/RatInABox/pull/122
* Resetting the colors of vector cells bugfix by Alxec in https://github.com/RatInABox-Lab/RatInABox/pull/124
* Speed mean and std in 2D by colleenjg in https://github.com/RatInABox-Lab/RatInABox/pull/126


**Full Changelog**: https://github.com/RatInABox-Lab/RatInABox/compare/v1.15.2...v1.15.3

niksirbi fixed a bug causing the documentation website to fail. This has been patched.
colleenjg changed how figures are saved so the folder does YYY_MM_DD
colleenjg changed how BVCs are scaled with their `max_fr`

What's Changed
* Make save folders year first by default. by colleenjg in https://github.com/RatInABox-Lab/RatInABox/pull/117
* Changed how firingrate is scaled to maximum for BVCs. by colleenjg in https://github.com/RatInABox-Lab/RatInABox/pull/118
* Fix links in documentation build by niksirbi in https://github.com/RatInABox-Lab/RatInABox/pull/119

New Contributors
* niksirbi made their first contribution in https://github.com/RatInABox-Lab/RatInABox/pull/119

**Full Changelog**: https://github.com/RatInABox-Lab/RatInABox/compare/v1.15.1...v1.15.2

Just cleans up some API stuff for the SubAgent class introduced in version v1.15.0

`SubAgent` contrib and minor QOL upgrades

This release adds `save_fig()` kwargs which aer passed directly to `matplotlib.save_figure` function so you can modify how figures are saved.

Also adds `SubAgent` class in the controls. `SubAgent`s take as input, and are "subservient" to, another `Agent` (the LeadAgent). The key thing idea is that the `SubAgent` may have an update() function which relies heavily on the state of the LeadAgent. Examples included are:

* `DumbAgent` a noisy version of `LeadAgent`
* `ThetaSequenceAgent` theta sweeps around the `LeadAgent`s position
* `ReplayAgent` occasional short replay events


The API is as follows


Env = Environment()
Ag = Agent(Env) the lead agent
DumbAg = DumbAgent(LeadAgent=Ag, params = {'drift_distance':0.1})

while Ag.t < 60:
Ag.update()
DumbAg.update()


`DumbAg.animate_trajectory()` then returns something like:


https://github.com/user-attachments/assets/cf472dc3-f33e-41db-bd63-1587949df141



**Full Changelog**: https://github.com/RatInABox-Lab/RatInABox/compare/v1.14.1...v1.15.0

Minor interpolation bug fix as pointed out by 114. Also changed `save_to_history()` from using `list(array)` to `array.tolist()`