Skip to content

Commit

Permalink
Merge pull request #73 from gerlero/readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
gerlero authored Aug 15, 2023
2 parents 0acfb5a + fc942c0 commit 26f3999
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@

## Installation

### Requirements
### Install from source

**porousMicroTransport** requires [OpenFOAM](https://www.openfoam.com), as distributed by OpenCFD (openfoam.com). Compatible OpenFOAM versions are v2012, v2106, v2112, v2206, v2212 and v2306.
#### Requirements

_Versions produced by the OpenFOAM Foundation (openfoam.org) (e.g. OpenFOAM 9, OpenFOAM 10) are not compatible._
**porousMicroTransport** requires [OpenFOAM](https://www.openfoam.com), as distributed by OpenCFD (openfoam.com). Compatible OpenFOAM versions are v2012, v2106, v2112, v2206, v2212 and v2306.

**porousMicroTransport** is provided as source code and must be compiled before use.
_Versions produced by the OpenFOAM Foundation (openfoam.org) (e.g. OpenFOAM 9, OpenFOAM 10) are not compatible. macOS users may want to consider [OpenFOAM.app](https://github.com/gerlero/openfoam-app)._

### Download
#### Download

[Download the source code](https://github.com/gerlero/porousMicroTransport/archive/refs/heads/main.zip) of **porousMicroTransport**, or clone this repository with Git:

```sh
git clone https://github.com/gerlero/porousMicroTransport.git
```

### Compile and install
#### Compile and install

To build and install **porousMicroTransport**, just invoke the top-level `Allwmake` script:

Expand All @@ -34,22 +34,33 @@ cd porousMicroTransport

_If necessary, activate/source the correct OpenFOAM environment before running `Allwmake`._

### Test
#### Test

Optionally, you can verify the installation of **porousMicroTransport** by running the included test suite (requires Python 3).
Optionally, you can verify the installation of **porousMicroTransport** by running the included test suite (requires Python 3.7 or later):

```sh
tests/Alltest
```

### Docker image

Alternatively, you can use the [Docker image](https://hub.docker.com/r/microfluidica/porousmicrotransport/) of **porousMicroTransport**. This image is based on the official OpenFOAM Docker image and includes **porousMicroTransport** precompiled and ready to use. If you have [Docker](https://www.docker.com) installed, you can run the image in a new container with:
Alternatively, **porousMicroTransport** is also [available in the form of Docker images](https://hub.docker.com/r/microfluidica/porousmicrotransport/). These images are based on the official OpenFOAM Docker images and include **porousMicroTransport** precompiled and ready to use. Assuming [Docker](https://www.docker.com) is installed, you can run the latest image of **porousMicroTransport** in a new container with:

```sh
docker run -it microfluidica/porousmicrotransport
```

Or, if you use OpenFOAM's [`openfoam-docker` script](https://develop.openfoam.com/packaging/containers) (which takes care of making the working directory available inside the container):

```sh
openfoam-docker -image=microfluidica/porousmicrotransport
```

A slimmer image variant that does not include source code or development tools is available as `microfluidica/porousmicrotransport:run`.

Docker images can also be used with other compatible containerization software, such as Podman and Singularity/Apptainer.


## Solvers

### `moistureDiffusivityFoam`
Expand Down

0 comments on commit 26f3999

Please sign in to comment.