Permalink
Browse files

Modified documentation according to FMS availability on PyPI

  • Loading branch information...
jcbagneris committed May 17, 2011
1 parent 7871e2e commit 02f10533f4f9bbfbf05d31a4813e02f3d01f412f
Showing with 166 additions and 128 deletions.
  1. +19 −4 INSTALL
  2. +2 −2 README
  3. +5 −5 docs/en/index.txt
  4. +66 −42 docs/en/install.txt
  5. +0 −74 docs/en/man/fms.1
  6. +0 −1 docs/en/man/startfms.1
  7. +74 −0 docs/en/man/startfms.1
View
23 INSTALL
@@ -11,10 +11,21 @@ Requirements
Installing FMS
==============
-To install it, make sure you have Python 2.4 or greater installed. Then run
-this command (as root) from a command prompt:
+The preferred way to install FMS is to use the pip_ installer::
- python setup.py install
+ $ pip install fms
+
+It should install it, and any required dependancies (that is, PyYaml at the
+moment). You may consider installing in a Virtual environment.
+
+.. _Virtual environment: http://guide.python-distribute.org/virtualenv.html
+.. _pip: http://guide.python-distribute.org/installation.html#pip-info
+
+If you downloaded a source pakage and want to install it, make sure you have
+Python 2.4 or greater installed. Then run this command (as root) from a command
+prompt:
+
+ $ python setup.py install
As an alternative, you may just copy or link the fms directory in your
@@ -32,7 +43,11 @@ To check that anything went well, cd to the tests directory and run:
Uninstalling FMS
================
-If you need/want to uninstall FMS, cd to your Python's installation
+If you installed FMS with pip_, then simply::
+
+ $ pip uninstall fms
+
+If you installed FMS from source, cd to your Python's installation
site-packages directory, and remove fms directory and egg-info file :
rm -r fms*
View
4 README
@@ -2,7 +2,7 @@
FMS, An agent-based Financial Market Simulator
==============================================
-FMS is (c) 2008,2009 Jean-Charles Bagneris. See LICENSE for redistribution
+FMS is (c) 2008-2011 Jean-Charles Bagneris. See LICENSE for redistribution
information and usual disclaimer.
Thanks for downloading FMS !
@@ -157,4 +157,4 @@ Report bugs, write new classes, translate documentation, write documentation and
additional example, request new features, watch or fork `the project`_, use FMS and
let people know you use it. Think of other ways to contribute. Thank you :)
-.. _the project: http://github.com/jcbagneris/fms/tree/master
+.. _the project: http://github.com/jcbagneris/fms/
View
@@ -4,7 +4,7 @@
FMS, an agent based Financial Market Simulator
==============================================
-FMS is (c) 2008,2009 Jean-Charles Bagneris. See the LICENSE file in the
+FMS is (c) 2008-2011 Jean-Charles Bagneris. See the LICENSE file in the
distribution bundles for redistribution information and usual disclaimer.
.. index:: about
@@ -57,7 +57,7 @@ Rationale and history
FMS was primarily developed for my own research projects. The idea came from many
other agent based simulation programs, but the design was especially inspired by
-Julien Derveeuw thesis (in french) : Derveeuw J., Simulation multi-agents de
+Julien Derveeuw thesis (in French) : Derveeuw J., Simulation multi-agents de
marchés financiers, Université des Sciences et Technologies de Lille, 2008 (see
http://cisco.univ-lille1.fr/papers/ for more information).
@@ -80,7 +80,7 @@ To use FMS, you first need to download and install it on your system
forget to run the tests once you are done.
Then, you should describe an experiment for FMS to run. Experiments are
-described in config file in the YAML_ format, which is hopefully rather easy to
+described in config files in the YAML_ format, which is hopefully rather easy to
read and write.
Once you have written an experiment configuration file, you simply run fms on
@@ -97,7 +97,7 @@ Extending FMS
If you read all this, then you certainly have a good reason to use FMS. If the
world, engines, markets and agent classes included in FMS do not meet your
needs, then you may either write yours, or even (politely) require us to write
-it for you. Of course, your problem has to be interesting enough for us to do
+those for you. Of course, your problem has to be interesting enough for us to do
this, and the resulting classes would be part of FMS next release. By the way,
if you write yourself an interesting class for FMS, please submit it for
inclusion (you would of course be credited for your work).
@@ -108,7 +108,7 @@ How could I contribute ?
========================
Report bugs, write new classes, translate documentation, write documentation and
-additional example, request new features, use FMS and let people know you use
+additional examples, request new features, use FMS and let people know you use
it. Think of other ways to contribute. Thank you :)
The FMS sources repository is available for cloning on github_. To clone
View
@@ -6,47 +6,16 @@
FMS download and installation
=============================
-Downloading FMS
-===============
-
.. note::
Latest version of FMS is |release|.
-FMS packages are available in various formats, suitable for different operating
-systems. Download links :
-
-* ``tar.gz`` package : `fms-latest.tar.gz`_
-
-* ``zip`` package : `fms-latest.zip`_
-
-* Windows installer : `fms-latest.win32.exe`_
-
-.. _fms-latest.tar.gz: /dist/fms-0.1.5.tar.gz
-.. _fms-latest.zip: /dist/fms-0.1.5.zip
-.. _fms-latest.win32.exe: /dist/fms-0.1.5.win32.exe
-
-Check the packages once you downloaded it : md5sums.txt_
-
-.. _md5sums.txt: /dist/md5sums.txt
-
-.. index:: source, git
-
-In addition, you may clone the source repository of FMS. As it is managed with
-`the git VCS`_, you need first to install it, then to get the repository run::
-
- git clone git://github.com/jcbagneris/fms.git
-
-If you develop new classes or squash bugs, consider sending a patch, or asking
-for pull access on the repository.
-
-.. _the git VCS: http://git.or.cz
-
Installing FMS
==============
.. warning::
- If a previous version of FMS is installed on your system, *uninstall it*
+ If you installed from source (see below) and a previous version of FMS is
+ installed on your system, *uninstall it*
prior to installing the new version. Really. I mean it. See
`Uninstalling FMS`_ below for detailed instructions about
uninstallation.
@@ -61,7 +30,8 @@ Requirements
should be 2.4 or greater.
- The PyYaml library (http://pyyaml.org/) is necessary to read configuration
- files.
+ files. Note that installing FMS with the pip_ installer would automatically
+ install PyYaml if it is missing on your system.
.. index::
pair: linux; installation
@@ -71,14 +41,35 @@ Requirements
Linux and BSD distributions
---------------------------
-Get the source package (see `downloading FMS`_ above), uncompress it wherever
+Installing with pip
+~~~~~~~~~~~~~~~~~~~
+The preferred way to install FMS is to use pip_ (Pip Installs Python). You may
+even choose to install it in a `Virtual environment`_ to isolate it.
+
+Whichever environment you chose, simply::
+
+ $ pip install fms
+
+And you're done. You may even upgrade an FMS installation::
+
+ $ pip install -U fms
+
+.. _Virtual environment: http://guide.python-distribute.org/virtualenv.html
+
+Installing from source
+~~~~~~~~~~~~~~~~~~~~~~
+
+I cannot imagine any good reason not to benefit of pip_ goodness, unless you want
+to get the source to contribute. Anyway, it is possible to install from source.
+
+Get the source package (see `getting FMS sources`_ below), uncompress it wherever
you think is a suitable place (``usr/local/src/`` might seem a clever choice,
though).
``cd`` to the newly created directory. Then run this command (as root) from a
command prompt::
- python setup.py install
+ $ python setup.py install
As an alternative, you may just copy or link the ``fms`` directory in your
@@ -88,17 +79,26 @@ In addition, you may move the ``startfms.py`` script somewhere on your path.
To check that anything went well, ``cd`` to the tests directory and run::
- python runalltests.py
+ $ python runalltests.py
.. index::
pair: windows; installation
+.. _pip: http://guide.python-distribute.org/installation.html#pip-info
+
Windows
-------
+If you use ActivePython_, your best bet is to install FMS through the PyPM
+installer, as you would do for any other third-party package.
+
+.. _ActivePython: http://www.activestate.com/activepython/downloads
+
+Otherwise, you can install a binary package from the github download section.
+
First, make sure you installed Python and YAML (see requirements_ above).
-Get the Windows FMS installer (see `downloading FMS`_ above) and put it
+Get the Windows FMS installer from `FMS main repository`_ download section and put it
somewhere on the desktop, then double-click on it. Leave the default answers to
all the questions (or be prepared to remember what you did, to swear, and to
cry... That is, unless you really know what you are doing, of course).
@@ -156,7 +156,7 @@ Do not forget the trailing backslash !
Note that you should adapt to the version of python you installed, and to the path where you installed it. It might as well be::
- C:\Program Files\Python25\;
+ C:\Program Files\Python26\;
Then, start or go to a command prompt, and try::
@@ -197,25 +197,49 @@ Uninstalling FMS
Uninstalling on Linux and BSD
-----------------------------
-If you need/want to uninstall FMS, ``cd`` to your Python's installation
+If you installed FMS with pip_, then simply::
+
+ $ pip uninstall fms
+
+And you're done.
+
+If you installed from source, ``cd`` to your Python's installation
``site-packages`` directory, and remove fms directory and egg-info file::
- rm -r fms*
+ $ rm -r fms*
Then remove the ``startfms.py`` script from where it was installed, probably
``/usr/bin/`` or ``/usr/local/bin/`` on Unix.
Uninstalling on Windows
-----------------------
-On Windows, if you used the binary installer, you may uninstall FMS directly
+On Windows, if you used a binary installer, you may uninstall FMS directly
from the application managing all installed programs. Otherwise, go to your
Python installation directory (usually ``C:\Python26``), then to the
``Site-packages`` directory, and delete anything fms-related in it (probably a
directory called ``fms``).
You're done. Thanks for giving FMS a try !
+Getting FMS sources
+===================
+
+.. index:: source, git
+
+If you need to get packaged sources of FMS, either as a zip file or a tarball,
+then go to `FMS main repository`_ and use the download facilities.
+
+In addition, you may clone the source repository of FMS. As it is managed with
+`the git VCS`_, you need first to install it, then to get the repository run::
+
+ $ git clone git://github.com/jcbagneris/fms.git
+
+If you develop new classes or squash bugs, consider sending a patch, or asking
+for pull access on the repository.
+
+.. _the git VCS: http://git.or.cz
+.. _FMS main repository: https://github.com/jcbagneris/fms
-------------------
View
@@ -1,74 +0,0 @@
-.\" This file is part of FMS, an agent-based Financial Market Simulator
-.\" FMS is (c) 2008,2009 Jean-Charles Bagneris. See LICENSE for redistribution
-.\" information and usual disclaimer.
-.\" Process with groff -man -Tascii fms.1
-.\"
-.TH FMS 1 "2008-12-08" "FMS Development Team" "Financial Market Simulator"
-.SH NAME
-fms \- a financial market simulator
-.SH SYNOPSIS
-.B startfms.py [options] [command] [
-.I experiment-config-file
-.B ]
-.SH DESCRIPTION
-.B fms
-is an agent-based market simulator. The main program,
-.B fms.py
-can read and validate an "experiment" config file, and/or
-run it, outputting transactions data on
-.I stdout
-or in a .csv file.
-The experiment configuration file is described in experiment-conf.yml(5).
-.SH OPTIONS
-Options override
-.I experiment-config-file
-parameters values.
-.IP "-h, --help"
-Show help message and quit.
-.IP "-L LEVEL, --loglevel LEVEL"
-Set logging level to
-.I LEVEL.
-This overrides the -v option.
-.IP "-v, --verbose"
-Set logging level to 'info'.
-Overrided by -L or --loglevel option.
-.IP "--show-books, --show-limits"
-Show best limits on each step.
-.IP "--timer"
-Show a day:time timer while experiment is running.
-.IP "--unique_by_agent"
-Orders in books are unique by agent : if the same agent places
-another order, previous one is deleted. This is the default.
-.IP "--no_unique_by_agent"
-Agents may place multiple orders.
-.IP "--csvdelimiter DELIMITER"
-CSV files delimiter value.
-.IP "--randomseed SEED"
-Ramdom seed value.
-.IP "--outputfilename OUTPUTFILE, -o OUTPUTFILE"
-Set output filename. This overrides
-.I OUTPUTFILENAME
-param in experiment config file.
-.IP "--orderslogfile FILENAME, --ordersfile FILENAME"
-Set orders log filename. This overrides
-.I ORDERSLOGFILE
-param in experiment config file.
-.IP "--repeat NUM"
-Repeat experiment
-.I NUM
-times.
-.SH COMMANDS
-.IP "check"
-Checks validity of
-.I experiment-config-file
-by trying to instanciate all classes : world, engines, markets and agents.
-.IP "run"
-Run experiment from
-.I experiment-config-file
-.SH SEE ALSO
-experiment-conf.yml(5)
-.SH BUGS
-Probably many.
-.SH AUTHOR
-Jean-Charles Bagneris <jcb at bagneris dot net>
-
View

0 comments on commit 02f1053

Please sign in to comment.