OpenCCM is a CFD-based compartment modelling software package. It is primarily intended for convection dominated reactive flows which feature a weak or one-way coupling between the reactive species and the carrier fluid, i.e. the reaction does not substantially influence the fluid flow over the course of the simulation.
I could not find any installation instructions. While I found that running the common pip install -e . from a Git checkout worked, even this installation route should be documented.
There is no "release" version marked on GitHub, and the only tagged version is v0.9. Meanwhile, the version available from PyPI is v0.1.
The method for installing with the extra dependencies for the examples should be documented. I had to read setup.cfg and search Stack Overflow to learn that the correct command is pip install -e ".[all]" .
I could not find any installation instructions. While I found that running the common
pip install -e .
from a Git checkout worked, even this installation route should be documented.README.md
INSTALL.md
setup.cfg
and search Stack Overflow to learn that the correct command ispip install -e ".[all]"
.This is in the context of the review for JOSS (https://github.com/openjournals/joss-reviews/issues/6963).