Metadata-Version: 2.1
Name: causal-inference-population-dynamics
Version: 0.0.2.dev13
Summary: Library to conduct experiments in population dynamics.
Home-page: https://github.com/artificial-life-lab/population-dynamics
Author: Pranjal Dhole
Author-email: dhole.pranjal@gmail.com
License: MIT
Description: # Population dynamics
        
        [![License](https://img.shields.io/pypi/l/causal-inference-population-dynamics.svg?color=green)](https://github.com/artificial-life-lab/population-dynamics/raw/master/LICENSE)
        [![PyPI](https://img.shields.io/pypi/v/causal-inference-population-dynamics.svg?color=green)](https://pypi.org/project/causal-inference-population-dynamics)
        [![Python Version](https://img.shields.io/pypi/pyversions/causal-inference-population-dynamics.svg?color=green)](https://python.org)
        [![codecov](https://codecov.io/gh/artificial-life-lab/population-dynamics/branch/master/graph/badge.svg?token=3SHJIARPOG)](https://codecov.io/gh/artificial-life-lab/population-dynamics)
        
        Library to conduct experiements on population dynamics.
        
        ![Lotka-Volterra predator-prey system](docs/graphics/predator_prey.png)
        
        ## Installation
        
        1. To generate required log and results directories, run
        
        ```(bash)
        bash init.sh
        ```
        
        2. Create conda environment
        
        ```(bash)
        conda env create -f environment.yml
        ```
        
        3. Activate the environment
        
        ```(bash)
        conda activate population-dynamics
        ```
        
        4. Install `causal` as a package within the environment
        
        ```(bash)
        python setup.py develop
        ```
        
        ## Running the Lotka-Volterra simulation
        
        - The Lotka-Volterra simulator class exists in `repo/causal/base/lotka_volterra.py`.
        - The Lotka-Volterra simulation parameters are fetched from `repo/causal/config.py`.
        You can edit the `config.py` file directly to play around with the parameter values.
        
        - You can run the simulator directly from terminal by running
        
        ```(bash)
        python causal/base/lotka_volterra.py
        ```
        
        - The simulation statistics will be saved in the `repo/results` directory.
        
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
