Changed name from Python Cluster to Fyrd

Python Cluster is taken several times over, I wanted a more creative name. Fyrd is the Anglo-Saxon word for 'Army', plus it is just a great word, so I am going with that. As this is a large change, I am incrementing the version to beta.2. To do this I changed the release string to handle semantic versioning better. I rebuilt the documentation and altered the configuration to work with readthedocs.io.
MikeDacre · Oct 27, 2016 · b01ee43 · b01ee43
1 parent b061ee7
commit b01ee43
Show file tree

Hide file tree

Showing 24 changed files with 142 additions and 797 deletions.
diff --git a/Fyrd.pdf b/Fyrd.pdf
diff --git a/PythonCluster.pdf b/PythonCluster.pdf
diff --git a/README.rst b/README.rst
@@ -1,25 +1,33 @@
-##############
-Python Cluster
-##############
+####
+Fyrd
+####
 
-.. image:: https://travis-ci.org/MikeDacre/python-cluster.svg?branch=master
-
-Submit jobs to slurm or torque, or with multiprocessing.
+Submit jobs to compute clusters with slurm, torque, or simple multiprocessing.
 
 +---------+----------------------------------------------------+
 | Author  | Michael D Dacre <mike.dacre@gmail.com>             |
 +---------+----------------------------------------------------+
 | License | MIT License, property of Stanford, use as you wish |
 +---------+----------------------------------------------------+
-| Version | 0.6.1b                                             |
+| Version | 0.6.1-beta.2                                       |
 +---------+----------------------------------------------------+
 
+.. image:: https://travis-ci.org/MikeDacre/fyrd.svg?branch=master
+   :target: https://travis-ci.org/MikeDacre/python-cluster
+.. image:: https://api.codacy.com/project/badge/Grade/c163cff81a1941a18b2c5455901695a3
+   :target: https://www.codacy.com/app/mike-dacre/fyrd?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=MikeDacre/fyrd&amp;utm_campaign=Badge_Grade
+.. image:: https://readthedocs.org/projects/fyrd/badge/?version=latest
+   :target: https://fyrd.readthedocs.io/
+.. image:: https://img.shields.io/badge/python%20versions-2.7%203.4%203.5%203.6-brightgreen.svg
+
+Formerly known as 'Python Cluster'
+
 Allows simple job submission with *dependency tracking and queue waiting* with
 either torque, slurm, or locally with the multiprocessing module. It uses simple
 techiques to avoid overwhelming the queue and to catch bugs on the fly.
 
-For complete documentation see `the documentation site <https://mikedacre.github.io/python-cluster>`_
-and the `PythonCluster.pdf <PythonCluster.pdf>`_ document in this repository.
+For complete documentation see `the documentation site <https://fyrd.readthedocs.io>`_
+and the `Fyrd.pdf <Fyrd.pdf>`_ document in this repository.
 
 NOTE: This software is still in beta, the scripts in bin/ do not all function
 properly and the software has not been fully tested on slurm systems. Please
@@ -30,6 +38,10 @@ NOTE: While this software is extremely powerful for pure python-based cluster jo
 submission, `snakemake <https://bitbucket.org/snakemake/snakemake/wiki/Home>`_ is
 possibly a better choice for very large workflows.
 
+In the future this code will work with Makefiles and will be more robust, but it
+needs further development before that happens, for now it can just be used as a
+simple python submission library.
+
 .. contents:: **Contents**
 
 Installation
@@ -548,6 +560,13 @@ You can also wait for many jobs with the Queue class:
 The jobs in this case can be either a Job class or a job number.
 
 
+Why the Name?
+=============
+
+Fyrd is the old Anglo-Saxon word for 'army'. I am British, and this code
+gives you an army of workers on any machine so it works :-)
+
+
 Issues and Contributing
 =======================
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -7,7 +7,7 @@ SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = ../../docs
 PDFBUILDDIR   = /tmp
-PDF           = ../PythonCluster.pdf
+PDF           = ../Fyrd.pdf
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
@@ -48,7 +48,8 @@ help:
 
 .PHONY: clean
 clean:
-	rm -rf $(BUILDDIR)/*
+	rm -rf $(PDFBUILDDIR)/latex
+	rm ../Fyrd.pdf
 
 .PHONY: html
 html:

diff --git a/docs/_sources/api.txt b/docs/_sources/api.txt
diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt
diff --git a/docs/_sources/scripts.txt b/docs/_sources/scripts.txt