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.

Sign up for GitHub

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

Jump to bottom

Add idaes-extensions step to getting started for devs #1129

Merged
merged 4 commits into from
Sep 13, 2023
Merged

Add idaes-extensions step to getting started for devs #1129

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
332cc4f
revise readthedocs getting started
adam-a-a Sep 11, 2023
74c46b5
empty commit to check editor
adam-a-a Sep 11, 2023
f4a6736
finish revisions
adam-a-a Sep 11, 2023
7c9b3f6
Merge branch 'main' into rtd_idaes_ext
adam-a-a Sep 13, 2023
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
8 changes: 7 additions & 1 deletion docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,14 @@ Install WaterTAP and the development dependencies using ``pip`` and the ``requir

pip install -r requirements-dev.txt

If needed, follow the steps described above to install solvers distributed through IDAES Extensions.
If needed, or if this is your first time installing IDAES or WaterTAP on your machine, run the following line from the same environment where WaterTAP was installed.

.. code-block:: shell

idaes get-extensions

.. note:: Typically, the ``idaes get-extensions`` command only needs to be run once for each system, as it will install the required files into a common, system-wide location. Depending on your operating system, you may need to follow additional steps described above to install solvers distributed through IDAES Extensions.

(Optional but recommended) `Pre-commit hooks <https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks>`_ are scripts that are automatically run by Git "client-side" (i.e. on a developer's local machine) whenever `git commit` is run. WaterTAP uses the `pre-commit <https://pre-commit.com/>`_ framework to manage a few hooks that are useful for WaterTAP developers. To install the WaterTAP pre-commit hooks, run:

.. code-block:: shell
Expand Down
Loading