watertap-org · lbianchi-lbl · Nov 6, 2024 · Nov 6, 2024 · Nov 6, 2024 · Nov 6, 2024
diff --git a/docs/how_to_guides/how_to_use_ui_api.rst b/docs/how_to_guides/how_to_use_ui_api.rst
@@ -2,21 +2,21 @@
 
 Add a flowsheet to the UI
 ==========================
-.. py:currentmodule:: watertap.ui.fsapi
+.. py:currentmodule:: idaes_flowsheet_processor.api
 
 This API is intended for model developers who would like to connect their flowsheets to the UI.
 Developers can select which variables to "export" to the UI for each component of the model, 
 and provide extra metadata (display name, description) for them. For flowsheets, they should also 
 specify how to build and solve the flowsheets.
 
-For reference, see :class:`FlowsheetInterface` and :class:`FlowsheetExport` in the `watertap.ui.fsapi` module.
+For reference, see :class:`FlowsheetInterface` and :class:`FlowsheetExport` in the `idaes_flowsheet_processor.api` module.
 
 ----
 
 In some Python module, define the function ``export_to_ui``, which will look
 similar to this::
 
-    from watertap.ui.fsapi import FlowsheetInterface, FlowsheetCategory
+    from idaes_flowsheet_processor.api import FlowsheetInterface, FlowsheetCategory
     def export_to_ui():
         return FlowsheetInterface(
             name="NF-DSPM-DE",

diff --git a/docs/technical_reference/ui/index.rst b/docs/technical_reference/ui/index.rst
@@ -7,7 +7,7 @@ changes from the UI front-end.
 
 .. include:: <isonum.txt>
 
-.. py:currentmodule:: watertap.ui.fsapi
+.. py:currentmodule:: idaes_flowsheet_processor.api
 
 .. contents:: Contents
     :depth: 1

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,7 +1,16 @@
 black==24.3.0
 pre-commit
+
+# coverage
+pytest-cov
+
 # TODO pin exact version for pylint and astroid
 pylint<3
 astroid
-# Defer to setup.py contents
--e .[dev,notebooks,oli_api]
+
+# docs
+sphinx==7.1.*
+nbsphinx
+sphinx_rtd_theme
+
+-e .[testing,notebooks,oli_api]
diff --git a/setup.py b/setup.py
@@ -95,6 +95,7 @@
             # treebeardtech/nbmake#121
             "nbmake != 1.5.1",
             "nbconvert",
+            "idaes-flowsheet-processor @ git+https://github.com/watertap-org/idaes-flowsheet-processor@main",
         ],
         "notebooks": [
             "jupyter",
@@ -104,21 +105,6 @@
             "requests",
             "cryptography",  # for encrypting OLI credentials
         ],
-        "dev": [
-            "nbsphinx",  # jupyter notebook support for sphinx
-            "jinja2<3.1.0",  # see watertap-org/watertap#449
-            "Sphinx==7.1.*",  # docs
-            "sphinx_rtd_theme",  # docs
-            "urllib3 < 2",  # see watertap-org/watertap#1021,
-            # other requirements
-            "linkify-it-py",
-            "black",  # code formatting
-            # other requirements
-            "pytest",  # test framework
-            "pytest-cov",  # code coverage
-            # treebeardtech/nbmake#121
-            "nbmake != 1.5.1",
-        ],
     },
     package_data={  # Optional
         "": [

diff --git a/watertap/flowsheets/RO_with_energy_recovery/RO_with_energy_recovery_ui.py b/watertap/flowsheets/RO_with_energy_recovery/RO_with_energy_recovery_ui.py
@@ -10,7 +10,7 @@
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
 from watertap.core.solvers import get_solver
-from watertap.ui.fsapi import FlowsheetInterface
+from idaes_flowsheet_processor.api import FlowsheetInterface
 from watertap.flowsheets.RO_with_energy_recovery.RO_with_energy_recovery import (
     build,
     set_operating_conditions,

diff --git a/watertap/flowsheets/dye_desalination/dye_desalination_ui.py b/watertap/flowsheets/dye_desalination/dye_desalination_ui.py
@@ -9,7 +9,7 @@
 # information, respectively. These files are also available online at the URL
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
-from watertap.ui.fsapi import FlowsheetInterface
+from idaes_flowsheet_processor.api import FlowsheetInterface
 from watertap.core.util.initialization import assert_degrees_of_freedom
 from watertap.flowsheets.dye_desalination.dye_desalination import (
     build,

diff --git a/watertap/flowsheets/electrodialysis/electrodialysis_1stack_conc_recirc_ui.py b/watertap/flowsheets/electrodialysis/electrodialysis_1stack_conc_recirc_ui.py
@@ -10,7 +10,7 @@
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
 from watertap.core.solvers import get_solver
-from watertap.ui.fsapi import FlowsheetInterface
+from idaes_flowsheet_processor.api import FlowsheetInterface
 from watertap.flowsheets.electrodialysis.electrodialysis_1stack_conc_recirc import (
     build,
     _condition_base,

diff --git a/watertap/flowsheets/full_water_resource_recovery_facility/BSM2_P_extension_ui.py b/watertap/flowsheets/full_water_resource_recovery_facility/BSM2_P_extension_ui.py
@@ -17,7 +17,7 @@
 
 import idaes.logger as idaeslog
 
-from watertap.ui.fsapi import FlowsheetInterface
+from idaes_flowsheet_processor.api import FlowsheetInterface
 
 from watertap.flowsheets.full_water_resource_recovery_facility.BSM2_P_extension import (
     build,

diff --git a/watertap/flowsheets/full_water_resource_recovery_facility/BSM2_ui.py b/watertap/flowsheets/full_water_resource_recovery_facility/BSM2_ui.py
@@ -16,7 +16,7 @@
 from pyomo.environ import units as pyunits, assert_optimal_termination
 from pyomo.util.check_units import assert_units_consistent
 
-from watertap.ui.fsapi import FlowsheetInterface
+from idaes_flowsheet_processor.api import FlowsheetInterface
 
 from watertap.core.util.initialization import assert_degrees_of_freedom
 

diff --git a/watertap/flowsheets/gac/gac_ui.py b/watertap/flowsheets/gac/gac_ui.py
@@ -23,7 +23,7 @@
 )
 from watertap.costing.unit_models.gac import ContactorType
 from watertap.flowsheets.gac import gac as gac_fs
-from watertap.ui.fsapi import FlowsheetInterface, FlowsheetCategory
+from idaes_flowsheet_processor.api import FlowsheetInterface, FlowsheetCategory
 
 __author__ = "Hunter Barber"
 

diff --git a/watertap/flowsheets/generic_desalination_train/generic_train_ui.py b/watertap/flowsheets/generic_desalination_train/generic_train_ui.py
@@ -9,7 +9,7 @@
 # information, respectively. These files are also available online at the URL
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
-from watertap.ui.fsapi import FlowsheetInterface, FlowsheetCategory
+from idaes_flowsheet_processor.api import FlowsheetInterface, FlowsheetCategory
 from watertap.flowsheets.generic_desalination_train import generic_train
 from pyomo.environ import units as pyunits
 from idaes.core.solvers import get_solver

diff --git a/watertap/flowsheets/lsrro/lsrro_ui.py b/watertap/flowsheets/lsrro/lsrro_ui.py
@@ -10,7 +10,7 @@
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
 from watertap.core.solvers import get_solver
-from watertap.ui.fsapi import FlowsheetInterface
+from idaes_flowsheet_processor.api import FlowsheetInterface
 from watertap.flowsheets.lsrro.lsrro import (
     build,
     set_operating_conditions,

diff --git a/watertap/flowsheets/mvc/mvc_single_stage_ui.py b/watertap/flowsheets/mvc/mvc_single_stage_ui.py
@@ -9,7 +9,7 @@
 # information, respectively. These files are also available online at the URL
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
-from watertap.ui.fsapi import FlowsheetInterface
+from idaes_flowsheet_processor.api import FlowsheetInterface
 from watertap.flowsheets.mvc.mvc_single_stage import (
     build,
     set_operating_conditions,

diff --git a/watertap/flowsheets/nf_dspmde/nf_ui.py b/watertap/flowsheets/nf_dspmde/nf_ui.py
@@ -9,7 +9,7 @@
 # information, respectively. These files are also available online at the URL
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
-from watertap.ui.fsapi import FlowsheetInterface, FlowsheetCategory
+from idaes_flowsheet_processor.api import FlowsheetInterface, FlowsheetCategory
 from watertap.flowsheets.nf_dspmde import nf
 from watertap.flowsheets.nf_dspmde import nf_with_bypass
 from watertap.unit_models.nanofiltration_DSPMDE_0D import ConcentrationPolarizationType

diff --git a/watertap/flowsheets/oaro/oaro_multi_ui.py b/watertap/flowsheets/oaro/oaro_multi_ui.py
@@ -10,7 +10,7 @@
 # "https://github.com/watertap-org/watertap/"
 #################################################################################
 from watertap.core.solvers import get_solver
-from watertap.ui.fsapi import FlowsheetInterface
+from idaes_flowsheet_processor.api import FlowsheetInterface
 from watertap.flowsheets.oaro.oaro_multi import (
     build,
     set_operating_conditions,

diff --git a/watertap/flowsheets/seawater_RO_desalination/seawater_RO_desalination.py b/watertap/flowsheets/seawater_RO_desalination/seawater_RO_desalination.py
@@ -781,7 +781,7 @@ def display_costing(m):
 
 
 def export_to_ui():
-    from watertap.ui.fsapi import FlowsheetInterface
+    from idaes_flowsheet_processor.api import FlowsheetInterface
 
     def noop(*args, **kwargs):
         return

diff --git a/watertap/ui/__init__.py b/watertap/ui/__init__.py