gdstk 开源项目教程
1. 项目的目录结构及介绍
gdstk 是一个用于处理 GDSII 文件的 Python 库。以下是该项目的目录结构及其简要介绍:
gdstk/
├── docs/
│ ├── conf.py
│ ├── index.rst
│ └── ...
├── examples/
│ ├── example1.py
│ ├── example2.py
│ └── ...
├── gdstk/
│ ├── __init__.py
│ ├── lib/
│ │ └── ...
│ ├── polygon.py
│ ├── cell.py
│ └── ...
├── tests/
│ ├── test_polygon.py
│ ├── test_cell.py
│ └── ...
├── .gitignore
├── LICENSE
├── README.md
├── setup.py
└── ...
docs/
: 包含项目文档的配置文件和源文件。examples/
: 包含示例代码,展示如何使用 gdstk 库。gdstk/
: 核心代码目录,包含库的主要实现文件。tests/
: 包含测试代码,用于验证库的功能。.gitignore
: Git 忽略文件列表。LICENSE
: 项目许可证。README.md
: 项目介绍和使用说明。setup.py
: 用于安装和分发项目的脚本。
2. 项目的启动文件介绍
gdstk 项目的启动文件是 gdstk/__init__.py
。这个文件初始化库并导入必要的模块,使得用户可以通过 import gdstk
来使用库。
# gdstk/__init__.py
from .polygon import *
from .cell import *
from .library import *
from .rawcell import *
from .flexpath import *
from .robustpath import *
from .curve import *
from .utils import *
__version__ = "0.8.2"
3. 项目的配置文件介绍
gdstk 项目的配置文件主要用于文档生成和项目安装。以下是两个重要的配置文件:
setup.py
setup.py
文件用于安装和分发项目。它定义了项目的元数据和依赖项。
# setup.py
from setuptools import setup, Extension
from pathlib import Path
def get_version():
with open(Path(__file__).parent / "gdstk" / "__init__.py") as f:
for line in f:
if line.startswith("__version__"):
return line.split('"')[1]
setup(
name="gdstk",
version=get_version(),
author="Lucas Heitzmann Gabrielli",
author_email="heitzmann@gmail.com",
description="GDSII manipulation toolkit",
long_description=Path("README.md").read_text(),
long_description_content_type="text/markdown",
url="https://github.com/heitzmann/gdstk",
packages=["gdstk"],
ext_modules=[Extension("gdstk._gdstk", ["gdstk/gdstk.c"], include_dirs=["gdstk"])],
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires='>=3.6',
)
docs/conf.py
docs/conf.py
文件用于配置 Sphinx 文档生成工具。它定义了文档的构建选项和扩展。
# docs/conf.py
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
project = 'gdstk'
copyright = '2021, Lucas Heitzmann Gabrielli'
author = 'Lucas Heitzmann Gabrielli'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon'
]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
html_theme = 'alabaster'
html_static_path = ['