Read Me
MiXiM http://mixim.sourceforge.net/
-----------------------------------
-----------------------------------
Contents
========
- Purpose and History
- Copyright
- Authors
- Installation
- Documentation
- Release notes
Purpose and History
===================
MiXiM (mixed simulator) is a simulator for wireless and mobile networks
using the OMNeT++ simulation engine.
MiXiM is available at http://mixim.sourceforge.net/
MiXiM is the attempt to merge several OMNeT++ simulators written to support
mobile and wireless simulations.
Those prdecessors of MiXiM are:
- ChSim
http://www.cs.uni-paderborn.de/en/fachgebiete/research-group-computer-networks/projects/chsim.html
(c) by Universitaet Paderborn
- Mac Simulator
http://www.consensus.tudelft.nl/software.html
(c) by Technische Universiteit Delft
- Mobility Framework
http://mobility-fw.sourceforge.net/
(c) by Technische Universitaet Berlin, Telecommunication Networks Group
- Positif Framework
http://www.consensus.tudelft.nl/software.html
(c) by Technische Universiteit Delft
MiXiM further includes the "Mixnet" project which provides compatibility modules
and documentation in case you want to use MiXiM together with the INET
framework. For details on Mixnet and INET please take a look at its README file
in MiXiM's "inet" folder.
Copyright
=========
Copyright (C) 2007
- Technische Universitaet Berlin (TUB), Germany
Telecommunication Networks Group
- Technische Universiteit Delft (TUD), Netherlands
- Universitaet Paderborn (UPB), Germany
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
The TUB, TUD, and UPB do not provide any warranty for MiXiM --
you did not pay for it! Further details can be found in the file
COPYING.
As a good practice, you should acknowledge the work done in MiXiM
just as you do if you cite a scientific work.
Authors
=======
The current authors and maintainers of MiXiM are
- Andreas Koepke, TUB (koepke@tkn.tu-berlin.de)
- Hermann S. Lichte, UPB (hermann.lichte@uni-paderborn.de)
- Tom Parker, TUD (t.e.v.parker@tudelft.nl)
- Michael Swigulski, TUB (swigulski@tkn.tu-berlin.de)
- Stefan Valentin, UPB (stefan.valentin@upb.de)
- Otto Visser, TUD (o.w.visser@tudelft.nl)
- Karl Wessel, TUB (wessel@tkn.tu-berlin.de)
- Daniel Willkomm, TUB (willkomm@tkn.tu-berlin.de)
Installation
============
For installation instructions please see the INSTALL file
How to start
============
A step-by-step guide on how to start with MiXiM can be found in MiXiM's wiki at:
http://sourceforge.net/apps/trac/mixim/wiki/StepByStep
MiXiM contains wizards for the project-creation-wizard in the OMNeT++ IDE.
These are:
* a wizard to create a basic MiXiM-network by configuring the hosts from
predefines application layers, NIC protocols and mobility modules as well
as choosing the playground topology.
* a wizard to create a simple MiXiM-network. The hosts contain an analogue model
which can be basically configured in the wizard. This network is useful
to implement and test a new analogue model.
To create a new project using MiXiM's wizards please go to:
"File -> New -> OMNeT++ Project...", name your project, and in the next step
select the wizard to be used. It will present the configuration options
during the next step(s). When the creation process has finished,
the new MiXiM-network is ready to be built and run.
Documentation
==============
All documentation can be found in the doc directory. If you still have questions
after reading these, check out the website at http://mixim.sourceforge.net.
To send any kind of feedback, bug reports, feature requests etc. please use the
OMNeT++ mailing list omnetpp-l@omnetpp.org.
You have to subscribe to it first,
see http://www.omnetpp.org/external/maillist.php for details.
Release Notes
=============
See following site for notes on what changed with each release (beginning with 1.2):
http://sourceforge.net/apps/trac/mixim/wiki/WhatChanged