Skip to content

Commit

Permalink
Update README with markdown extension
Browse files Browse the repository at this point in the history
  • Loading branch information
eivindjahren committed Sep 30, 2021
1 parent 079bc83 commit b4d7e39
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
ecl-data-io
===========

Parser for the binary ecl format, such as found in output files with
extensions .UNRST, .EGRID, .INIT, .UNRST etc. and also the corresponding
ascii formats such as .FUNRST, .FEGRID, .FINIT, .FUNRST etc.
Parser for the ecl output format, such as found in files with
extensions .UNRST, .EGRID, .INIT, etc. and also the corresponding
ascii files with extension .FUNRST, .FEGRID, .FINIT, etc.

The file format comes in two forms: formatted or unformatted, which are
ascii and binary respectively (the terminology comes from fortran).
Expand All @@ -13,8 +13,7 @@ keyword name, followed by a 4 byte signed integer which is the length
of the array, then a 4 character keyword describing the data type
of elements in the array. Each file consists of a sequence of such arrays.

ecl-data-io does not interpret the output, but simply generate the list of
arrays:
ecl-data-io does not interpret the output, but simply give you the arrays:

```
import ecl_data_io as eclio
Expand Down Expand Up @@ -98,6 +97,7 @@ names, however, if the file has multiple arays with the same name,
list of tuples can be used:


```
import ecl_data_io as eclio
contents = [
Expand All @@ -106,3 +106,4 @@ contents = [
]
eclio.write("my/file.grdecl", contents)
```
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


def get_long_description() -> str:
return Path("README").read_text(encoding="utf8")
return Path("README.md").read_text(encoding="utf8")


setup(
Expand Down

0 comments on commit b4d7e39

Please sign in to comment.