N E M O

Most recent version available at: http://sourceforge.net/projects/nemo2


What is Nemo?
-------------

Nemo is an individual-based, genetically explicit, and stochastic
simulation program. It comes as both a C++ programming framework and an
executable program file. Its object-oriented programming design gives it
the flexibility and extensibility needed to implement a large variety of
forward-time evolutionary models. It provides developers with abstract
models allowing them to implement their own individual traits and life cycle
events. The framework includes a large panel of population models, from
the Island model to lattice models with demographic or environmental
stochasticity, into which developers can plug their own code. Nemo also
provides developers and end-users with a variety of already implemented
traits (sex-specific dispersal, deleterious mutations, neutral markers,
endosymbiotic parasites, etc.) and life cycle events (mating, dispersal,
aging, selection, population extinction, etc.) as well as with output
operators for data and statistics saving. Nemo can be used as both a
genetic dataset generator or a simulator of life-history trait evolution
in structured populations. It runs on all major computer platforms
including parallel computing environments.


How to use Nemo?
----------------

Please refer to the user manual to have info on how to use Nemo as a
command-line tool.

Instructions on how to use Nemo as a development framework can be found
in the code documentation and examples at http://nemo2.sourceforge.net


Requirements
------------

The following operating system software is required to compile, install
and run the software:

	- Any of Linux, MacOSX, or Windows (XP/Vista/...)
	- CygWin is recommended on Windows, at least to compile Nemo (http://www.cygwin.com). Nemo can be run without CygWin using the DOS command prompt.
	
Nemo uses the following third-party software pieces that should be
present on your system as well (at least for building Nemo from source):

	- The GSL: GNU Scientific Library version 1.12 or higher
	  
	  The GSL is available at: http://www.gnu.org/software/gsl/
	  
for the MPI version only:
	- The SPRNG: Scalable Parallel Random Number Generators Library
version 5.0

	  SPRNG is available at: http://sprng.cs.fsu.edu/


Compilation and Installation
----------------------------

Please read the INSTALL file for compilation and installation instructions.


Getting Support and Additional Resources
-----------------------------------------

If the documentation mentioned here does not answer your question, you
can post it on the mailing list available at:
	http://lists.sourceforge.net/lists/listinfo/nemo2-user
	
	
Authors and Contributors
------------------------

Frederic Guillaume (author)
frederic.guillaume@ieu.uzh.ch

Jacques Rougemont (MPI version)
Jacques.Rougemont@isb-sib.ch

Any people willing to contribute to the development of the Nemo
framework is most welcome! Contact the author for more info on
how to contribute.

Legal Stuff
-----------

Nemo is Copyright 2006 - 2018 by Frederic Guillaume.

Nemo is free software, you can redistribute it and/or modify it under
the terms of the GNU General Public License.

The GNU General Public License does not permit this software to be
redistributed in proprietary programs.

Nemo is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the COPYING
file for more information.

The GSL code is provided under the GNU General Public License as well.

SPRNG code is provided "as is" by the NCSA.

