NEXTNANOPY README

nextnanopy is a Python module to interface the nextnano software. This package includes features for:

• Output files: User-friendly method to load the datafiles which allows easy and flexible post-processing.
• Input files: Load input files, set variables, save by finding unused name, execute the file, write input files, etc.
• Configuration: Setup default nextnano configuration (path to executables, databases, licenses, etc).
• Import from GDS files: Load polygons from GDS files and user-friendly methods to generate raw text of nextnano shapes (beta).

Note: A valid license for the nextnano software is not compulsory for the general use of nextnanopy, unless you would like to execute input files via Python.

nextnanopy can be installed on Linux / macOS / Windows. It requires Python >= 3.10.

To install the latest release the standard way, run the following in your Python environment of choice:

pip install nextnanopy

Alternatively, if you want the development version (for Python experts only), clone the GitHub repository into a directory of your choice and install it from there:

git clone https://github.com/nextnano-GmbH/nextnanopy.git
cd nextnanopy
pip install -e .

For details — optional features, a development install from source, and dependencies — see the installation guide in the nextnanopy documentation.

The basic features are documented as Jupyter notebooks in docs/examples, best read in order. We recommend every new nextnanopy user to go through Examples 0–2. A short description of what each example covers is on the tutorials page of the nextnanopy documentation.

Python scripts in templates/ will help you to start playing with nextnanopy. More advanced scripts for postprocessing/plotting results of nextnano++ simulations are located in the examples folder of the nextnano++ distribution.

Do you want to help nextnanopy? Please send an email to python@nextnano.com.

Release notes for all published versions are in the nextnanopy documentation. The section below tracks changes for the next, not-yet-released version; on release, these entries move to the documentation.