Commit b0614d52 authored by Georgios Dagkakis's avatar Georgios Dagkakis

documentation and readme how to get started change

parent 4afee363
No preview for this file type
No preview for this file type
......@@ -38,20 +38,20 @@ developers.
How to get started
========================
Note: This section does not apply if DREAM is installed with python setup.py or
if you use buildout.
To use the platform you need to:
+ Have Python installed.
+ Clone our git repository (https://github.com/nexedi/dream) or download it into a folder in your computer.
+ Run the setup script that is in the root folder (python setup.py install). This will install ManPy along with its dependencies (e.g. SimPy3)
To be able to run the documentation examples just copy the dream/simulation to your Python folder. Then you can import ManPy objects as it is written in the examples, e.g.:
+ *from simulation.Queue import Queue* or
+ *from simulation.imports import Machine, Source, Exit*
If you copy the whole dream folder, then the import should change to something like *from dream.simulation.Queue import Queue*. If you want to rename the folder it can be *from path.to.my.new.folder.Queue import Queue*.
Then you can import ManPy objects as it is written in the examples, e.g.:
+ *from dream.simulation.Queue import Queue* or
+ *from dream.simulation.imports import Machine, Source, Exit*
Dependencies
=================
ManPy uses the following Python libraries:
+ SimPy
DREAM uses the following Python libraries:
+ SimPy3
+ NumPy
+ SciPy
+ xlrd
......@@ -105,4 +105,4 @@ Ioannis Papagiannopoulos
Panos Barlas
Kazuhiko Shiozaki
Kazuhiko Shiozaki
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment