mac tests, flake8 linter, move docs to gh-pages branch

.github/linters/.codespellrc

@@ -1,2 +1,2 @@
 [codespell]
-skip = .git,docs,reports,images,__pycache__
+skip = .*,__pycache__,build,docs,images,reports,sphinx

.github/linters/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 80

.github/workflows/ci.yaml

@@ -6,17 +6,15 @@ on:
     paths-ignore:
       - '*.md'
       - 'README*'
-      - 'LICENSE'
-      - 'docs/*'
+      - 'LICENSE*'
       - 'images/*'
 
   pull_request:
     branches: [main]
     paths-ignore:
       - '*.md'
       - 'README*'
-      - 'LICENSE'
-      - 'docs/*'
+      - 'LICENSE*'
       - 'images/*'
 
 jobs:
@@ -44,16 +42,20 @@ jobs:
         run: |
           pip install codespell
           codespell --config .github/linters/.codespellrc
+      - name: Code format
+        run: |
+          pip install flake8
+          flake8 --config .github/linters/.flake8 src
 
-  tests:
+  win-lin-tests:
     name: (Test ${{ matrix.python-version }}, ${{ matrix.os }})
 
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-latest', 'windows-latest'] # ['ubuntu-latest', 'macos-latest', 'windows-latest']
+        os: ['ubuntu-latest', 'windows-latest']
         python-version: ['3.8', '3.11']
 
     defaults:
@@ -64,17 +66,52 @@ jobs:
       - uses: actions/checkout@v4
       - uses: conda-incubator/setup-miniconda@v3
         with:
+          activate-environment: 'rovi'
           python-version: ${{ matrix.python-version }}
           miniconda-version: 'latest'
           use-only-tar-bz2: true
           auto-update-conda: true
           auto-activate-base: true
+      - name: Conda dependencies
+        run: conda install scikits.odes -c conda-forge
+      - name: Pip dependencies
+        run: pip install .
+      - name: List packages
+        run: conda list
+      - name: Pytest
+        run: |
+          pip install pytest
+          pytest
+
+  mac-tests:
+    name: (Test ${{ matrix.python-version }}, ${{ matrix.os }})
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['macos-latest']
+        python-version: ['3.8', '3.11']
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          activate-environment: 'rovi'
+          miniconda-version: 'latest'
+          use-only-tar-bz2: true
+          auto-update-conda: true
+          auto-activate-base: true
       - name: Make environment
         run: |
-          conda create -n rovi
-          conda activate rovi
-      - name: Conda dependencies
-        run: conda install -c conda-forge scikits.odes
+          conda info
+          conda config --env --set subdir osx-64
+          conda install python=${{ matrix.python-version }} scikits.odes -c conda-forge
       - name: Pip dependencies
         run: pip install .
       - name: List packages

.gitignore

@@ -10,6 +10,7 @@ __pycache__/
 *.so
 
 # Distribution / packaging
+gh-pages/
 sphinx/
 .Python
 build/

README.md

@@ -55,7 +55,7 @@ The overall cell voltage is
 where $R_0$ the lone series resistance (Ohm), as shown in Figure 1. Just like the other resistive elements, $R_0$ is a function of soc and $T_{\rm cell}$.
 
 ## Installation
-We recommend using [Anaconda](https://anaconda.com) to install this package due to the [scikits.odes](https://scikits-odes.readthedocs.io) dependency, which is installed separately using ``conda install`` to avoid having to download and install C++ and Fortran compilers.
+We recommend using [Anaconda](https://anaconda.com) to install this package due to the [scikits.odes](https://scikits-odes.readthedocs.io) dependency, which is installed separately using `conda install` to avoid having to download and install C++ and Fortran compilers. Please refer to the linked `scikits.odes` documentation if you'd prefer to install their software without using `conda`.
 
 After cloning the repository, or downloading the files, use your terminal (MacOS/Linux) or Anaconda Prompt (Windows) to navigate into the folder with the `pyproject.toml` file. Once in the correct folder, execute the following commands:
 
@@ -65,6 +65,16 @@ conda activate rovi
 pip install .
 ```
 
+Note that if you are using a Mac with `arm-64` for `conda`, you will have to force your new environment to use packages built on `osx-64` because `scikits.odes` does not currently have any builds for `arm-64`. You can check if this is the case by running `conda info` and checking the platform value. To set up and force your new environment to `osx-64`, run the following:
+
+```cmd
+conda create -n rovi
+conda activate rovi
+conda config --env --set subdir osx-64
+conda install python=3.10 scikits.odes -c conda-forge
+pip install .
+```
+
 The first command will create a new Python environment named `rovi`. The environment will be set up using Python 3.10 and will install the `scikits.odes` dependency from the `conda-forge` channel. You can change the environment name as desired and specify any Python version >= 3.8 and < 3.12. Although the package supports multiple Python versions, development and testing is primarily done using 3.10. Therefore, if you have issues with another version, you should revert to using 3.10.
 
 Before running the `pip install` command, which installs `thevenin`, you should activate your new `rovi` environment using the second command. If you plan to make changes to your local package, use the `-e` flag and add the optional developer dependencies during the `pip install` step, as shown below.