DarSIA
Darcy scale image analysis toolbox
Documentation
Visit pmgbergen.github.io/DarSIA
Citing
If you use DarSIA in your research, we ask you to cite the following publication:
Nordbotten, J. M., Benali, B., Both, J. W., Brattekås, B., Storvik, E., & Fernø, M. A. (2023). DarSIA: An open-source Python toolbox for two-scale image processing of dynamics in porous media. arXiv preprint arXiv:2301.05455.
The first release can be also found on Zenodo: 10.5281/zenodo.7515016
Installation
Clone the repository from github and enter the DarSIA folder. Then, run the following command to install:
pip install .Usage
The following Python script can be applied to the test image in the examples/images folder.
import numpy as np
import darsia as da
# Create a darsia Image: An image that also contains information of physical entities
image = da.imread("images/baseline.jpg", width=2.8, height=1.5)
# Use the show method to take a look at the imported image.
image.show()
# Copy the image and adds a grid on top of it.
grid_image = image.add_grid(dx=0.1, dy=0.1)
grid_image.show()
# Extract region of interest (ROI) from image (box defined by two corners):
ROI_image = image.subregion(coordinates=np.array([[1.5, 0], [2.8, 0.7]]))
ROI_image.show()Furthermore, we encourage any user to checkout the jupyter notebooks in the examples/notebooks folder.
Developing DarSIA
To install darsia, along with the tools to develop and run tests, run the following in your virtual environment:
$ pip install -e .[dev]Use black (version 22.3.0), flake8 and isort formatting.