Merge branch 'main' into add_gray_box_do_counting

IDAES · Nov 22, 2024 · fe052f3 · fe052f3
2 parents 5ce566e + 5841433
commit fe052f3
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 18 deletions.
diff --git a/.github/workflows/core.yml b/.github/workflows/core.yml
@@ -109,6 +109,7 @@ jobs:
         with:
           activate-environment: ${{ env.IDAES_CONDA_ENV_NAME_DEV }}
           python-version: ${{ matrix.python-version }}
+          miniforge-version: latest
       - name: Set up idaes
         uses: ./.github/actions/setup-idaes
         with:
@@ -167,6 +168,7 @@ jobs:
         with:
           activate-environment: ${{ env.IDAES_CONDA_ENV_NAME_DEV }}
           python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+          miniforge-version: latest
       - name: Set up idaes
         uses: ./.github/actions/setup-idaes
         with:
@@ -201,6 +203,7 @@ jobs:
         with:
           activate-environment: ${{ env.IDAES_CONDA_ENV_NAME_DEV }}
           python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+          miniforge-version: latest
       - name: Set up idaes
         uses: ./.github/actions/setup-idaes
         with:
@@ -233,6 +236,7 @@ jobs:
         with:
           activate-environment: ${{ env.IDAES_CONDA_ENV_NAME_DEV }}
           python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+          miniforge-version: latest
       - name: Set up idaes
         uses: ./.github/actions/setup-idaes
         with:

diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -149,6 +149,7 @@ jobs:
         with:
           activate-environment: ${{ env.IDAES_CONDA_ENV_NAME_DEV }}
           python-version: ${{ matrix.python-version }}
+          miniforge-version: latest
       - name: Set up idaes
         uses: ./.github/actions/setup-idaes
         with:
@@ -186,6 +187,7 @@ jobs:
         with:
           activate-environment: ${{ env.IDAES_CONDA_ENV_NAME_DEV }}
           python-version: ${{ matrix.python-version }}
+          miniforge-version: latest
       - name: Set up idaes
         uses: ./.github/actions/setup-idaes
         with:
@@ -239,6 +241,7 @@ jobs:
         with:
           activate-environment: idaes-env
           python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+          miniforge-version: latest
       - name: Set up idaes (non-editable installation)
         uses: ./.github/actions/setup-idaes
         with:

diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ scale-up, operation and troubleshooting of innovative, advanced energy systems.
 
 Our [complete documentation is online](https://idaes-pse.readthedocs.io/en/stable/) but here is a summarized set of steps to get started using the framework. For help and assistance, please visit the [IDAES PSE Discussions Board](https://github.com/IDAES/idaes-pse/discussions).
 
-While not required, we encourage the installation of [Anaconda](https://www.anaconda.com/products/individual#Downloads) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html) and using the `conda` command to create a separate python environment in which to install the IDAES Toolkit.
+While not required, we encourage the installation of [Miniforge](https://conda-forge.org/miniforge/) with which you can use the `conda` command to create a separate python environment in which to install the IDAES Toolkit.
 
 Use conda to create a new "idaes-pse" (could be any name you like) environment then activate that environment:
 ```bash

diff --git a/docs/reference_guides/developer/devsw.rst b/docs/reference_guides/developer/devsw.rst
@@ -145,18 +145,18 @@ Once you have the repo cloned, you can change into that directory (by default, i
 will be called "idaes-dev" like the repo) and install the Python packages.
 
 But before you do that, you need to get the Python package manager fully up and
-running. We use a Python packaging system called Conda_.
-Below are instructions for installing a minimal version of Conda, called Miniconda_.
+running. We use a Python packaging system called Miniforge_.
+Below are the instructions for installing the package manager -- which is a community driven and minimal version of Conda.
 The full version installs a large number of scientific analysis and visualization libraries
 that are not required by the IDAES framework.
 
 .. _Conda: https://conda.io/
-.. _Miniconda: https://conda.io/en/latest/miniconda.html
+.. _Miniforge: https://conda-forge.org/miniforge/
 
 .. code-block:: sh
 
-    wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
-    bash Miniconda3-latest-Linux-x86_64.sh
+    wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh
+    bash Miniforge3-Linux-x86_64.sh
 
 Create and activate a conda environment (along with its own copy of ``pip``)
 for the new IDAES installation **(you will need to** ``conda activate idaes``

diff --git a/docs/tutorials/advanced_install/index.rst b/docs/tutorials/advanced_install/index.rst
@@ -71,12 +71,12 @@ Create the Python Environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Once you have the repo cloned, you can change into that directory (by default, it will be called "idaes-pse" like the repo) and install the Python packages.
 
-But before you do that, you need to get the Python package manager fully up and running. We use a Python packaging system called Conda_ and we specifically use its minimal version Miniconda_. If you do not already have Conda, please follow the installation instructions for your operating system in :ref:`getting started<tutorials/getting_started/index:Getting Started>`.
+But before you do that, you need to get the Python package manager fully up and running. We use a Python packaging system called Conda_ and we specifically use a community driven minimal version Miniforge_. If you do not already have Miniforge, please follow the installation instructions for your operating system in :ref:`getting started<tutorials/getting_started/index:Getting Started>`.
 
 .. _Conda: https://conda.io/
-.. _Miniconda: https://conda.io/en/latest/miniconda.html
+.. _Miniforge: https://conda-forge.org/miniforge/
 
-After Miniconda is installed, we recommend creating a separate conda environment for IDAES. If you are unfamiliar with environments, a good starting guide is `here <https://towardsdatascience.com/getting-started-with-python-environments-using-conda-32e9f2779307>`__. Create and activate a conda environment for the new IDAES installation with the following commands (we officially support python |python-min| through |python-max|, with |python-default| as a default):
+After Miniforge is installed, we recommend creating a separate conda environment for IDAES. If you are unfamiliar with environments, a good starting guide is `here <https://towardsdatascience.com/getting-started-with-python-environments-using-conda-32e9f2779307>`__. Create and activate a conda environment for the new IDAES installation with the following commands (we officially support python |python-min| through |python-max|, with |python-default| as a default):
 
 .. code-block:: sh
 

diff --git a/docs/tutorials/getting_started/index.rst b/docs/tutorials/getting_started/index.rst
@@ -8,7 +8,7 @@ Getting Started
 Installation
 ------------
 To install the IDAES PSE framework, follow the set of instructions below that are appropriate for 
-your needs. The OS specific instructions provide optional steps for installing Miniconda, which can be 
+your needs. The OS specific instructions provide optional steps for installing Miniforge, which can be 
 skipped. If you are an IDAES developer or expect to change IDAES code, we recommend following the
 :ref:`advanced user installation<tutorials/advanced_install/index:Advanced User Installation>`.
 Please contact `[email protected] <[email protected]>`_, if you have difficulty installing 

diff --git a/docs/tutorials/getting_started/linux.rst b/docs/tutorials/getting_started/linux.rst
@@ -29,11 +29,14 @@ To get IDAES fully set up on your machine, we'll go through the steps to get ida
 Install Prerequisites
 ^^^^^^^^^^^^^^^^^^^^^
 
-**Install  Miniconda**
+**Install  Miniforge**
 
-1. Download `Miniconda <https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh>`_
+1. Download `Miniforge <https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh>`_
 2. Open a terminal window & run the downloaded script.
 
+** If you are running Arm64 or Power8/9 architecture, make sure you pull the applicable installer from the link below **
+https://github.com/conda-forge/miniforge/releases
+
 **Install Dependencies**
 
 1. The IPOPT solver depends on the GNU FORTRAN, GOMP, Blas, and Lapack libraries.

diff --git a/docs/tutorials/getting_started/mac_osx.rst b/docs/tutorials/getting_started/mac_osx.rst
@@ -34,11 +34,11 @@ To get IDAES fully set up on your machine, we'll go through the steps to get ida
 Install Prerequisites
 ^^^^^^^^^^^^^^^^^^^^^
 
-**Install  Miniconda**
-
-1. Download `Miniconda <https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh>`_
+**Install  Miniforge**
+1. Download `Miniforge <https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-arm64.sh>`_
 2. Open a terminal window & run the downloaded script.
 
+
 Install IDAES-PSE
 ^^^^^^^^^^^^^^^^^^
 

diff --git a/docs/tutorials/getting_started/windows.rst b/docs/tutorials/getting_started/windows.rst
@@ -29,10 +29,10 @@ To get IDAES fully set up on your machine, we'll go through the steps to get ida
 Install Prerequisites
 ^^^^^^^^^^^^^^^^^^^^^
 
-**Install Miniconda**
+**Install Miniforge**
 
-1. Download & install `Miniconda <https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe>`_.
-2. Install anaconda from the downloaded & open the Anaconda Prompt (Start -> "Anaconda Prompt").
+1. Download & install `Miniforge <https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe>`_.
+2. Install miniforge from the downloaded executable
 
 Install IDAES-PSE
 ^^^^^^^^^^^^^^^^^^