Metadata-Version: 2.1
Name: cromosim
Version: 2.0.2
Summary: UNKNOWN
Home-page: http://www.cromosim.fr
Author: Sylvain Faure, Bertrand Maury
Author-email: sylvain.faure@math.u-psud.fr, bertrand.maury@math.u-psud.fr
License: GPL
Keywords: Crowd Motion Simulator
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.18.0)
Requires-Dist: scipy (>=1.4.0)
Requires-Dist: Pillow (>=6.0.0)
Requires-Dist: matplotlib (>=3.1.0)
Requires-Dist: numpydoc (>=0.9.0)
Requires-Dist: sphinx (>=2.4.0)
Requires-Dist: scikit-fmm (>=2019.1.30)
Requires-Dist: cvxopt (>=1.2.0)
Requires-Dist: imageio (>=2.8.0)

# cromosim

CROMOSIM is a Python Library for Crowd Motion Simulation.

- **Website:** http://www.cromosim.fr
- **Source code:** https://github.com/sylvain-faure/cromosim

The aim of this open source project is to make it possible to users to run simulations based from several models (cellular automata, microscopic simulations or using compartments), to test new configurations, and even to investigate the possibility to program their own model in complex geometry : do-it yourself !

This package proposes Python implementations of the numerical methods detailed in the book “Crowds in equations: an introduction to the microscopic modeling of crowds” by B. Maury (ENS Ulm & Univ. Paris-Sud) and S. Faure (CNRS), World Scientific 2018, Advanced textbooks in mathematics.



How to use cromosim ?
---------------------

First you have to install cromosim, either by using pip:

    ~$ pip install cromosim

or by manually installing the package:

    cromosim$ python setup.py install

Once cromosim is installed, you can verify that it is possible to import it
into Python:

    ~$ python
    Python 3.7.7 (default, Mar 10 2020, 15:43:33)
    [Clang 11.0.0 (clang-1100.0.33.17)] on darwin
    Type "help", "copyright", "credits" or "license" for more information.
    >>> import cromosim
    >>> print(cromosim.__version__)
    2.0.0
    >>>

Now to make a first simulation, you can download one of the examples found in:

    https://github.com/sylvain-faure/cromosim/tree/master/examples

or retrieve all the examples available using the following command (svn
is the Subversion command):

    ~$ svn export https://github.com/sylvain\-faure/cromosim/trunk/examples my-cromosim

and then run a first example:

    ~$ cd my-cromosim/micro/granular
    granular$ python micro_granular.py --json input_room.json

These examples will allow you to start your own calculations.


