electrodialysis-bipolar-tea

Operating system support

• Currently tested on:
  • Windows 10
  • Windows Server 2022 (windows-2022 in GitHub Actions)
  • Linux Ubuntu 22.04
  • Linux Ubuntu 24.04 (ubuntu-24.04 in GitHub Actions)
• In principle, any other OS supported by IDAES should also work, but model convergence results might differ due to numerical differences between platforms
• For more information on OS support for IDAES, see the IDAES documentation

Running on Binder (no installation required)

1. Click on this button to launch a temporary containerized cloud environment with all dependencies installed and configured: (no charge and/or registration required)
2. Wait (potentially up to several minutes) for the cloud environment to be built
3. In the JupyterLab interface, open a terminal window
4. In the terminal tab, run the sample script

python BPED_sample_script.py

Running locally (manual installation)

Windows

1. Install and configure Conda using a Conda distribution compatible with conda-forge (recommended: Miniforge)
2. Install and configure Git for Windows
3. Clone this repository and change directory to the local clone:

git clone https://github.com/watertap-org/electrodialysis-bipolar-tea
cd electrodialysis-bipolar-tea

4. Create the Conda environment from the environment.yml file in the repository

conda env create --file environment.yml

5. Activate the environment

conda activate watertap-electrodialysis-bipolar-tea

6. Install the IDAES solvers

idaes get-extensions --verbose

7. Run the sample script

python BPED_sample_script.py

Linux (Ubuntu/Debian and compatible distributions)

1. Install and configure Conda using a Conda distribution compatible with conda-forge (recommended: Miniforge)
2. Install and configure Git
3. Clone this repository and change directory to the local clone:

git clone https://github.com/watertap-org/electrodialysis-bipolar-tea
cd electrodialysis-bipolar-tea

4. Create the Conda environment from the environment.yml file in the repository

conda env create --file environment.yml

5. Activate the environment

conda activate watertap-electrodialysis-bipolar-tea

6. Install IDAES solvers and required system packages

sudo apt install libgfortran5 libgomp1 liblapack3 libblas3
# note: we specify --distro ubuntu2204 since these are the latest compatible builds available
# in most case these are also compatible with later versions and/or distributions
idaes get-extensions --verbose --distro ubuntu2204

7. Run the sample script

python BPED_sample_script.py