Merge pull request #351 from bennibbelink/site-changes

Add Docker Installation instructions

source/kernel/build_from_source.rst

@@ -32,7 +32,7 @@ Supported Systems
 
 Currently, two specific systems are supported:
 
-  * Linux 64-bit (Ubuntu 12+ recommended)
+  * Linux 64-bit (Ubuntu 20+ recommended)
   * MacOSX 8 64-bit
 
 Unfamiliar with git and Github?
@@ -60,7 +60,7 @@ Help with git and GitHub
 
 If you are unfamiliar with git, here are some resources:
 
-  * http://progit.org/book/ - this is a fantastic guide, from beginner to expert
+  * https://git-scm.com/book/en/v2 - this is a fantastic guide, from beginner to expert
   * http://book.git-scm.com/
   * http://gitimmersion.com/ - A very hands-on tutorial.
   * http://www-cs-students.stanford.edu/~blynn/gitmagic/
@@ -70,11 +70,11 @@ If you are unfamiliar with GitHub, here are some resources:
   * `Github Help`_
 
   * To have your changes integrated into the cyclus/cyclus project, you must
-    submit a GitHub *Pull Request*.  Visit `Send pull requests`_ to learn more.
+    submit a GitHub *Pull Request*.  Visit `Pull requests documentation`_ to learn more.
 
 .. _`Github Help`: http://help.github.com
 
-.. _`Send pull requests`: http://help.github.com/send-pull-requests/
+.. _`Pull requests documentation`: https://docs.github.com/en/pull-requests
 
 Contact Us
 ----------

source/user/dbdoc.rst

@@ -14,9 +14,9 @@ the same.  |Cyclus| ships supporting two database formats:
 * `SQLite <http://sqlite.org/index.html>`_ (".sqlite" extension) - |cyclus|'
   default database format. Some useful viewers:
 
-    - `Sqliteman <http://sqliteman.com/>`_ (windows and linux)
+    - `Sqliteman <https://sqliteman.dev>`_ (windows and linux)
     - `SQLite Browser <http://sqlitebrowser.org/>`_ (windows, mac, and linux)
-    - `SQLite Manager <https://addons.mozilla.org/en-US/firefox/addon/sqlite-manager/>`_
+    - `SQLite Manager <https://addons.mozilla.org/en-US/firefox/addon/sqlite-manager-webext/>`_
       Firefox Add-on (windows, mac, and linux)
 
 * `HDF5 <http://www.hdfgroup.org/HDF5/>`_ (".h5" extension). Some useful

source/user/install.rst

@@ -29,18 +29,12 @@ will identify the best approach for you.
   - *Requires familiarity with Linux*
   - **Recommended** for users wanting to **run simulations locally**  (without internet)
 
-* :doc:`Virtualbox <virtualbox>`:
-
-  - *Requires familiarity with Linux*
-  - **Required for Windows users**
-
-
 * :doc:`Install Stable From Source (via Tarball) <install_from_tarball>`:
 
   - *Requires programming skills/familiarity with compiling code*
   - **Recommended** for users wanting to **modify existing archetypes** or **write new archetypes** (aka developers)
 
-* :doc:`Install Develop from Source (via Repository) <install_from_git>`:
+* :doc:`Install Main from Source (via Repository) <install_from_git>`:
 
   - *Requires programming skills/familiarity with compiling code, basic understanding of Git/GitHub*
   - **Recommended** for developers or users who **require the bleeding edge version** of |Cyclus|
@@ -51,10 +45,10 @@ will identify the best approach for you.
     :maxdepth: 1
 
     install_binary
+    install_docker
     install_custom
     install_from_git
     install_from_tarball
-    virtualbox
 
 
 2. Run Cyclus with a Sample XML File

source/user/install_binary.rst

@@ -32,22 +32,20 @@ Installing |Cyclus| with Binaries
    :start-after: .. website_include_deb_start
    :end-before: .. website_include_deb_end
 
-#. Download the Cycamore Debian installation package corresponding to your Ubuntu version (`14.04
-   <http://dory.fuelcycle.org:4848/ubuntu/14.04/cycamore_latest.deb>`_ or
-   `16.04
-   <http://dory.fuelcycle.org:4848/ubuntu/16.04/cycamore_latest.deb>`_). You can
-   download previous/different version `here <http://dory.fuelcycle.org:4848/ubuntu/>`_.
+#. Download the latest Cycamore Debian installation package `here
+   <https://github.com/cyclus/cycamore/releases/latest>`_. You can
+   download previous/different version `here <https://github.com/cyclus/cycamore/releases>`_.
 
 #. Install the package by running:
 
    .. code-block:: bash
 
-      $ sudo dpkg -i cycamore_latest.deb
+      $ sudo dpkg -i cycamore-x.x.x-Linux.deb
 
 #. .. include::  unit_test.rst
 
 Happy simulating!
 
-.. _Anaconda: https://www.continuum.io/downloads
+.. _Anaconda: https://www.anaconda.com/download
 .. _miniconda: http://conda.pydata.org/miniconda.html
 .. _`dependency installation documentation`: DEPENDENCIES.html

source/user/install_docker.rst

@@ -0,0 +1,80 @@
+#################################
+Installing |Cyclus| with Docker
+#################################
+
+|Cyclus| maintains six container images with |Cyclus| (and its dependencies) pre-installed:
+
+.. list-table:: 
+   :header-rows: 1
+
+   * - Base OS
+     - Package Manager
+     - Image
+   * - Ubuntu 20.04
+     - ``apt``
+     - ``ghcr.io/cyclus/cyclus_20.04_apt/cyclus``
+   * - Ubuntu 20.04
+     - ``conda``
+     - ``ghcr.io/cyclus/cyclus_20.04_conda/cyclus``
+   * - Ubuntu 22.04
+     - ``apt``
+     - ``ghcr.io/cyclus/cyclus_22.04_apt/cyclus``
+   * - Ubuntu 22.04
+     - ``conda``
+     - ``ghcr.io/cyclus/cyclus_22.04_conda/cyclus``
+   * - Rocky Linux 8
+     - ``dnf``
+     - ``ghcr.io/cyclus/cyclus_rocky_8/cyclus``
+   * - Rocky Linux 9
+     - ``dnf``
+     - ``ghcr.io/cyclus/cyclus_rocky_9/cyclus``
+
+These images are updated via GitHub actions and have the following supported tags:
+    * ``stable`` - the last stable release
+    * ``<version number>`` - version number corresponds to past release
+    * ``latest`` - up to date with the ``main`` branch
+
+You can download and run a container image interactively using:
+
+   .. code-block:: bash
+
+      $ docker run -it ghcr.io/cyclus/cyclus_22.04_apt/cyclus:stable
+
+This will provide you with an environment that has |Cyclus| ready for you to use.  To 
+access files on your machine from within the container try using a volume (``-v <your local directory>:<container destination directory>``).
+
+If you are unfamiliar with Docker below are some good resources for getting started:
+  - `Docker 101 Tutorial <https://www.docker.com/101-tutorial/>`_
+  - `Docker CLI reference <https://docs.docker.com/reference/cli/docker/>`_
+
+If you wish to run |Cyclus| with Cycamore pre-installed the following images are supported:
+
+.. list-table:: 
+   :header-rows: 1
+
+   * - Base OS
+     - Package Manager
+     - Image
+   * - Ubuntu 20.04
+     - ``apt``
+     - ``ghcr.io/cyclus/cycamore_20.04_apt/cycamore``
+   * - Ubuntu 20.04
+     - ``conda``
+     - ``ghcr.io/cyclus/cycamore_20.04_conda/cycamore``
+   * - Ubuntu 22.04
+     - ``apt``
+     - ``ghcr.io/cyclus/cycamore_22.04_apt/cycamore``
+   * - Ubuntu 22.04
+     - ``conda``
+     - ``ghcr.io/cyclus/cycamore_22.04_conda/cycamore``
+
+These images are also updated via GitHub actions and have the following supported tags:
+    * ``stable`` - the last stable release
+    * ``<version number>`` - version number corresponds to past release
+    * ``latest`` - up to date with the ``main`` branch
+
+You can explore all supported images in the |Cyclus| `container registry <https://github.com/orgs/cyclus/packages>`_.
+
+Happy simulating!
+
+.. _`docker run documentation`: https://docs.docker.com/reference/cli/docker/container/run/

source/user/install_from_tarball.rst

@@ -32,8 +32,7 @@ Get the Tarball
 
 Download the most recent stable version of Cyclus source (either .zip or .gz):
 
-- `cyclus-1.5.5.zip  <https://github.com/cyclus/cyclus/archive/1.5.5.zip>`_
-- `cyclus-1.5.5.tar.gz  <https://github.com/cyclus/cyclus/archive/1.5.5.tar.gz>`_
+- `Latest Cyclus release  <https://github.com/cyclus/cyclus/releases/latest>`_
 
 (`Previous versions of Cyclus <https://github.com/cyclus/cyclus/releases>`_ )
 
@@ -45,15 +44,6 @@ Compiling Cyclus
 
 If you were successful then Cyclus has been installed and you can skip down to Installing Cycamore!
 
-If you received an error message concerning the Cyclus Core Version, please use:
-
-.. code-block:: bash
-
-   python install.py --core-version=x.y.z
-
-Replace x.y.z with the Cyclus version number you are installing.
-
-
 Alternative instructions are also available for doing a :doc:`Custom Installation <install_custom>`.
 
 
@@ -66,8 +56,7 @@ Get the Tarball
 
 Download the most recent stable version of Cycamore source (either .zip or .gz):
 
-- `cycamore-1.5.5.zip  <https://github.com/cyclus/cycamore/archive/1.5.5.zip>`_
-- `cycamore-1.5.5.tar.gz  <https://github.com/cyclus/cycamore/archive/1.5.5.tar.gz>`_
+- `Latest Cycamore release  <https://github.com/cyclus/cycamore/releases/latest>`_
 
 (`Previous versions of Cycamore <https://github.com/cyclus/cycamore/releases>`_ )