Skip to content

Commit

Permalink
Patch v1.1.5 (#21)
Browse files Browse the repository at this point in the history
* Expanding README and fixing bug in Docker

* Incrementing version number
  • Loading branch information
ifilot authored May 1, 2024
1 parent 906968d commit 82c9298
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![status](https://joss.theoj.org/papers/f6493d619d92bb6d993713b9d1abb38c/status.svg)](https://joss.theoj.org/papers/f6493d619d92bb6d993713b9d1abb38c)
[![DOI](https://zenodo.org/badge/641289155.svg)](https://zenodo.org/badge/latestdoi/641289155)
[![Docker pulls](https://img.shields.io/docker/pulls/ivofilot/bramble)](https://hub.docker.com/r/ivofilot/bramble)

## Purpose

Expand Down Expand Up @@ -65,3 +66,36 @@ cmake ../src -DMOD_CUDA=1 -DCUDA_ARCH=sm_89
where the value for `DCUDA_ARCH` should match the architecture of your graphical
card. A nice overview is given [here](https://arnon.dk/matching-sm-architectures-arch-and-gencode-for-various-nvidia-cards/).
For example, for a `RTX 4090`, `-DCUDA_ARCH=sm_89`.

## Docker container

Rather than compiling Bramble yourself, you can also make direct use of the
[Bramble docker container](https://hub.docker.com/r/ivofilot/bramble). This
container is built on top of the [NVidia CUDA container](https://hub.docker.com/r/nvidia/cuda/)
allowing you to use the CUDA-enabled version of Bramble.

To use the Docker container, first download it from Docker Hub

```bash
docker pull ivofilot/bramble
```

Next, launch the container and link a volume on your hard drive to interact
with. This folder should contain the files you wish to work with.

```bash
docker run --name bramble -v "D:/bramble-data":/home/bramble/data -d ivofilot/bramble:latest
```

This will launch the `bramble` image, which you check using

```bash
docker ps
```

To execute Bramble, simply log into the container and use the same kind of commands
you would normally use for running Bramble.

```bash
docker exec -it bramble /bin/bash
```
4 changes: 3 additions & 1 deletion docker/deploy.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,6 @@ RUN rm -rf /tmp/src /tmp/build
RUN useradd -ms /bin/bash bramble
USER bramble
WORKDIR /home/bramble
RUN which bramblecuda
RUN which bramblecuda

ENTRYPOINT ["tail", "-f", "/dev/null"]
2 changes: 1 addition & 1 deletion src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ endif()
# prepare configuration file
SET(VERSION_MAJOR "1")
SET(VERSION_MINOR "1")
SET(VERSION_PATCH "3")
SET(VERSION_PATCH "5")
message(STATUS "Writing configuration file in: ${CMAKE_CURRENT_SOURCE_DIR}/config.h")
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config.h.in ${CMAKE_CURRENT_SOURCE_DIR}/config.h @ONLY)

Expand Down

0 comments on commit 82c9298

Please sign in to comment.