DarIA

Darcy scale image analysis toolbox

Installation

Clone the repository from github and enter the DarIA folder. Then, run the following command to install:

pip install .

Usage

import daria as da

# Create a daria Image: An image that also contains information of physical entities, baseline image can be found at the link: (WE NEED TO PROVIDE LINK TO IMAGE)
image = da.Image("images/originals/Baseline.jpg", origo = [5, 2], width = 280, height = 150)

# Use the show method to take a look at the imported image (push any button to close the window)
image.show()

# Copies the image and adds a grid on top of it.
grid_image = image.add_grid(origo = [5, 2], dx = 10, dy = 10)
grid_image.show()

# Extract region of interest (ROI) from image:
ROI_image = da.extractROI(image, [150, 280], [0, 70])
ROI_image.show()

Developing DarIA

To install daria, along with the tools to develop and run tests, run the following in your virtualenv:

$ pip install -e .[dev]

Use black (version 22.3.0), flake8 and isort formatting.