Merge pull request #59 from chrisjonesBSU/wsl

Add WSL test to CI workflow, add notes about using with Windows

Author: chrisjonesBSU

.github/workflows/CI.yaml

@@ -79,3 +79,33 @@ jobs:
 
       - name: Test (OS -> ${{ matrix.os }} / Python -> ${{ matrix.python-version }})
         run: python -m pytest -v --color yes --pyargs msibi
+
+  wsl-test:
+    if: github.event.pull_request.draft == false
+    name: MSIBI Tests (WSL)
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        name: Checkout Branch / Pull Request
+
+      - uses: Vampire/setup-wsl@v5
+        with:
+          distribution: Ubuntu-24.04
+          wsl-shell-user: runner
+        name: Set up WSL
+
+      - name: Install MSIBI and run pytest
+        shell: wsl-bash {0}
+        run: |
+          wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh -O $HOME/Miniforge3.sh
+          bash $HOME/Miniforge3.sh -b -p $HOME/miniforge
+          echo 'export PATH=$HOME/miniforge/bin:$PATH' >> ~/.bashrc
+          export PATH=$HOME/miniforge/bin:$PATH
+          source ~/.bashrc
+          source $HOME/miniforge/etc/profile.d/conda.sh
+          mamba update -n base --all -y
+          mamba env create -f environment-dev.yml python=3.12 -y
+          conda activate msibi-dev
+          pip install -e . --prefix=$HOME/tmp_egginfo --no-build-isolation
+          python -m pytest -v --color yes

README.md

@@ -26,6 +26,11 @@ mamba activate msibi
 pip install .
 ```
 
+### Using MSIBI on Windows
+MSIBI is not installable on Windows operating systems as HOOMD-Blue is not available for Windows. You can run MSIBI using [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) (WSL).
+Once you have a shell active in WSL with anaconda installed, follow the installation instructions above.
+
+
 ## Using MSIBI
 For a full description of the API with examples see the [documentation](https://msibi.readthedocs.io/en/latest/).
 

docs/source/installation.rst

@@ -40,3 +40,8 @@ Install from source
         $ export CONDA_OVERRIDE_CUDA="[YOUR_CUDA_VERSION]"
 
     Please see the `HOOMD-blue installation instructions <https://hoomd-blue.readthedocs.io/en/stable/installation.html>`_ for more information.
+
+
+.. note::
+  MSIBI is not installable on Windows operating systems as HOOMD-Blue is not available for Windows. You can run MSIBI using `Windows Subsystem for Linux <https://learn.microsoft.com/en-us/windows/wsl/install>`_ (WSL).
+  Once you have a shell active in WSL, follow the installation instructions above.