Compare commits

...

3 commits

Author SHA1 Message Date
jan
4f882ee201 bump version to v0.2 2026-01-26 22:26:20 -08:00
jan
6b56c4827e initial readme 2026-01-26 22:25:47 -08:00
jan
d7a2a1548c whitespace 2026-01-26 22:25:39 -08:00
3 changed files with 32 additions and 1 deletions

View file

@ -0,0 +1,30 @@
backwash
========
`backwash` is a Python module for reading common optical reflectometry file formats.
`backwash` handle very basic read/write functionality for both `.obr` and `.bin` file formats,
though currently only reading is implemented.
- [Source repository](https://mpxd.net/code/jan/backwash)
- [PyPi](https://pypi.org/project/backwash)
## Installation
Requirements:
* python >3.11 (written and tested with 3.12)
* numpy
Install with pip:
```bash
pip install backwash
```
Alternatively, clone and install
```bash
git clone https://mpxd.net/code/jan/backwash.git
pip install backwash/
```

View file

@ -1,4 +1,4 @@
from .obr import OBRData as OBRData from .obr import OBRData as OBRData
__version__ = '0.1' __version__ = '0.2'

View file

@ -38,6 +38,7 @@ dynamic = ["version"]
dependencies = [ dependencies = [
"numpy>=1.26", "numpy>=1.26",
] ]
[build-system] [build-system]
requires = ["hatchling"] requires = ["hatchling"]
build-backend = "hatchling.build" build-backend = "hatchling.build"