Skip to content

Commit

Permalink
New Conda Install Instructions (cyclus#204)
Browse files Browse the repository at this point in the history
OK merging. thx @scopatz !!

I maybe be add that in the rework we are doing.
I was thinking having the unit_test workings might be a good way to ensure the proper installation of cyclus/cycamore...
  • Loading branch information
scopatz authored and Baaaaam committed Sep 2, 2016
1 parent 37f2d6a commit a9adeaa
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 49 deletions.
9 changes: 1 addition & 8 deletions source/user/condarc
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# This is a sample .condarc file

# channel locations. These override conda defaults, i.e., conda will
# search *only* the channels listed here, in the order given. Use "defaults" to
# automatically include all default channels. Non-url channels will be
# interpreted as binstar usernames (this can be changed by modifying the
# channel_alias key; see below).
channels:
- https://conda.binstar.org/cyclus
- conda-forge
- defaults

61 changes: 20 additions & 41 deletions source/user/install.rst
Original file line number Diff line number Diff line change
@@ -1,91 +1,70 @@
Installing |Cyclus| with Conda
==============================
Conda is a cross platform, user space package manager aimed at simplifying the
installation of open source software. The |cyclus| project uses conda to distribute
Conda is a cross platform, user space package manager aimed at simplifying the
installation of open source software. The |cyclus| project uses conda to distribute
pre-built cyclus and cycamore binaries.

Fresh Install
-------------
If you are new to conda or do not have conda already installed on your system,
If you are new to conda or do not have conda already installed on your system,
please follow these steps to install |cyclus|.
Basic installation instructions for Conda can be found
`here <http://docs.continuum.io/anaconda/install.html>`_.
Basic installation instructions for Conda can be found
`here <http://docs.continuum.io/anaconda/install.html>`_.

1. Download and Install Miniconda

* Go to the `miniconda downloads page <http://conda.pydata.org/miniconda.html>`_
and get the version approriate to your system.
* Install this to the ``~/miniconda`` directory. For example, you would
* Install this to the ``~/miniconda`` directory. For example, you would
use a command similar the following:

.. code-block:: bash
.. code-block:: bash
$ bash Miniconda-3.5.2-Linux-x86_64.sh -b -p ~/miniconda
$ bash Miniconda-Latest-Linux-x86_64.sh -b -p ~/miniconda
* Finally, add the ``~/miniconda/bin`` directory to your ``PATH`` either
* Finally, add the ``~/miniconda/bin`` directory to your ``PATH`` either
in your current environment or in your ``.bashrc`` or both.

.. code-block:: bash
.. code-block:: bash
$ export PATH="${HOME}/miniconda/bin:${PATH}"
2. Configure conda to look for |cyclus|

* Download this :download:`condarc` file and save it as ``~/.condarc``. If
* Download this :download:`condarc` file and save it as ``~/.condarc``. If
you'd prefer to do this from the command line, type:

.. code-block:: bash
.. code-block:: bash
$ curl -L http://fuelcycle.org/_downloads/condarc >> ~/.condarc
3. Install |Cyclus| and Cycamore

* Now that conda is installed and ready, installing |Cyclus| is as simple as:

.. code-block:: bash
$ conda install cycamore --yes
.. code-block:: bash
Note that installing cycamore will also install cyclus since cyclus is one
of cycamore's dependencies.
$ conda install --yes cyclus cycamore
4. Install Cyclist (optional)

* Now that cyclus is installed and ready, installing the graphical user interface is
simple as:

.. code-block:: bash
$ conda install cyclist --yes
And that is it!
And that is it!

Already Have Conda?
-------------------
If you already have conda installed, installing |Cyclus| is even easier.
You simply need to make sure that the |Cyclus| binstar organization is part of
You simply need to make sure that conda-forge is part of
your channels. Please edit the ``channels`` section of your :file:`~/.condarc`
to include the URL ``https://conda.binstar.org/cyclus``. For example,
to include the ``conda-forge`` channel. For example,

.. code-block:: yaml
channels:
- https://conda.binstar.org/cyclus
- conda-forge
- defaults
Once this is done, install |Cyclus| with the following comand.

.. code-block:: bash
$ conda install cycamore --yes
Note that installing cycamore will also install cyclus since cyclus is one
of cycamore's dependencies. Furthermore, you may also optionally install Cyclist,
the graphical user interface tool for cyclus databases. This can be done
with the following:
.. code-block:: bash
.. code-block:: bash
$ conda install cyclist --yes
$ conda install --yes cyclus cycamore
Happy simulating!

0 comments on commit a9adeaa

Please sign in to comment.