Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tutorial #36

Merged
merged 4 commits into from
Feb 26, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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