From 2ba7f7994c9ae456f08654b9a1a26f539b2043f3 Mon Sep 17 00:00:00 2001 From: amirDahari1 <amir.dahari@mail.huji.ac.il> Date: Mon, 7 Oct 2024 12:31:47 +0100 Subject: [PATCH] Updated README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c0bd843..85b4c6e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ -# Representativity - -![Tests](https://github.com/tldr-group/Representativity/actions/workflows/tests.yml/badge.svg) +# ImageRep [Try it out!](https://www.imagerep.io/) -Here we introduce the 'ImageRep' method for fast phase fraction representativity estimation from a single microstructural image. This is achieved by calculating the Two-Point Correlation (TPC) function of the image, combined with a data-driven analysis of the [Microlib](https://microlib.io/) dataset. By applying a statistical framework that utilizes both data sources, we can establish the uncertainty in the phase fraction in the image with a given confidence, **and** the image size that would be needed to meet a given target uncertainty. Further details are provided in our [paper](CITATION.cff). +Here we introduce the 'ImageRep' method for fast phase fraction representativity estimation from a single microstructural image. This is achieved by calculating the Two-Point Correlation (TPC) function of the image, combined with a data-driven analysis of the [MicroLib](https://microlib.io/) dataset. By applying a statistical framework that utilizes both data sources, we can establish the uncertainty in the phase fraction in the image with a given confidence, **and** the image size that would be needed to meet a given target uncertainty. Further details are provided in our [paper](CITATION.cff). If you use this ImageRep in your research, [please cite us](CITATION.cff). ## Usage: -This method can be used via the [website (imagerep.io)](https://www.imagerep.io/)or as python package - see [`example.ipynb`](example.ipynb). +This method can be used via the [website (imagerep.io)](https://www.imagerep.io/) or as python package - see [`example.ipynb`](example.ipynb). <p align="center"> <img src="https://sambasegment.blob.core.windows.net/resources/repr_repo_v2.gif"> @@ -82,6 +80,8 @@ yarn && yarn start ## Testing Instructions +![Tests](https://github.com/tldr-group/Representativity/actions/workflows/tests.yml/badge.svg) + 1. Run (with your virtual enviroment activated!) ```