Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
moyner committed Jan 28, 2024
1 parent c92dfa1 commit 4299d92
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down

0 comments on commit 4299d92

Please sign in to comment.