List of Enhancements

[jaantollander]

General Enhancements

• Add CHANGE_LOG

  • https://en.wikipedia.org/wiki/Changelog
  • http://keepachangelog.com/en/0.3.0/
  • https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html

• Licensing

  • https://youtu.be/9kGrKBOytYM
  • GPL to MIT?

• Cross Platform Compatibility

  • Linux
  • Windows
  • OSX

• Asynchronous Logging

  For performance reasons it might be nesessary to implement async logging.

  • https://stackoverflow.com/questions/24791395/python-logging-causing-latencies
  • https://plumberjack.blogspot.fi/2010/09/improved-queuehandler-queuelistener.html
  • https://gist.github.com/vsajip/591699

• Plugin System

• Traits https://github.com/enthought/traits and https://github.com/enthought/traitsui

• https://github.com/ipython/traitlets

Command line client and Graphical user interface

• Progress bar

  • Fix tqdm progress bar to work with pytest

• Commands

  • startproject
  • list
  • run
  • new
    • Template / cookiecutter

• Command Arguments

  • debug
  • profile
  • loglevel
  • seed for random state

• help text for mkoption

• Launch multiple simulation in parallel

• Scheduler

• Read simulation configs from file

• load and restart old simulations

• chaining command to run different simulation types at chained, should
  also work in parallel

• token normalization

References:

• https://github.com/aharris88/awesome-cli-apps
• https://doc.scrapy.org/en/1.3/topics/commands.html

Visualization

• Dense Crowds and Blender 3D
  • https://www.blender.org/conference/2015/presentations/163
  • https://youtu.be/l4HIHrSp0Xg
  • http://dspace.library.uu.nl/bitstream/handle/1874/330667/Stuvel.pdf?sequence=1
  • https://github.com/johnroper100/CrowdMaster

Structures

• Rewrite Agent class with custom numpy.dtype
• Implement Walls using custom numpy.dtype
• Linear obstacles -> linestrings concatenated with np.nan
  • Save information if linestring is closed (linear ring)
• Agents should have active / inactive state

Performance and Algorithms

• Navigation algorithm
  • Fix artifacts when merging direction maps
  • Optimize fill missing values by interpolation nearest values.
  • Nearest interpolation should take mean value when multiple points are at same length
• Social forces should not effect through obstacles
• Replace social force between agent and obstacles with navigation + adjusting force
• Herding / Leader Follower effect
• Fix three_circle model
• Control and save random state / seed used for generating the simulation
• Fix truncnorm to control the standard deviation
• Test performance of KDTree for partitioning

Performance

• Use multithreading to enhance the speed of computing interactions

• Use numba.CC to precompile core functions

• Evaluate potential GPU acceleration and CUDA use

• Pytest pytest-benchmark plugin for benchmarking code

• psutil

• float32 vs float64

• Computing Task Nodes in Parallel

  • Concurrent.futures
  • Dask http://dask.pydata.org/en/latest/index.html

• Intel distribution for python and VTune profiler

  • Intel Python distribution Intel distribution for Python
  • Intel profiler Intel® VTune™ Amplifier 2017
  • Intel's conda channel

MultiAgentSimulation

• Properties -> Descriptors
  • domain
  • obstacles
  • targets
  • agents
  • tasks
• Validation
  • Types
  • Values

Task Nodes

• Factory for generating nodes
• Nodes using generators / coroutines
• Changing agent state

IO

• Simulation Time
• json/ yaml metadata files
• Simulation initial configurations
• Serializing simulation geometries: GeoJSON-like dicts

References

• http://www.dabeaz.com/coroutines/Coroutines.pdf

Testing

• Fix coverage of Numba jitted functions

  Code coverage does not recognize Numba jitted functions (@numba.jit()). Can possibly be fixed with llvm-cov.

• Benchmarks

Documentation

• Video tutorial on how to use crowddynamics
• Improve conf.py configuration file
• Add LaTeX output to sphinx config
• Possibility of colored equations with Mathjax
  • https://adereth.github.io/blog/2013/11/29/colorful-equations/

Packaging and distributing

• Conda recipe, conda-forge feedstock