uw-comphys / openccm

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.
https://uw-comphys.github.io/openccm/
GNU Lesser General Public License v2.1
0 stars 3 forks source link

Missing installation instructions #40

Closed speth closed 2 weeks ago

speth commented 3 weeks ago

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.

This is in the context of the review for JOSS (https://github.com/openjournals/joss-reviews/issues/6963).

Alex-Vasile commented 2 weeks ago

Hi @speth, I am going to break out the release problem into it's own issue as it's not documentation related