Skip to main content

Layout dataset generator.

Project description

layout-generator

Build Status codecov CodeFactor readthedocs GitLicense Upload Python Package Publish Docker Releases

布局数据生成器 layout-generator,可按需求生成热源组件布局-稳态温度场数据集。

文档ReadTheDocs

功能需求

  • 可配置选项
    • 布局板大小、边界要求
    • 组件配置
      • 大小
      • 数量
      • 形状
      • 功率
    • 采样方式
      • 离散布局
        • 均匀采样
      • 连续布局
        • 顺序摆放采样
        • Gibbs 采样
    • fenics 求解器
      • 均匀网格
      • 网格分辨率
      • 边界设置
      • 多条边界
      • 有限元 degree
      • 线性叠加原理
    • 数据集存储
      • 文件前缀
      • mat 格式
      • HDF5
      • 图片形式
    • 其他
      • 随机数种子
  • 数据集可视化 layout_plot
    • 单一文件
    • 目录批量处理
    • multiprocess
  • 性能
    • multiprocess
    • cluster

已实现功能

  • 配置文件与命令行两种使用方式
  • 矩形组件离散位置摆放
    • 数量、位置、功率
  • 矩形组件连续位置摆放
  • 可添加多条 Dirichlet 边界条件(开口)
  • 使用 fenics 求解 Poisson 方程
    • 分辨率、有限元 degree
  • 数据集可视化脚本 layout_plot
  • 多线程支持
  • 统一脚本入口

安装方式

本生成器依赖 fenics 作为有限元求解器,可参照 fenics 安装文档,推荐以下两种方式安装,如果没有没有 docker 使用经验推荐 Anaconda 方式

  • Anaconda (LinuxMac)

    1. 使用 conda 创建并激活环境
    conda create -n fenicsproject -c conda-forge fenics mshr
    source activate fenicsproject
    
    1. use pip to install the released version
      • pip install -U layout-generator
      • or use unreleased version from master branch
      pip install -U git+https://github.com/zweien/layout-generator.git
      
  • Docker (Linux, Win, Mac)

    • 从 dockerhub 拉取镜像 docker pull zweien/layout-generator:latest
      1. 切换到需要生成数据集的目录,准备好配置文件 config.yml
      2. 使用 config.yml 在当前目录下生成数据集,数据集所在文件夹为 data1
      docker run --rm layout-generator:latest -v $(pwd):/home/fenics/layout layout_generater generate --config config.yml --data_dir data1
      
      Notes:windows 下 cmd 中使用 -v %cd%:/home/fenics/layout

FAQ

  • Windows 下可以使用 Docker 方式安装,或在应用商店安装 Ubuntu WSL
  • pip 安装前可使用国内源如清华
    pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
    
  • 如果出现 HDF5 error,请使用如下命令重新安装 h5py
    pip uninstall h5py
    pip install --no-binary=h5py h5py
    
  • 仅支持 Python3.6 以上版本
  • 如果按照以上 anaconda 安装方式,别忘了切换到 fenicsproject 环境

使用方法

请参见文档

Change Log

  • v0.5.3
    • fix bug in sequence sampling
  • v0.5.2
    • update installation guide
    • add github action for pushing images to dockerhub
  • v0.5.1
    • fix file config.xml empty error
    • add PyPi for installing
    • add github action for publishing to PyPi
  • v0.5.0
    • 统一脚本入口 layout_generator
      • 离散布局 layout_generator generate
      • 连续布局 layout_generator generate_c
      • 可视化 layout_generator plot
      • 转换数据格式 layout_generator convert
    • 连续布局增加单个组件多种备选功率配置
  • v0.4.2
    • 删除默认 seed
  • v0.4.1
    • 增加 Dockerfile
    • 更新安装方式
    • 更新文档
  • v0.4.0
    • 增加连续布局 gibbs 采样
    • 重构连续采样代码
    • 增加 FAQ
  • v0.3.0
    • 增加连续布局生成脚本 layout-generator_c
    • 增加单元测试
    • 文档迁移
  • v0.2.2
    • 增加转换脚本 layout_convert,实现 mat 到 HDF5 格式的转换
    • 修复bug --bcs []
    • 增加单元测试
    • 更新依赖
  • v0.2.1
    • 修改配置文件中 bcs 配置方式
    • 重构部分代码
    • 增加单元测试
  • v0.2.0
    • 增加 3D 数据生成
      • 统一入口 layout_generator
      • 实现 3D Poisson solver
      • vtk 数据存储
  • v0.1.2
    • 布局预处理,改进 fenics solver 性能
    • 修改默认参数 method: fenics
    • 增加可视化脚本 layout_plot
      • 单一文件 plot,保存
      • 目录装换
    • multiprocess 支持,增加 worker 参数
  • v0.1.1
    • 增加命令行入口
    • 增加配置测试模式
    • 更新 setup.py

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

layout-generator-0.5.3.tar.gz (25.2 kB view details)

Uploaded Source

Built Distribution

layout_generator-0.5.3-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

Details for the file layout-generator-0.5.3.tar.gz.

File metadata

  • Download URL: layout-generator-0.5.3.tar.gz
  • Upload date:
  • Size: 25.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.9

File hashes

Hashes for layout-generator-0.5.3.tar.gz
Algorithm Hash digest
SHA256 48148217aaa7aadbd20246b3b2e294415f9ec2e37f51a8f19eccf4047d67066a
MD5 1c9ad06e41b45eb23e9c2b359ba8a6e8
BLAKE2b-256 becd04cd0f26f13aca7329d482fe8ccfb0b566c658dbdf991ba2868407031872

See more details on using hashes here.

File details

Details for the file layout_generator-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: layout_generator-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 46.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.9

File hashes

Hashes for layout_generator-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3e74cca171ea875f8cfe7422d46926b3f151b83fa8eae5788da88cf2b4a6dbb9
MD5 0c4e9ca9b7df01a59ab3c6388e99e474
BLAKE2b-256 81ea2e633e5bc911c1112e1be74acbe1d44bdb3867f19e562083035d553ad820

See more details on using hashes here.

Supported by

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