Skip to content

Update documentation on using docker #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
This website is intended to provide some guidance on how to get and install
the PROGRESS library. LA-UR number 'LA-UR-17-27372'

[![CI](https://github.com/lanl/qmd-progress/actions/workflows/CI.yaml/badge.svg)](https://github.com/lanl/qmd-progress/actions/workflows/CI.yaml)

# A library for quantum chemistry solvers.
Expand Down Expand Up @@ -46,15 +49,12 @@ Travis-CI is [limiting the number of builds for open source
projects](https://blog.travis-ci.com/2020-11-02-travis-ci-new-billing).
Our workflow uses a [custom Docker
image](https://hub.docker.com/r/nicolasbock/qmd-progress) which comes
with the necessary compiler tool chain to build and test the
`qmd-progress` library. Using `docker` is a convenient and quick way
to develop, build, and test the `qmd-progress` library.

$ docker pull nicolasbock/qmd-progress:latest
$ docker run --interactive --tty --rm \
--volume ${PWD}:/qmd-progress --workdir /qmd-progress \
--user $(id --user):$(id --group) \
nicolasbock/qmd-progress:latest
with the necessary compiler tool chain and a pre-installed `bml`
library to build and test the `qmd-progress` library. Using `docker`
is a convenient and quick way to develop, build, and test the
`qmd-progress` library.

$ ./run-local-docker-container.sh

Inside the container:

Expand Down
17 changes: 8 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Structure Solver. **LA-CC-16-068**
- This library has to be compiled with the [_Basic Matrix Library_
(BML)](https://lanl.github.io/bml/).

- Our webpage can be found at https://lanl.github.io/qmd-progress/

# Authors

(in alphabetical order)
Expand Down Expand Up @@ -51,15 +53,12 @@ Travis-CI is [limiting the number of builds for open source
projects](https://blog.travis-ci.com/2020-11-02-travis-ci-new-billing).
Our workflow uses a [custom Docker
image](https://hub.docker.com/r/nicolasbock/qmd-progress) which comes
with the necessary compiler tool chain to build and test the
`qmd-progress` library. Using `docker` is a convenient and quick way
to develop, build, and test the `qmd-progress` library.

$ docker pull nicolasbock/qmd-progress:latest
$ docker run --interactive --tty --rm \
--volume ${PWD}:/qmd-progress --workdir /qmd-progress \
--user $(id --user):$(id --group) \
nicolasbock/qmd-progress:latest
with the necessary compiler tool chain and a pre-installed `bml`
library to build and test the `qmd-progress` library. Using `docker`
is a convenient and quick way to develop, build, and test the
`qmd-progress` library.

$ ./run-local-docker-container.sh

Inside the container:

Expand Down