From 4299d92dd54007a892bc972f8c7703b6e7a90c51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Olav=20M=C3=B8yner?= Date: Sun, 28 Jan 2024 21:51:38 +0100 Subject: [PATCH] Update README --- README.md | 15 ++++++++++++--- docs/src/index.md | 2 +- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index abe3a0d..37ba861 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # GeoEnergyIO -[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://moyner.github.io/GeoEnergyIO.jl/stable/) -[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://moyner.github.io/GeoEnergyIO.jl/dev/) -[![Build Status](https://github.com/moyner/GeoEnergyIO.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/moyner/GeoEnergyIO.jl/actions/workflows/CI.yml?query=branch%3Amain) +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://sintefmath.github.io/GeoEnergyIO.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://sintefmath.github.io/GeoEnergyIO.jl/dev/) +[![Build Status](https://github.com/sintefmath/GeoEnergyIO.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/sintefmath/GeoEnergyIO.jl/actions/workflows/CI.yml?query=branch%3Amain) + +Module for parsing and processing various types of input files used in geo-energy reservoir simulation (geothermal, carbon storage, gas storage, oil and gas recovery). + +Currently contains two main features: + +- Parser for .DATA files used by many reservoir simulators. +- A corner-point grid processor that converts parsed GRDECL files into unstructured meshes that handles general faults. + +This module is unregistered and work-in-progress. It is extracted from the Julia reservoir simulation package [JutulDarcy.jl](https://github.com/sintefmath/JutulDarcy.jl) and will eventually replace the parser in JutulDarcy. diff --git a/docs/src/index.md b/docs/src/index.md index 96c3b24..e0e8c69 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -4,7 +4,7 @@ CurrentModule = GeoEnergyIO # GeoEnergyIO -Documentation for [GeoEnergyIO](https://github.com/moyner/GeoEnergyIO.jl). +Documentation for [GeoEnergyIO](https://github.com/sintefmath/GeoEnergyIO.jl). ```@index ```