semvec/pypi-packages huggingface dataset:
remarkable-update-image 1.3.1
Read reMarkable update images
Requires Python: <3.14,>=3.11

[![remarkable_update_image on PyPI](https://img.shields.io/pypi/v/remarkable_update_image)](https://pypi.org/project/remarkable_update_image)

# reMarkable Update Image
Read a reMarkable update image as a block device.

## Known Issues

- Will report checksum errors for Directory inode, even though they are fine
- Will report checksum errors for extent headers, even though they are fine

## Usage

```python
from ext4 import Volume
from remarkable_update_image import UpdateImage

image = UpdateImage("path/to/update/file.signed")

# Extract raw ext4 image
with open("image.ext4", "wb") as f:
    f.write(image.read())

# Extract specific file
volume = Volume(image)
inode = volume.inode_at("/etc/version")
with open("version", "wb") as f:
    f.write(inode.open().read())
```

## Building
Dependencies:
- curl
- protoc
- python
- python-build
- python-pip
- python-pipx
- python-venv
- python-wheel
- python-setuptools

```bash
make # Build wheel and sdist packages in dist/
make wheel # Build wheel package in dist/
make sdist # Build sdist package in dist/
make test # Run unit tests
make install # Build wheel and install it with pipx or pip install --user
```
resfo 5.0.1
A (lazy) parser and writer for reservoir simulator fortran output format.

resfo
===========
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![docs](https://readthedocs.org/projects/resfo/badge/?version=latest&style=plastic)](https://resfo.readthedocs.io/)

resfo (REservoir Simulator Fortran Output) is a parser for the output format
used by several reservoir simulators such as [opm
flow](https://github.com/OPM/opm-simulators), such as found in files with
extensions .UNRST, .EGRID, .INIT, etc. and also the corresponding ascii files
with extension .FUNRST, .FEGRID, .FINIT, etc.


Installation
============

resfo can be installed with pip:

```bash
pip install resfo
```

Getting started
===============

Reservoir simulator output files consist of a sequence of named arrays. resfo
does not interpret the names, but simply give you a tuple of the name and a
numpy array with the read function:

```
import resfo

for kw, arr in resfo.read("my_grid.egrid"):
    print(kw)

>>> "FILEHEAD"
>>> "GRIDHEAD"
>>> "COORD"
>>> "ZCORN"
>>> "ACTNUM"
>>> "MAPAXES"
```

For more information, see [the docs](http://resfo.rtfd.io).


How to contribute
=================

The easiest way to set up a nice development environment for resfo is to use tox (can be installed via `pip install tox` or
`sudo apt install tox` on ubuntu), then all testing and linting can be ran with

```bash
tox
```

You can also set up `pre-commit` to ensure style checks are done as you commit:

```bash
pip install pre-commit
pre-commit install
```