diff --git a/CHANGELOG.rst b/CHANGELOG.rst index c4b687b32f..22bb79a7ec 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -9,6 +9,8 @@ Since last release **Changed:** +* Changed README.rst installation instructions, tested on fresh Ubuntu-22.04 system with Python3.11 (#1744) + **Removed:** **Fixed:** diff --git a/README.rst b/README.rst index d067770dd3..7bd23d1570 100644 --- a/README.rst +++ b/README.rst @@ -78,38 +78,33 @@ Cyclus is built using ``CMake``. For detailed instructions on Cyclus dependencie Quick Cyclus Installation ************************* The quickest way to install Cyclus and its dependencies relies on using the `conda-forge` channel and the `conda` package manager within the Anaconda python environment. The following instructions guide you through that approach. -To install Cyclus and its dependencies onto a clean Ubuntu machine (tested on 18.04 LTS): +To install Cyclus and its dependencies onto a clean Ubuntu machine (tested on 22.04 LTS): -- Download the latest Anaconda installer for Linux at - ``https://www.anaconda.com/distribution/#download-section`` +- Download and install Miniconda for Linux -- Move the ``.sh`` to your Home directory -- In Terminal, execute the following commands: - -- ``bash Anaconda3-2019.03-Linux-x86_64.sh`` - -- ``echo 'export PATH="~/anaconda/bin:$PATH"' >> ~/.bashrc`` - -- ``source .bashrc`` - -- ``conda config --add channels conda-forge`` - -- ``conda create -n cyclus python=3.11`` +.. code-block:: bash -- ``conda activate cyclus`` + mkdir -p ~/miniconda3 + wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh + bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3 + rm -rf ~/miniconda3/miniconda.sh -- ``conda install -y gxx_linux-64 gcc_linux-64 cmake make git glib libxml2 libxmlpp-4.0 liblapack pkg-config coincbc boost-cpp hdf5 sqlite pcre setuptools pytest pytables pandas jinja2 cython websockets pprintpp pip`` +- Execute the following commands to initialize Miniconda: -- ``conda install -y --force-reinstall libsqlite`` +.. code-block:: bash -- Use ``sudo apt install`` to install and configure git + ~/miniconda3/bin/conda init bash + source ~/.bashrc -- Clone the Cyclus repository by running ``git clone https://github.com/cyclus/cyclus.git`` +- Create a new environment and install the Cyclus package -- Navigate to the folder containing Cyclus +.. code-block:: bash -- Run the command ``python install.py`` + conda config --add channels conda-forge + conda create -n cyclus + conda activate cyclus + conda install -y cyclus For more detailed installation procedure, and/or custom installation please refer to the `INSTALLATION guide `_. @@ -123,7 +118,7 @@ our tests). You can run the tests yourself via: .. code-block:: bash - $ cyclus_unit_tests + cyclus_unit_tests ******************* @@ -152,7 +147,7 @@ file ``input.xml``, you can run Cyclus via: .. code-block:: bash - $ cyclus path/to/input.xml + cyclus path/to/input.xml For a more detailed explanation, check out the `Cyclus User Guide`_.