Skip to content
Browse files

some updated docs

  • Loading branch information...
1 parent 3904584 commit 7553b265f5b10aac3d09de18d0614ae30a0a0ca5 @computron computron committed
Showing with 63 additions and 27 deletions.
  1. +1 −0 CHANGES.txt
  2. +0 −23 README.md
  3. +58 −0 README.txt
  4. +2 −0 fireworks/utilities/fw_serializers.py
  5. +2 −4 setup.py
View
1 CHANGES.txt
@@ -0,0 +1 @@
+v1.0dev, January 9, 2013 -- Initial release.
View
23 README.md
@@ -1,23 +0,0 @@
-# FireWorks
-
-The FireWorks Workflow Management Repo.
-
-# Installation and tests
-* Use pip-install
-* run python setup.py nosetests
-
-# Setup on clusters
-1. Create a subclass of QueueAdapter that handles queue issues
-- an example is PBSAdapterNersc
-
-2. Create an appropriate JobParameters file for your cluster
-- an example is provided.
-
-3. Try running rocket_launcher.py on your cluster with a test job config. See if it prints 'howdy, you won' or whatever.
-
-4. Try changing the executable to be the Rocket. See if it grabs a job properly...
-
-# Dependencies
-
-1. PyYAML
- * reading/writing cluster parameters files
View
58 README.txt
@@ -0,0 +1,58 @@
+=============================
+FireWorks workflow management
+=============================
+
+FireWorks allows you to define calculation workflows and execute them on remote
+computers, usually through a queueing system. Workflows are stored in a centralized
+database, and jobs are pulled from the database by registered computers.
+
+
+Features
+========
+
+Unique features of FireWorks include:
+
+* Dynamic workflows that react to results programmatically. A job can be automatically restarted, modified, or cancelled in case of error or other condition. Entire workflows can be changed automatically based on calculation results.
+
+* Distribute calculations over multiple computing resources simultaneously.
+
+* Automated duplicate workflow detection
+
+* Plug-and-play on several large supercomputing clusters and queueing systems (future)
+
+* Web-based monitoring of workflows (future)
+
+Limitations
+===========
+
+FireWorks is intended for applications where realtime performance of the workflow software is not
+a big issue. For example, if you require steps in a workflow to execute within a few seconds of one another,
+FireWorks might not be for you. In addition, FireWorks is a centralized workflow system.
+
+Contributing
+============
+*TODO: add description*
+
+Technical Issues
+================
+Installation
+------------
+
+* Use pip-install
+* run python setup.py nosetests
+
+
+Setup on clusters / Tutorial (Future)
+-------------------------------------
+
+*TODO: link to another page...*
+
+*TODO: add proper docs*
+
+1. Create a subclass of QueueAdapter that handles queue issues - an example is PBSAdapterNersc
+
+2. Create an appropriate JobParameters file for your cluster - an example is provided.
+
+3. Try running rocket_launcher.py on your cluster with a test job config. See if it prints 'howdy, you won' or whatever.
+
+4. Try changing the executable to be the Rocket. See if it grabs a job properly...
View
2 fireworks/utilities/fw_serializers.py
@@ -32,6 +32,8 @@
import json
import importlib
+# TODO: remember the module and class of objects so you don't need to search through all the user packages
+# every single time...
__author__ = 'Anubhav Jain'
__copyright__ = 'Copyright 2012, The Materials Project'
View
6 setup.py
@@ -15,15 +15,13 @@
def readme():
- # TODO: make an actual README.md
- with open('README.md') as f:
+ with open('README.txt') as f:
return f.read()
setup(name='FireWorks',
version='0.1dev',
- # TODO: better descriptions
description='FireWorks workflow software',
- long_description='FireWorks workflow software.',
+ long_description=open('README.txt').read(),
# TODO: PyPI link?
url='https://github.com/materialsproject/fireworks',

0 comments on commit 7553b26

Please sign in to comment.
Something went wrong with that request. Please try again.