Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 868 Bytes

README.md

File metadata and controls

21 lines (17 loc) · 868 Bytes

EvoSim

Agent-based simulator of Evolutionary Dynamics

Try to stick to the guidelines mentioned in The Hitchhiker’s Guide to Python

Installation

The usage of virtual environments is recommended in order to create isolated Python environments and avoid version conflicts with other projects!

  1. Ensure to have virtualenv installed: pip install virtualenv
  2. Set-up a virtual environment (recommended interpreter: Python 3.6.4): virtualenv evosim or virtualenv -p <PATH_TO_PREFERRED_INTERPRETER> evosim
  3. Activate the virtual environment: source $PROJECT_ROOT/venv/bin/activate
  4. Install requirements: pip install -r requirements.txt

Documentation

Important methods are documented using reST docstrings. We do not build separate docs yet, but in the future, we might consider to integrate Sphinx.