Skip to content

Commit 7e00efb

Browse files
committed
Add section on installing IDAES using Conda to installation docs (#234)
(cherry picked from commit a5327b8)
1 parent ccee0f2 commit 7e00efb

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

Diff for: docs/getting_started/index.rst

+31
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,37 @@ Powershell Prompt. Regardless of OS and shell, the following steps are the same
179179
output. You can report problems on the |github-issues|
180180
(Please try to be specific about the command and the offending output.)
181181

182+
**Install IDAES using Conda**
183+
184+
As an alternative to the ``pip install`` method described above, IDAES can also be installed using the Conda package manager.
185+
186+
1. Create a new Conda environment with a name of your choice (in this example, ``my-idaes-env``)::
187+
188+
conda create --yes --name my-idaes-env python=3.8
189+
190+
..
191+
192+
.. note:: The ``--yes`` optional flag can be used to perform the installation without having it pausing to ask for confirmation.
193+
194+
2. Activate the ``my-idaes-env`` Conda environment::
195+
196+
conda activate my-idaes-env
197+
198+
..
199+
200+
.. note:: This step is needed when starting a new session or a new console tab/window.
201+
202+
3. Install the IDAES Conda package using the ``conda install`` subcommand::
203+
204+
conda install --yes -c IDAES-PSE -c conda-forge idaes-pse
205+
206+
..
207+
208+
.. note:: The most recent stable release will be selected by default.
209+
To instead select a particular version, specify the version tag using an ``=`` after the package name, e.g. ``idaes-pse=1.9.0rc0``.
210+
211+
4. To complete the installation, follow the instructions described in the previous section from Step 2 ("Run the ``idaes get-extensions`` command...") onward.
212+
182213
Optional Dependencies
183214
---------------------
184215
Some tools in IDAES may require additional dependencies. Instructions for installing these dependencies

0 commit comments

Comments
 (0)