Skip to content
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
73f0243
Merge pull request #47 from BASE-Laboratory/working
jameslehoux Feb 27, 2026
ba6a080
Merge pull request #56 from BASE-Laboratory/working
jameslehoux Feb 27, 2026
f67aa10
Merge pull request #58 from BASE-Laboratory/working
jameslehoux Feb 28, 2026
525c246
Merge pull request #61 from BASE-Laboratory/claude/github-integration…
jameslehoux Feb 28, 2026
c20f97f
Merge pull request #64 from BASE-Laboratory/working
jameslehoux Feb 28, 2026
817d7e2
Merge pull request #78 from BASE-Laboratory/working
jameslehoux Feb 28, 2026
7c1ecb2
Merge pull request #86 from BASE-Laboratory/working
jameslehoux Mar 1, 2026
16459ad
Merge pull request #91 from BASE-Laboratory/working
jameslehoux Mar 1, 2026
dbed1e1
Merge pull request #95 from BASE-Laboratory/working
jameslehoux Mar 2, 2026
1796a8d
Merge pull request #97 from BASE-Laboratory/working
jameslehoux Mar 2, 2026
de5e0a9
Merge pull request #99 from BASE-Laboratory/working
jameslehoux Mar 2, 2026
7831d8a
Merge pull request #101 from BASE-Laboratory/working
jameslehoux Mar 2, 2026
992c78d
Merge pull request #103 from BASE-Laboratory/working
jameslehoux Mar 2, 2026
8e22286
Merge pull request #105 from BASE-Laboratory/working
jameslehoux Mar 3, 2026
aa6c0fa
Merge pull request #108 from BASE-Laboratory/working
jameslehoux Mar 3, 2026
bdbb4e3
Updated Readme with BaseLab links
jameslehoux Mar 3, 2026
12bd22b
Updated logo image to README
jameslehoux Mar 3, 2026
acdd374
Update README to remove development notice
jameslehoux Mar 3, 2026
b7128b5
Update acknowledgements in README.md
jameslehoux Mar 3, 2026
c6f37e0
Merge pull request #113 from BASE-Laboratory/working
jameslehoux Mar 6, 2026
667ee88
Merge pull request #115 from BASE-Laboratory/working
jameslehoux Mar 6, 2026
8f6490c
Merge pull request #124 from BASE-Laboratory/working
jameslehoux Mar 7, 2026
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
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# OpenImpala

<img src="https://user-images.githubusercontent.com/37665786/93309082-002ca800-f7fb-11ea-9ce7-d57b3e80c6ec.jpg" width="800" />
<p align="center">
<img src="https://github.com/user-attachments/assets/7a1902a0-a000-4111-b76b-226147ec6e30" alt="Logo" width="300">
</p>

[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![DOI](https://img.shields.io/badge/DOI-10.1016/j.softx.2021.100729-blue)](https://doi.org/10.1016/j.softx.2021.100729)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/kramergroup/openImpala)](https://github.com/kramergroup/openImpala/releases/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/kramergroup/openImpala)](https://github.com/kramergroup/openImpala/graphs/contributors)
[![Build and Test Status](https://github.com/kramergroup/openImpala/actions/workflows/build-test.yml/badge.svg?branch=master)](https://github.com/kramergroup/openImpala/actions/workflows/build-test.yml)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/BASE-Laboratory/OpenImpala)](https://github.com/BASE-Laboratory/OpenImpala/releases/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/BASE-Laboratory/OpenImpala)](https://github.com/BASE-Laboratory/OpenImpala/graphs/contributors)
[![Build and Test Status](https://github.com/BASE-Laboratory/OpenImpala/actions/workflows/build-test.yml/badge.svg?branch=master)](https://github.com/BASE-Laboratory/OpenImpala/actions/workflows/build-test.yml)
[![codecov](https://codecov.io/gh/BASE-Laboratory/OpenImpala/branch/master/graph/badge.svg)](https://codecov.io/gh/BASE-Laboratory/OpenImpala)

> ⚠️ **Active Development Notice:** > This repository is the active development fork maintained by the [BASE Laboratory](https://github.com/BASE-Laboratory).
> For the original archive, please visit [kramergroup/openImpala](https://github.com/kramergroup/openImpala).

OpenImpala is a high-performance computing framework for image-based modelling, built upon the [AMReX library](https://github.com/AMReX-Codes/amrex) for massive parallelism using MPI. It tackles the challenge posed by large 3D imaging datasets (often billions of voxels) common in materials science and tomography.

OpenImpala directly solves physical equations, such as steady-state diffusion or conduction problems, on the voxel grid of the input image using finite differences. This approach bypasses the need for explicit mesh generation, working directly with the acquired image data. From the simulation results, it calculates effective homogenised transport properties (e.g., diffusivity, conductivity, tortuosity) characteristic of the microstructure.
Expand Down Expand Up @@ -73,7 +71,7 @@ The easiest way to use OpenImpala is by downloading the pre-built container from

### 1. Download the Container

1. Go to the [**GitHub Releases Page**](https://github.com/kramergroup/openImpala/releases).
1. Go to the [**GitHub Releases Page**](https://github.com/BASE-Laboratory/OpenImpala/releases).
2. Find the latest release and download the `.sif` file (e.g., `openimpala-vX.Y.Z.sif`) from the "Assets" section.
3. Ensure you have **Apptainer** or **Singularity** (version 3.x or later) installed on your system. See the [Apptainer documentation](https://apptainer.org/docs/user/main/installation.html).

Expand Down Expand Up @@ -322,15 +320,15 @@ Below are some examples of publications using or discussing OpenImpala:

Contributions to OpenImpala are welcome! Whether it's reporting bugs, suggesting features, improving documentation, or submitting code, your input is valuable.

* **Bug Reports & Feature Requests:** Please use the [GitHub Issues tracker](https://github.com/kramergroup/openImpala/issues) to report problems or propose new features. Provide as much detail as possible, including steps to reproduce for bugs.
* **Bug Reports & Feature Requests:** Please use the [GitHub Issues tracker](https://github.com/BASE-Laboratory/OpenImpala/issues) to report problems or propose new features. Provide as much detail as possible, including steps to reproduce for bugs.
* **Code Contributions:**
* If you plan to make significant changes, please open an issue first to discuss your ideas.
* For code contributions (bug fixes, enhancements, new features, tests), please follow this general workflow:
1. Fork the repository ([https://github.com/kramergroup/openImpala](https://github.com/kramergroup/openImpala)).
1. Fork the repository ([https://github.com/BASE-Laboratory/OpenImpala](https://github.com/BASE-Laboratory/OpenImpala)).
2. Create a new branch for your feature or fix (`git checkout -b feature/my-new-feature`).
3. Make your changes and commit them with clear messages.
4. Push your branch to your fork (`git push origin feature/my-new-feature`).
5. Submit a [Pull Request](https://github.com/kramergroup/openImpala/pulls) to the main repository.
5. Submit a [Pull Request](https://github.com/BASE-Laboratory/OpenImpala/pulls) to the main repository.
* **Documentation:** Improvements to the README, code comments, or other documentation are always appreciated. You can submit these via Pull Requests.

## Code Formatting
Expand Down Expand Up @@ -426,14 +424,14 @@ The software is licensed under the **BSD 3-Clause "New" or "Revised" License**.

## Acknowledgements

This work was financially supported by the EPSRC Centre for Doctoral Training (CDT) in Energy Storage and its Applications [grant ref: EP/R021295/1], the Ada Lovelace Centre (ALC) STFC project, CANVAS-NXtomo, ContAiNerised Voxel-bAsed Simulation of Neutron and X-ray Tomography data, and part funded by the EPSRC prosperity partnership with Imperial College, INFUSE, Interface with the Future - Underpinning Science to Support the Energy transition EP/V038044/1.
This work was financially supported by the EPSRC Centre for Doctoral Training (CDT) in Energy Storage and its Applications [grant ref: EP/R021295/1], the Ada Lovelace Centre (ALC) STFC project, CANVAS-NXtomo, ContAiNerised Voxel-bAsed Simulation of Neutron and X-ray Tomography data, the EPSRC prosperity partnership with Imperial College, INFUSE, Interface with the Future - Underpinning Science to Support the Energy transition EP/V038044/1, the Rutherford Appleton Laboratory and The Faraday Institution through James Le Houx's Emerging Leader Fellowship (Grant No. FIELF001), and from Research England’s ‘Expanding Excellence in England’ grant at the University of Greenwich via the “Multi-scale Multi-disciplinary Modelling for Impact” (M34Impact) programme.

The authors acknowledge the use of the IRIDIS High Performance Computing Facility, and associated support services at the University of Southampton, in the completion of this work.
The authors acknowledge the use of the IRIDIS High Performance Computing Facility, Diamond Light Source's Wilson HPC cluster, STFC's SCARF cluster and the University of Greenwich's M34Impact HPC Cluster in the completion of this work.

We thank the developers of [AMReX](https://github.com/AMReX-Codes/amrex), [HYPRE](https://github.com/hypre-space/hypre), [libtiff](http://www.libtiff.org/), and [HDF5](https://www.hdfgroup.org/solutions/hdf5/) upon which OpenImpala relies.

---

## Contact & Support

For questions, bug reports, or feature requests, please use the [GitHub Issues tracker](https://github.com/kramergroup/openImpala/issues) for this repository.
For questions, bug reports, or feature requests, please use the [GitHub Issues tracker](https://github.com/BASE-Laboratory/OpenImpala/issues) for this repository.
Loading