From bdbb4e300a179cae39ba6f73b5404018450d822c Mon Sep 17 00:00:00 2001
From: James Le Houx <37665786+jameslehoux@users.noreply.github.com>
Date: Tue, 3 Mar 2026 12:13:32 +0000
Subject: [PATCH 1/4] Updated Readme with BaseLab links
---
README.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index bb0d50fd..d0dde1b6 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://doi.org/10.1016/j.softx.2021.100729)
-[](https://github.com/kramergroup/openImpala/releases/latest)
-[](https://github.com/kramergroup/openImpala/graphs/contributors)
-[](https://github.com/kramergroup/openImpala/actions/workflows/build-test.yml)
+[](https://github.com/BASE-Laboratory/OpenImpala/releases/latest)
+[](https://github.com/BASE-Laboratory/OpenImpala/graphs/contributors)
+[](https://github.com/BASE-Laboratory/OpenImpala/actions/workflows/build-test.yml)
[](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).
@@ -73,7 +73,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).
@@ -322,15 +322,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
@@ -436,4 +436,4 @@ We thank the developers of [AMReX](https://github.com/AMReX-Codes/amrex), [HYPRE
## 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.
From 12bd22b93c0bc47bc2587b9d0729758cd9da9438 Mon Sep 17 00:00:00 2001
From: James Le Houx <37665786+jameslehoux@users.noreply.github.com>
Date: Tue, 3 Mar 2026 14:42:25 +0000
Subject: [PATCH 2/4] Updated logo image to README
Added a logo image to the README file.
---
README.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index d0dde1b6..72553f6b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
# OpenImpala
-
-
+
+ 
+
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://doi.org/10.1016/j.softx.2021.100729)
From acdd374666c850d6625cd7fc31ce78417af9ca0e Mon Sep 17 00:00:00 2001
From: James Le Houx <37665786+jameslehoux@users.noreply.github.com>
Date: Tue, 3 Mar 2026 14:47:26 +0000
Subject: [PATCH 3/4] Update README to remove development notice
Removed active development notice and original archive link.
---
README.md | 3 ---
1 file changed, 3 deletions(-)
diff --git a/README.md b/README.md
index 72553f6b..441f14a8 100644
--- a/README.md
+++ b/README.md
@@ -10,9 +10,6 @@
[](https://github.com/BASE-Laboratory/OpenImpala/actions/workflows/build-test.yml)
[](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.
From b7128b554f13188fe5e8fbe4deaad5b51ac457a5 Mon Sep 17 00:00:00 2001
From: James Le Houx <37665786+jameslehoux@users.noreply.github.com>
Date: Tue, 3 Mar 2026 14:56:07 +0000
Subject: [PATCH 4/4] Update acknowledgements in README.md
Expanded acknowledgements section to include additional funding sources and HPC facilities used in the project.
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 441f14a8..3bd88749 100644
--- a/README.md
+++ b/README.md
@@ -424,9 +424,9 @@ 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.