brief in-file description of simulation 01, 02

mauriceling · Oct 31, 2013 · 6578abc · 6578abc
1 parent 51a559b
commit 6578abc
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/examples/01_basic_functions_one_cell_deployment.py b/examples/01_basic_functions_one_cell_deployment.py
@@ -1,3 +1,15 @@
+'''
+Example 01: The most basic simulation (using default simulation functions)
+
+In this simulation,
+    - 1 population of 100 organisms
+    - each organism will have 1 chromosome of only 2 bases (1 and 0)
+    - entire population will be deployed in one eco-cell (0, 0, 0)
+    - 10% background point mutation on chromosome of 30 bases
+    - no organism movement throughout the simulation
+    - Ragaraja interpretation of genome (with new blood option)
+    - 100 generations to be simulated
+'''
 # needed to run this example without prior
 # installation of DOSE into Python site-packages
 import run_examples_without_installation

diff --git a/examples/02_basic_functions_even_deployment.py b/examples/02_basic_functions_even_deployment.py
@@ -1,3 +1,16 @@
+'''
+Example 02: Basic simulation (using default simulation functions) with 
+initial deployment
+
+In this simulation,
+    - 2 populations of 100 organisms each
+    - each organism will have 1 chromosome of only 2 bases (1 and 0)
+    - each population will be evenly deployed across 2 eco-cells
+    - 10% background point mutation on chromosome of 30 bases
+    - no organism movement throughout the simulation
+    - no Ragaraja interpretation of genome
+    - 100 generations to be simulated
+'''
 # needed to run this example without prior
 # installation of DOSE into Python site-packages
 import run_examples_without_installation