diff --git a/.github/workflows/build_tests.yml b/.github/workflows/build_tests.yml index 1f758f0de..6cc593a97 100644 --- a/.github/workflows/build_tests.yml +++ b/.github/workflows/build_tests.yml @@ -83,7 +83,7 @@ jobs: python-version: ${{ matrix.python-version }} - if: ${{ matrix.os == 'macos-latest' || matrix.os == 'macOS-13'}} run: | - brew reinstall --build-from-source --formula ./shell/apple/libomp.rb + brew reinstall --build-from-source --formula wntr/epanet/libepanet/darwin-formula/libomp.rb - name: Install dependencies run: | python --version diff --git a/MANIFEST.in b/MANIFEST.in index 0f6c9b053..bc799d136 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -10,3 +10,4 @@ include wntr/sim/network_isolation/numpy.i include wntr/tests/networks_for_testing/*.inp include wntr/library/msx/*.json include wntr/library/msx/*.msx +include wntr/epanet/libepanet/darwin-formula/libomp.rb diff --git a/documentation/installation.rst b/documentation/installation.rst index 4d6b8bffb..70dbb4179 100644 --- a/documentation/installation.rst +++ b/documentation/installation.rst @@ -161,6 +161,20 @@ Step 2: Install WNTR during the setup process. This requires that the user has a C++ compiler (e.g., Visual Studio C++, GNU C++, MinGW) on their path. No compiler is needed when installing WNTR through PyPI (Option 1) or conda (Option 2). + +.. note:: Mac builds and EPANETMSX + + The builds of EPANETMSX for Mac require the OpenMP package be installed. This is easiest to do using + homebrew. A brew recipe is provided with WNTR that will obtain the appropriate libraries. To use it, + download the https://github.com/USEPA/WNTR/tree/main/wntr/epanet/libepanet/darwin-formula/libomp.rb + formula directly and brew it, or use the command below. + This should install the necessary libraries onto your machine to be able to run WNTR with EPANETMSX extensions. + + .. code:: bash + + brew reinstall --build-from-source --formula https://github.com/USEPA/WNTR/tree/main/wntr/epanet/libepanet/darwin-formula/libomp.rb + + Step 3: Test installation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/shell/apple/libomp.rb b/wntr/epanet/libepanet/darwin-formula/libomp.rb similarity index 100% rename from shell/apple/libomp.rb rename to wntr/epanet/libepanet/darwin-formula/libomp.rb