Reorganize models, add models with semi-fixed pop size, update readme.

Author: samchamper

README.md

@@ -1,6 +1,19 @@
 # Resource-Explicit Interaction Models for Spatial Populations
 
-Models and data for the forthcoming "Resource-Explicit Interaction Models for Spatial Populations." 
+Models and data for the forthcoming "Resource-Explicit Interaction Models for Spatial Populations."
 
 Authors:
 Samuel E. Champer, Bryan Chae, Benjamin C. Haller, Jackson Champer, Philipp W. Messer
+
+
+## Contents:
+Models are seperated into six folders.
+- non-resource-explicit_models: contains models that are used for performance comparisons in the paper.
+- hexagonally-tiled_models: contains versions of the four main resource-explicit model variants using a hexagonally tiled area.
+- square-tiled_models: as above, but with a square tiled area.
+- random_resource_placement_models: as above but with randomly placed resource nodes.
+- optimized_for_parallel: contains all of the models as organized in the four folders above, but optimized to be run with multithreading.
+other_resource_explicit_models: contains an additional version of the elastic model that has been optimized for a species with infrequent dispersal. This model uses a square tiling, but could also be implimented with a hexagonal tiling. This folder also contains versions of each of the four main resource-explicit model variants that have been altered to have a semi-fixed population size. These models use a square tiling, but could be implimented with any resource placement method.
+
+
+#### Note: These models require a minimum of the pre-release version of SLiM available on GitHub: https://github.com/MesserLab/SLiM

models/hexagonal/elastic_single_dispersal_hex.slim

@@ -5,10 +5,10 @@ species all initialize() {
     defineCfgParam("FORAGING_AREA", 1);  // E.g., in hectares or sq km.
     defineCfgParam("INDIVIDUALS_PER_FORAGING_AREA", 100);
     defineCfgParam("LITTER_SIZE", 8);
+    defineCfgParam("NODES_PER_FORAGING_AREA", 25);  // Tiling density.
 
     defineConstant("FORAGING_RADIUS", sqrt(FORAGING_AREA/PI));
     defineConstant("MIGRATION_DISTANCE", 2 * FORAGING_RADIUS);
-    defineConstant("NODES_PER_FORAGING_AREA", 37);  // Tiling density.
 
     initializeSLiMModelType("nonWF");
 

models/hexagonal/elastic_hex.slim …exagonally-tiled_models/elastic_hex.slimmodels/hexagonal/elastic_hex.slim renamed to models/hexagonally-tiled_models/elastic_hex.slim models/hexagonal/elastic_hex.slim renamed to models/hexagonally-tiled_models/elastic_hex.slim

@@ -5,10 +5,10 @@ species all initialize() {
     defineCfgParam("FORAGING_AREA", 1);  // E.g., in hectares or sq km.
     defineCfgParam("INDIVIDUALS_PER_FORAGING_AREA", 100);
     defineCfgParam("LITTER_SIZE", 8);
+    defineCfgParam("NODES_PER_FORAGING_AREA", 25);  // Tiling density.
 
     defineConstant("FORAGING_RADIUS", sqrt(FORAGING_AREA/PI));
     defineConstant("MIGRATION_DISTANCE", 2 * FORAGING_RADIUS);
-    defineConstant("NODES_PER_FORAGING_AREA", 37);  // Tiling density.
 
     initializeSLiMModelType("nonWF");
 

models/hexagonal/inelastic_fair_hex.slim …lly-tiled_models/inelastic_fair_hex.slimmodels/hexagonal/inelastic_fair_hex.slim renamed to models/hexagonally-tiled_models/inelastic_fair_hex.slim models/hexagonal/inelastic_fair_hex.slim renamed to models/hexagonally-tiled_models/inelastic_fair_hex.slim

@@ -5,10 +5,10 @@ species all initialize() {
     defineCfgParam("FORAGING_AREA", 1);  // E.g., in hectares or sq km.
     defineCfgParam("INDIVIDUALS_PER_FORAGING_AREA", 100);
     defineCfgParam("LITTER_SIZE", 8);
+    defineCfgParam("NODES_PER_FORAGING_AREA", 25);  // Tiling density.
 
     defineConstant("FORAGING_RADIUS", sqrt(FORAGING_AREA/PI));
     defineConstant("MIGRATION_DISTANCE", 2 * FORAGING_RADIUS);
-    defineConstant("NODES_PER_FORAGING_AREA", 37);  // Tiling density.
 
     initializeSLiMModelType("nonWF");
 

models/hexagonal/inelastic_hex.slim …agonally-tiled_models/inelastic_hex.slimmodels/hexagonal/inelastic_hex.slim renamed to models/hexagonally-tiled_models/inelastic_hex.slim models/hexagonal/inelastic_hex.slim renamed to models/hexagonally-tiled_models/inelastic_hex.slim

@@ -5,10 +5,10 @@ species all initialize() {
     defineCfgParam("FORAGING_AREA", 1);  // E.g., in hectares or sq km.
     defineCfgParam("INDIVIDUALS_PER_FORAGING_AREA", 100);
     defineCfgParam("LITTER_SIZE", 8);
+    defineCfgParam("NODES_PER_FORAGING_AREA", 25);  // Tiling density.
 
     defineConstant("FORAGING_RADIUS", sqrt(FORAGING_AREA/PI));
     defineConstant("MIGRATION_DISTANCE", 2 * FORAGING_RADIUS);
-    defineConstant("NODES_PER_FORAGING_AREA", 37);  // Tiling density.
 
     initializeSLiMModelType("nonWF");