Merge branch 'main' into joss

.pre-commit-config.yaml

@@ -27,7 +27,7 @@ repos:
     hooks:
       - id: codespell
         stages: [commit, commit-msg]
-        exclude_types: [html]
+        exclude_types: [html, svg]
         additional_dependencies: [tomli] # needed to read pyproject.toml below py3.11
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -38,7 +38,9 @@ repos:
       - id: destroyed-symlinks
       - id: end-of-file-fixer
       - id: mixed-line-ending
+        exclude_types: [svg]
       - id: trailing-whitespace
+        exclude_types: [svg]
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8

README.md

@@ -6,11 +6,9 @@
 [![PyPI version](https://badge.fury.io/py/pyEQL.svg)](https://badge.fury.io/py/pyEQL)
 [![status](https://joss.theoj.org/papers/bdd9e247ea9736a0fdbbd5fe12bef7a6/status.svg)](https://joss.theoj.org/papers/bdd9e247ea9736a0fdbbd5fe12bef7a6)
 
+<img src="pyeql-logo.png" alt="pyEQL logo" style="width:600px;"/>
 
-![pyeql logo](pyeql-logo.svg)
-
-A python interface for water chemistry
-
+# A python interface for water chemistry
 
 ## Description
 
@@ -78,8 +76,8 @@ Detailed documentation is available at [https://pyeql.readthedocs.io/](https://p
 - [maggma](https://materialsproject.github.io/maggma/) - interface for accessing the property database
 - [scipy](https://www.scipy.org/) - for certain nonlinear equation solvers
 
-<!-- pyscaffold-notes -->
----
+## <!-- pyscaffold-notes -->
+
 pyEQL is licensed under LGPL.
 
 This project has been set up using PyScaffold 4.5. For details and usage

docs/installation.md

@@ -56,6 +56,9 @@ unavailable. Specifically, anything which depends on PHREEQC (e.g., the
  not available for this platform. All other functions of `pyEQL` should work as expected.
 
 Feel free to post your experiences or proposed solutions at https://github.com/KingsburyLab/pyEQL/issues/109
+
+NOTE: Some users have reported being able to use `phreeqpython` functions by installing
+an x86 version of `conda`/`miniconda`. See the issue report for more details.
 ```
 
 ## Other dependencies