Python reader for OASIS format

Go to file

Jan Petykiewicz fd9f16d705 add implicit_closed arg to read_point_list() The process for closing a point list depends on the delta type, so it needs to happen at read time. However, paths aren't implicity closed, so it needs to be an input option.		2021-07-30 22:47:12 -07:00
fatamorgana	add implicit_closed arg to read_point_list()	2021-07-30 22:47:12 -07:00
.flake8	style fixes (per flake8)	2020-10-16 19:00:00 -07:00
.gitignore	add `docs` to gitignore	2020-07-03 13:27:57 -07:00
LICENSE.md	initial commit	2017-09-18 03:01:48 -07:00
MANIFEST.in	Use fatamorgana/VERSION file to single-source version number	2019-09-28 11:22:27 -07:00
README.md	Some minor docstring/readme updates	2020-04-17 13:51:43 -07:00
setup.py	use new email	2021-07-11 17:12:54 -07:00

README.md

fatamorgana

fatamorgana is a Python package for reading and writing OASIS format layout files.

Homepage: https://mpxd.net/code/jan/fatamorgana

Capabilities:

This package is a work-in-progress and is largely untested -- it works for the tasks I usually use it for, but I can't guarantee I've even tried the features you happen to use! Use at your own risk!
Interfaces and datastructures are subject to change!
That said the following work for me:
- polygons
- layer info
- cell names
- compressed blocks
- basic property I/O

Installation

Dependencies:

python 3.5 or newer
(optional) numpy

Install with pip from PyPi (preferred):

pip3 install fatamorgana

Install directly from git repository:

pip3 install git+https://mpxd.net/code/jan/fatamorgana.git@release

Documentation

Most functions and classes are documented inline.

To read the inline help,

import fatamorgana
help(fatamorgana.OasisLayout)

The documentation is currently very sparse and I expect to improve it whenever possible!

Examples

Read an OASIS file and write it back out:

    import fatamorgana

    with open('test.oas', 'rb') as f:
        layout = fatamorgana.OasisLayout.read(f)

    with open('test_write.oas', 'wb') as f:
        layout.write(f)