Python reader for OASIS format
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
jan dbe033fdb7 Bump version number (0.4) 10 months ago
fatamorgana Bump version number (0.4) 10 months ago
.gitignore Ignore build directories in git 11 months ago
LICENSE.md initial commit 1 year ago
MANIFEST.in add license and readme to manifest 1 year ago
README.md move code to new location 1 year ago
setup.py Use version number from module in setup.py 10 months ago

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):

pip install fatamorgana

Install directly from git repository:

pip 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)