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

Update README conda installation instructions #1744

Merged
merged 7 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
Expand Down
43 changes: 19 additions & 24 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <INSTALL.rst>`_.
Expand All @@ -123,7 +118,7 @@ our tests). You can run the tests yourself via:

.. code-block:: bash

$ cyclus_unit_tests
cyclus_unit_tests


*******************
Expand Down Expand Up @@ -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`_.

Expand Down
Loading