Skip to content

Commit

Permalink
Merge pull request #36 from opotowsky/tutorial
Browse files Browse the repository at this point in the history
Tutorial
  • Loading branch information
scopatz committed Feb 26, 2015
2 parents c94fde4 + a62ae91 commit 71a7807
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,34 @@ automatically computed and evaluated.

Without further ado, let's dive in!

Getting Cymetric
----------------
Cymetric is an extension of |cyclus|, so it is assumed that |cyclus| is
already installed on your system. (If not, please visit here
for building it from source http://fuelcycle.org/kernel/build_from_source.html.)

Cymetric is available on the same platforms as |cyclus|: Ubuntu and Max OS.

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
Installation via Binary
~~~~~~~~~~~~~~~~~~~~~~~

Cymetric will soon be available to install via Conda.

Command Line Usage
------------------
Cymetric ships with a command line utility, just called ``cymetric``. Since
Expand Down

0 comments on commit 71a7807

Please sign in to comment.