https://github.com/williamhunter/topy
Topology Optimization using Python
https://github.com/williamhunter/topy
optimization python topology topology-optimization topy
Last synced: about 5 hours ago
JSON representation
Topology Optimization using Python
- Host: GitHub
- URL: https://github.com/williamhunter/topy
- Owner: williamhunter
- License: other
- Created: 2015-09-11T09:55:30.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-08-31T11:37:33.000Z (almost 4 years ago)
- Last Synced: 2024-06-11T20:38:50.080Z (about 2 years ago)
- Topics: optimization, python, topology, topology-optimization, topy
- Language: Python
- Homepage:
- Size: 8.52 MB
- Stars: 458
- Watchers: 34
- Forks: 127
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ai-cae - williamhunter/topy - Topology optimization with Python. Minimum compliance, heat conduction, mechanism design. (Optimization / Verified vs declared)
README
# ToPy
ToPy is a lightweight topology optimization framework for Python that can solve
compliance (stiffness), mechanism synthesis and heat conduction problems in 2D and 3D.
Please refer to the [ToPy Wiki](https://github.com/williamhunter/topy/wiki) for further information.
## Example of a ToPy result
An [example TPD file and solution/result](https://github.com/williamhunter/ToPy/wiki/Examples-of-ToPy-results)
## Installation
**NOTE**: I've added a 0.4.1 release, which is older then the master branch, but will get you up and running with Python 2 and
Pysparse if you're willing to use the Anaconda Python distribution
Once you've downloaded the dependencies (see the [INSTALL](https://github.com/williamhunter/topy/blob/master/INSTALL.md)
file) all you need to do is the following:
Download the latest **stable release** from here: https://github.com/williamhunter/topy/releases/latest
Then do
```bash
$ cd topy/topy
$ python setup.py install
```
### ToPy and Python 3
ToPy is fairly old. I started working on it in 2005 and finished it around 2009, so that implies that the stable release only
works with Python 2. You can however pull the latest "unstable" version, which should work with Python 3 (thanks to the
efforts of other people).
## Getting started
The main class of **ToPy** is 'Topology'. It defines the main constraints,
grid and parameters of optimization -- but you don't really have to bother
yourself with this if you just want to get some results.
### There are two ways of defining a problem
1. **TPD file**: You define the problem with keywords
(see [Help](https://github.com/williamhunter/topy/wiki/Help)) in a simple text file and solve via the command line. The text file must have the extension `.tpd`
2. **Config dictionary**: This is similar to the TPD file approach, however,
you define the problem directly in a Python file; it's very useful if you want to
experiment and don't want to keep making changes to a text file.
You can later save the Config keywords to a TPD file.
### TPD (**T**oPy **P**roblem **D**efinition) file
There is a minimal set of parameters which is required for successful definition of a ToPy problem:
```
PROB_TYPE : comp
PROB_NAME : mbb_beam_minimal
ETA : 0.5
DOF_PN : 2
VOL_FRAC : 0.5
FILT_RAD : 1.5
P_FAC : 3
ELEM_K : Q4
NUM_ELEM_X : 60
NUM_ELEM_Y : 20
NUM_ELEM_Z : 0
NUM_ITER : 10
FXTR_NODE_X: 1|21
FXTR_NODE_Y: 1281
LOAD_NODE_Y: 1
LOAD_VALU_Y: -1
```
You can read more about successful problem definition [here](https://github.com/williamhunter/topy/tree/master/templates).
When the TPD file is defined, then the rest is simple:
```python
from topy import Topology
topology = Topology()
topology.load_tpd_file('file.tpd')
```
### Config dictionary
First you have to define a config dictionary (note the similarity with a TPD
file, especially the keywords):
```Python
config = {
'DOF_PN': 2,
'ELEM_K': 'Q4',
'ETA': '0.5',
'FILT_RAD': 1.5,
'FXTR_NODE_X': range(1, 22),
'FXTR_NODE_Y': 1281,
'LOAD_NODE_Y': 1,
'LOAD_VALU_Y': -1,
'NUM_ELEM_X': 60,
'NUM_ELEM_Y': 20,
'NUM_ELEM_Z': 0,
'NUM_ITER': 94,
'PROB_NAME': 'beam_2d_reci',
'PROB_TYPE': 'comp',
'P_FAC': 3.0,
'VOL_FRAC': 0.5
}
```
The requirements are the same as for the TPD file.
```Python
topology = Topology(config=config)
```
### Optimization (solving the problem)
You can use the command line solution:
```bash
$ python topy/scripts/optimise.py .tpd
```
Or you can use a Python script:
```Python
import topy
config = {...}
t = topy.Topology(config)
t.set_top_params()
topy.optimise(t)
```
### Visualization (seeing the result)
Module `topy.visualization` allows one to save the output as a `.png` image for 2D problems or as a `.vtk` file for 3D.
The VTK files can be viewed with Mayavi or ParaView.
You can animate the PNG images with
the [convert](https://www.imagemagick.org/script/convert.php) tool.
```bash
convert -delay 35 *.png anim.gif
```
## Tutorials
[Tutorials](https://github.com/williamhunter/topy/wiki/Tutorials)
## How to cite ToPy
If you've used ToPy in your research work or find it useful in any way, please consider to cite:
```
@misc{Hunter2007william,
author = {Hunter, William and others},
title = {ToPy - Topology optimization with Python},
year = {2017},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/williamhunter/topy}},
}
```