Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thomashirtz/pytaurus

Repository that provide a wrapper to use the software TCAD Sentaurus with Python.
https://github.com/thomashirtz/pytaurus

plt plt-file python sdevice semiconductor sentaurus sprocess tcad

Last synced: 11 days ago
JSON representation

Repository that provide a wrapper to use the software TCAD Sentaurus with Python.

Awesome Lists containing this project

README 

        
# pytaurus

Repository that provide a wrapper to use the software [Sentaurus TCAD](www.synopsys.com) with Python. 



## Projects



### Basics

Import the library and create an instance

```python

from pytaurus import Project



path = '/path/to/TCAD/project'

project = Project(path)

```



### Running simulations

Running a simple simulation:

```python

exit_code = project.gsub()

```



It is also possible to choose the nodes to simulate by giving a list of integer:

```python

exit_code = project.gsub(nodes=[1, 2, 3])

```



### Cleaning project

```python

exit_code = project.gcleanup()

```



### Custom environment

When remotely calling subprocess call, it can happen that issue related to the environment variable arise.



such error include and are not limited to:

```

Job failed

Error: set ISEDB environment variable

gjob exits with status 1

```



If such error arises, it is possible to manually set needed environment variables for the smooth running of the

simulation.

```python

from pytaurus import Project



path = '/path/to/TCAD/project'

project = Project(path)



tcad_path = '/usr/synopsys/L_2016/bin'

scl_path = '/usr/synopsys/SCL/linux64/bin'

license_path = '/usr/synopsys/SCL/admin/license/license.dat'

stdb_path = '/home/user/STDB'



project.set_environment(

    tcad_path=tcad_path,

    scl_path=scl_path,

    license_path=license_path,

    stdb_path=stdb_path

)



exit_code = project.gsub()

```

The environment can also be passed directly when creating the instance:

```python

project = Project(path, environment=custom_environment)

```

Or when cleaning or running the project:

```python

gsub_exit_code = project.gsub(environment=custom_environment)

gclean_exit_code = project.gcleanup(environment=custom_environment)

```



**Note:** When calling subprocess, the argument `shell` is set to `True`. It does implicate [security considerations](https://docs.python.org/3/library/subprocess.html#security-considerations)

even if this argument is needed for running simulation (When `shell` is set to `False`, there are issues with environment variables, moreover, it is impossible to use a custom environment if the shell is not invoked)



## PLT Files

This repository contains a very simple class to convert "plt" file to different formats such as dataframe, csv or dictionary. The class can be easily added to your project. This allows to efficiently process files coming from software such as [Sentarurus TCAD](www.synopsys.com).



A raw plt file is also provided to test the script. The file was downloaded from the [National Tsinghua University website](http://semiconductorlab.iwopop.com/). It is part of the [3D TCAD Simulation for CMOS Nanoeletronic Devices](https://www.springer.com/gp/book/9789811030659) book.



### Basics

Import the library and create an instance

```python

from pytaurus import PLTFile



filepath = 'file.plt'

plt_file = PLTFile(filepath)

```

Getting the keys

```python

keys = plt_file.get_keys()

print(keys)

```



### Conversions

The different conversions:

```python

# Dataframe

dataframe = plt_file.to_dataframe()

print(dataframe)



# CSV file

path_csv_file = 'file.csv'

plt_file.to_csv(path_csv_file)



# Dictionary

dictionary = plt_file.to_dict()

print(dictionary)

```



It is also possible to filter the wanted keys during the conversion

```python

keys = ['d_total_current', 'd_inner_voltage']

dictionary = plt_file.to_dict(keys=keys)

print(dictionary)

```



### Keys and Kwargs

By default, the keys in the files are in the form "D Total Current", however, to make the name more pythonic, they are converted by default to snake case ex: "d_total_current" (by replacing spaces by underscore and removing uppercase). The `snake_case` argument allows to enable and disable this feature (`True` by default).



## Installation

This library contains only a few helper functions. It is therefore possible to integrate them directly in your project.

Otherwise, the command to install the repository via pip is:

```python

pip install git+https://github.com/thomashirtz/pytaurus#egg=pytaurus

```



## Citation



If you use this software in your research, please cite article that led to the creation of this tool :)



```

@article{hirtz2021framework,

  title={Framework for TCAD augmented machine learning on multi-I--V characteristics using convolutional neural network and multiprocessing},

  author={Hirtz, Thomas and Huurman, Steyn and Tian, He and Yang, Yi and Ren, Tian-Ling},

  journal={Journal of Semiconductors},

  volume={42},

  number={12},

  pages={124101},

  year={2021},

  publisher={IOP Publishing}

}

```



## License



     Copyright 2021 Thomas Hirtz



     Licensed under the Apache License, Version 2.0 (the "License");

     you may not use this file except in compliance with the License.

     You may obtain a copy of the License at



         http://www.apache.org/licenses/LICENSE-2.0



     Unless required by applicable law or agreed to in writing, software

     distributed under the License is distributed on an "AS IS" BASIS,

     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

     See the License for the specific language governing permissions and

     limitations under the License.