Merge branch 'v1.4.0-release'

CMakeLists.txt

@@ -31,6 +31,11 @@ SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-overflow")
 # Find and use dependencues
 #
 
+# Find Cyclus, it is kind of a big deal
+find_package(Cyclus REQUIRED)
+SET(CYMETRIC_INCLUDE_DIR ${CYMETRIC_INCLUDE_DIR} ${CYCLUS_CORE_INCLUDE_DIR})
+SET(LIBS ${LIBS} ${CYCLUS_CORE_LIBRARIES})
+
 # Use new Python library finder
 find_package(PythonInterp REQUIRED)
 find_package(PythonLibsNew REQUIRED)
@@ -79,11 +84,6 @@ FIND_PACKAGE(COIN REQUIRED)
 SET(CYMETRIC_INCLUDE_DIR ${CYMETRIC_INCLUDE_DIR} ${COIN_INCLUDE_DIRS})
 set(LIBS ${LIBS} ${COIN_LIBRARIES})
 
-# Find Cyclus, it is kind of a big deal
-find_package(Cyclus REQUIRED)
-SET(CYMETRIC_INCLUDE_DIR ${CYMETRIC_INCLUDE_DIR} ${CYCLUS_CORE_INCLUDE_DIR})
-SET(LIBS ${LIBS} ${CYCLUS_CORE_LIBRARIES})
-
 # Include the accumlated directory
 INCLUDE_DIRECTORIES(${CYMETRIC_INCLUDE_DIR})
 

Dockerfile

@@ -0,0 +1 @@
+docker/cymetric-ci/Dockerfile

README.rst

@@ -1,8 +1,82 @@
-This repository holds scripts to analyze cyclus' output and to convert it into
+This repository holds scripts to analyze Cyclus' output and to convert it into
 nuclear fuel cycle metrics.
-The nuclear data is acquired through `PyNE`_.
 
-A tutorial (including installation instructions) and the API doucmentation can be found on `fuelcycle.org`_.
+Installing Cymetric
+----------------
+
+Cymetric is available on the same platforms as Cyclus: Ubuntu and Max OS.
+
+Dependencies
+~~~~~~~~~~~~
+First, please check to make sure you have all of the dependencies. 
+
+Required dependencies:
+
+* Cyclus and its dependencies
+* `Jinja2 <http://jinja.pocoo.org/docs/dev/>`_
+* `pandas <http://pandas.pydata.org/>`_
+* `NumPy <http://www.numpy.org/>`_
+* `matplotlib <http://matplotlib.org/index.html>`_ and matplotlib.pyplot
+
+Optional dependencies:
+
+* `PyNE`_ and its dependencies
+
+PyNE is what the Cyclus project uses for its nuclear data, and many metrics
+in cymetric depend on it. 
+
+Building from Source
+~~~~~~~~~~~~~~~~~~~~
+
+Cymetric can be built from source by first downloading the code by cloning the
+GitHub repository:
+
+.. code-block:: bash
+
+    $ git clone https://github.com/cyclus/cymetric
+
+Then build and install:
+
+.. code-block:: bash
+
+    $ cd cymetric
+    $ python setup.py install --user
+
+Next, run the tests to ensure everything is working properly:
+
+.. code-block:: bash
+
+    $ nosetests -w tests/
+
+Installation via Binary
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The latest released version of Cymetric is available via Conda. After obtaining
+miniconda by following steps 1 and 2 `here`_, Cymetric can be installed by the
+following command:
+
+.. code-block:: bash
+
+    $ conda install cymetric --yes
+
+Using Cymetric
+--------------
+
+Tutorial
+~~~~~~~~
+
+The tutorial and the API doucmentation can be found on `fuelcycle.org`_ in the
+`User Guide`_.
+
+Use-case Examples
+~~~~~~~~~~~~~~~~~
+
+See the examples directory within the main cymetric directory to review an
+example of how an analysis may be carried out using cymetric's capabilities.
+
+
 
 .. _`PyNE`: http://github.com/pyne/pyne
-.. _`fuelcycle.org`: http://fuelcycle.org/user/cymetric/index.html
+.. _`fuelcycle.org`: http://fuelcycle.org
+.. _`User Guide`: http://fuelcycle.org/user/index.html
+.. _`here`: http://fuelcycle.org/user/install.html 

circle.yml

@@ -0,0 +1,30 @@
+machine:
+  services:
+    - docker
+
+dependencies:
+  override:
+    - docker build -t cyclus/cymetric:latest .
+
+test:
+  override:
+    - docker run cyclus/cymetric:latest nosetests3 -w /cymetric/tests
+
+deployment:
+  develop:
+    branch: develop
+    commands:
+        - docker build -t cyclus/cymetric-deps:latest docker/cymetric-deps
+        - docker build -t cyclus/cymetric:latest .
+        - docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS
+        - docker push cyclus/cymetric-deps:latest
+        - docker push cyclus/cymetric:latest
+
+  master:
+    branch: master
+    commands:
+        - docker build -t cyclus/cymetric-deps:stable docker/cymetric-deps
+        - docker build -t cyclus/cymetric:stable .
+        - docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS
+        - docker push cyclus/cymetric-deps:stable
+        - docker push cyclus/cymetric:stable