1. Yi-Xin (Eshin) Liu
  2. ngpy

Commits

Yi-Xin (Eshin) Liu  committed 776ed3c

Update README. Ready for releasing version 0.3.

  • Participants
  • Parent commits c503295
  • Branches default

Comments (0)

Files changed (6)

File ADMIN.txt

  • Ignore whitespace
-* start ZEO server
-    in the test.fs directory, run
-        $ runzeo -a 0.0.0.0:1234 -f ./test.fs
-
-* Pack ZODB database
-    $ zeopack localhost:1234
-    $ cd /path/to/test.fs
-    $ rm -f test.fs.old
-
-* start eye server
-    in ~/opt/eye, run
-        $ bin/eye -p 1111 zeo://localhost:1234
-    browse it in FireFox or other browsers with
-        http://127.0.0.1:1111
-
-* PUSH source to Bitbucket
-    $ hg push https://liuyxpp@bitbucket.org/liuyxpp/ngpy
-
-* Run Redis server
-    $ redis-server [/path/to/redis.conf]
-
-* Run the simulation task queue daemon
-    $ simd
-
-* Run the app using the flask server
-    $ run-ngpy
-
-* Run the app through apache + mod_wsgi
-    $ apache start
-  and configure the ngpy.wsgi file
-
-* Browse the app in any Browser
-via flask server
-    http://localhost:5000
-    http://10.22.4.52:5000
-via apache + mod_wsgi
-    http://localhost:8080
-    http://10.22.4.52:8080/ngpy
-

File README.rst

View file
  • Ignore whitespace
 NGPy
 ~~~~
 
-NGPy is a web application that enable online performing and analyzing Monte-Carlo simulation on nucleation and growth phenomena. It can be also used as a web framework to develop your own web applications. NGPy is built on top of Flask.
+NGPy is a web application that enable online performing and analyzing Monte-Carlo simulations on nucleation and growth phenomena. 
+It can be also used as a web framework to develop your own web applications.
+NGPy is built on top of **Flask**.
+NGPy is actually a distributed system since we use **ZEO server** as a database and **redis** server as a message queue.
 
 Quickstart
 ``````````
     $ cd ngpy-xxx
     $ python setup.py install
 
-* Make sure that the NoSQL database redis is installed in your system.
-* Other dependencies like ZODB, WTForm, Numpy, and Matplotlib should be
-  taken care by easy_install. If not, try to install them mannually.
+* Make sure that the NoSQL database **redis** is installed in your system.
 
-2. Start ZODB server
+* Other dependencies such as **ZODB3**, **WTForm**, **Numpy**, and **Matplotlib** should be taken care by *easy_install*. 
+  If not, try to install them mannually.
+
+2. Start ZEO server
 --------------------
 
 ::
 
-    $ runzeo -a 0.0.0.0:<ZEOPORT> -f /path/to/your/data.fs
+    $ runzeo -a 0.0.0.0:<ZEOPORT> -f /path/to/your/Data.fs
 
 * <ZEOPORT> must be an available port number, e.g. 1234
 
+* The **ZEO** server should run at a host that other hosts can connect to. 
+
 3. Start redis server
 ---------------------
 
 
     $ redis-server [/path/to/redis.conf]
 
+* The **redis** server should run at a host that other hosts can connect to.
+
 4. Start the task queue daemon
 ------------------------------
 
 
     $ simd [-r <server>] [-q <qkey>]
 
+* <server> is the host where you run the **redis** server.
+* What **simd** does is that it just picks the messages from **redis** server and process them.
+  So you can run **simd** at every hosts where you wish to run the task.
+
 5. Start ngpy
 -------------
 
 ::
 
-    $ run-ngpy
+    $ run-ngpy [-c </path/to/ngpy.cfg>]
 
-The ngpy website should be now served at http://localhost:5000.
+The *ngpy.cfg* is the configuration file for **ngpy**. 
+It is a Python file and will be processed by *Flask*.
+Only values in uppercase are actually used.
+More details are refered to the **Flask** documentation.
+
+The **ngpy** website should be now served at http://localhost:5000.
 You can visit it use any browser (Chrome, Firefox, IE, etc.) via
 http://localhost:5000
 if you are a local visitor, or
 ````````````
 
 * You can directly contact me at liuyxpp@gmail.com.
-* You can join the mailinglist by sending an email to ngpy@librelist.com and replying to the confirmation mail. To unsubscribe, send a mail to ngpy-unsubscribe@librelist.com and reply to the confirmation mail.
+
+* You can join the mailinglist by sending an email to ngpy@librelist.com and replying to the confirmation mail. 
+  To unsubscribe, send a mail to ngpy-unsubscribe@librelist.com and reply to the confirmation mail.
 
 Links
 `````
 
 * `Website <http://liuyxpp.bitbucket.org>`_
+
 * `Development version <http://bitbucket.org/liuyxpp/ngpy/>`_
 

File manage

  • Ignore whitespace
-#!/usr/bin/env python
-
-from ngpy.ngzodb import create_zodb
-from sys import argv
-
-def create():
-    create_zodb(argv[1])
-
-
-if __name__ == '__main__':
-    create()

File manage-ngpy

View file
  • Ignore whitespace
+#!/usr/bin/env python
+
+from ngpy.ngzodb import create_zodb
+from sys import argv
+
+def create():
+    create_zodb(argv[1])
+
+
+if __name__ == '__main__':
+    create()

File run-ngpy

View file
  • Ignore whitespace
 
 parser = argparse.ArgumentParser()
 parser.add_argument('-c','--config',
-                    default='/export/home/lyx/opt/lyx/ngpy/ngpy.cfg',
+                    default='ngpy.cfg',
                     help='the location of NGPy configuration file.')
 parser.add_argument('-s','--host',default='0.0.0.0',
                     help='the host your app is served.')

File setup.py

View file
  • Ignore whitespace
 NGPy
 ~~~~
 
-NGPy is a web application that enable online performing and analyzing Monte-Carlo simulation on nucleation and growth phenomena. It can be also used as a web framework to develop your own web applications. NGPy is built on top of Flask.
+NGPy is a web application that enable online performing and analyzing Monte-Carlo simulations on nucleation and growth phenomena. 
+It can be also used as a web framework to develop your own web applications.
+NGPy is built on top of **Flask**.
+NGPy is actually a distributed system since we use **ZEO server** as a database and **redis** server as a message queue.
 
 Quickstart
 ``````````
     $ cd ngpy-xxx
     $ python setup.py install
 
-* Make sure that the NoSQL database redis is installed in your system.
-* Other dependencies like ZODB, WTForm, Numpy, and Matplotlib should be
-  taken care by easy_install. If not, try to install them mannually.
+* Make sure that the NoSQL database **redis** is installed in your system.
 
-2. Start ZODB server
+* Other dependencies such as **ZODB3**, **WTForm**, **Numpy**, and **Matplotlib** should be taken care by *easy_install*. 
+  If not, try to install them mannually.
+
+2. Start ZEO server
 --------------------
 
 ::
 
-    $ runzeo -a 0.0.0.0:<ZEOPORT> -f /path/to/your/data.fs
+    $ runzeo -a 0.0.0.0:<ZEOPORT> -f /path/to/your/Data.fs
 
 * <ZEOPORT> must be an available port number, e.g. 1234
 
+* The **ZEO** server should run at a host that other hosts can connect to. 
+
 3. Start redis server
 ---------------------
 
 
     $ redis-server [/path/to/redis.conf]
 
+* The **redis** server should run at a host that other hosts can connect to.
+
 4. Start the task queue daemon
 ------------------------------
 
 ::
 
-    $ simd
+    $ simd [-r <server>] [-q <qkey>]
+
+* <server> is the host where you run the **redis** server.
+* What **simd** does is that it just picks the messages from **redis** server and process them.
+  So you can run **simd** at every hosts where you wish to run the task.
 
 5. Start ngpy
 -------------
 
 ::
 
-    $ run-ngpy
+    $ run-ngpy [-c </path/to/ngpy.cfg>]
 
-The ngpy website should be now served at http://localhost:5000.
+The *ngpy.cfg* is the configuration file for **ngpy**. 
+It is a Python file and will be processed by *Flask*.
+Only values in uppercase are actually used.
+More details are refered to the **Flask** documentation.
+
+The **ngpy** website should be now served at http://localhost:5000.
 You can visit it use any browser (Chrome, Firefox, IE, etc.) via
 http://localhost:5000
 if you are a local visitor, or
-http://IP.of.NGPy.run:5000
+http://IP.of.NGPy.run:5000 
 if you visit remotely.
 
+Ask for Help
+````````````
+
+* You can directly contact me at liuyxpp@gmail.com.
+
+* You can join the mailinglist by sending an email to ngpy@librelist.com and replying to the confirmation mail. 
+  To unsubscribe, send a mail to ngpy-unsubscribe@librelist.com and reply to the confirmation mail.
+
 Links
 `````
 
 * `Website <http://liuyxpp.bitbucket.org>`_
+
 * `Development version <http://bitbucket.org/liuyxpp/ngpy/>`_
-
 '''
 try:
     from setuptools import setup
 
 setup(
     name='ngpy',
-    version='0.1',
+    version='0.3',
     license='BSD',
     description='Web application for Monte Carlo simulation on nucleation and growth phenomena',
     author='Yi-Xin Liu',
     author_email='liuyxpp@gmail.com',
     url='https://bitbucket.org/liuyxpp/ngpy',
     packages=['ngpy'],
-    scripts=['run-ngpy','simd'],
+    scripts=['run-ngpy','simd','manage-ngpy'],
     include_package_data=True,
     zip_safe=False,
     long_description=__doc__,
         'redis>=2.4.9',
     ],
     classifiers=[
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 2 - Beta',
         'Environment :: Web Environment',
         'Intended Audience :: Science/Research',
         'Intended Audience :: Developers',