Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mlund committed Jun 1, 2022
1 parent b8d74e5 commit 8bc5f8c
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/_docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,17 @@ is not on Conda, consider an alternative method below.
## Docker

We provide a [`Dockerfile`](https://github.com/mlund/faunus/blob/master/scripts/Dockerfile)
that builds the main branch in a [Jupyter](https://jupyter.org) environment:
that builds the main branch in a [Jupyter](https://jupyter.org) environment.
The following downloads the Dockerfile; builds the image; and startup a JupyterLab
session in Docker on port 8888:

~~~ bash
curl -s https://raw.githubusercontent.com/mlund/faunus/master/scripts/Dockerfile | docker build -t faunuslab -
docker run -it -p 8888:8888 faunuslab # open generated url in a browser
~~~

Once running, you may alias the Docker-side faunus command:
Once running, you may alias the Docker-side faunus command so that it can be accessed from
the host side:

~~~ bash
alias faunus='docker exec --interactive -u 1000 faunuslab faunus'
Expand All @@ -46,13 +49,13 @@ faunus < input.json # piping input to docker
## Build from source code

Faunus is continuously [tested](https://app.travis-ci.com/github/mlund/faunus) on macOS/Linux,
but compile on most unix operating systems, including the Windows Subsystem for Linus (WSL).
but compile on most unix operating systems, including the Windows Subsystem for Linux (WSL).

### Requirements

- CMake 3.16+
- C++20 compiler (clang, g++, intel ixpc, ...)
- Python 3.6+ with the following packages:
- Python 3.7+ with the following packages:
- `jinja2`, `ruamel_yaml` or `yaml`

The following are optional:
Expand All @@ -72,7 +75,7 @@ and build using cmake:
~~~ bash
cd faunus
cmake . [OPTIONS]
make faunus
make faunus -j
make usagetips # requires `pandoc`, `pypandoc`, `BeautifulSoup4`
~~~

Expand Down

0 comments on commit 8bc5f8c

Please sign in to comment.