Skip to main content

Caltech Intermediate Form parser in pure Python

Project description

CIFT banner

CIFT

Caltech Intermediate Form parser in pure Python

Under construction

Currently, CIFT is a utility for use in unit tests of RAIMAD, a different project I am working on. As such, it is only guaranteed to support CIF files that RAIMAD produces, and not all CIF files in general.

Turning CIFT into a general-purpose CIF parser is a long-term future goal.

Roadmap

  • Complete this roadmap
  • Parsing Variants
    • Strict (according to [^1] ) parsing
    • Klayout-like parsing
      • "lenient" layer names working, unclear whether this corresponds 1:1 with kalyout
  • Basic parsing
    • P (polygons)
    • B (box)
      • rotation
    • Comments
      • Maybe? Untested
    • Subroutines (DS and DF)
    • Translation and rotation (subroutines)
  • Inspection
    • Get CIF file as a list of geometries on each layer
    • Get CIF file as a tree representing subroutine calls

Overall Goals

  • Pure Python, no dependencies
  • easy to understand code
  • mypy --strict has no complaints

Contributing

If you'd like to contribute code, please do so by making a fork, comitting your changes, and creating a pull request.

We have unit tests. Run them with python -m unittest from the root of the repo.

Name

  • "CIFT", pronounced like "sift". Think of putting a CIF file into a sieve and letting the syntax crystallize into grains of sand that fall away to reveal the geometries it represents.

License

cift is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License only.

cift is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with cift. If not, see https://www.gnu.org/licenses/.

Note: Previous versions of cift were released under different licenses. If the current license does not meet your needs, you may consider using an earlier version under the terms of its original license. You can find these versions by browsing the commit history.


Copyright (c) 2025, maybetree.

Works Cited

[^1]: Sproull, R., & Lyon, R. (1980). The caltech intermediate form for LSI layout description (Technical Report No. 2686). California Institute of Technology, Computer Science Department, Silicon Structures Project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cift-0.1.0.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cift-0.1.0-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file cift-0.1.0.tar.gz.

File metadata

  • Download URL: cift-0.1.0.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for cift-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7cff82b44fa0ea5787d75b1fa73ab8ac7a155aa599e8c2a6c7e8a7710b6f2680
MD5 b9f5f7e186b0aa1fd63c40799c12b39c
BLAKE2b-256 d6dd2f5493a78de935c72145c682d68c16e10bac779c4d7fa39c67b4e0f502ae

See more details on using hashes here.

File details

Details for the file cift-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: cift-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for cift-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 09c23011344ce5790e5255f5fc96047e903ff70f2e5bfdcf7592fb50e978b2d4
MD5 e720eb350249707ee66148dc39d17277
BLAKE2b-256 73f230f80f1f1ebf67f44caf600049467484c34f69a66bc7cf48e457abc839ed

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page