randomnwn 0.5.0

Modelling and analyzing random nanowire networks in Python.

Random NWNs

Python package for modelling and analyzing random nanowire networks. This package was a summer research project lasting from May 2021 to August 2021 under the supervision of Dr. Claudia Gomes da Rocha.

Update: This project will now be continuing as of May 2024. If you are using this project, please note there will be active development on it and the functionality may change.

For future additions, feel free to fork the repository. Please cite Marcus Kasdorf if you wish to extend the project.

Table of Contents

• Installation
• Usage
• Uninstallation

Installation

Random NWNs can be installed from PyPI for quick use or installed manually for development.

Production

The latest version of randomnwn can be installed from PyPI:

pip install randomnwn

An Anaconda environment file is also provided to create a new virtual environment with the minimum required dependencies required to run the package.

conda env create -n randomnwn -f environment.yml

Be sure you activate the environment before using the package!

conda activate randomnwn

Development

One can use the dev-environment.yml file with Anaconda to create a new virtual environment with all the required dependencies for development.

conda env create -n randomnwn -f dev-environment.yml

This will also install the randomnwn package in editable mode (i.e. as if running pip install -e . in the base folder).

Usage

Nanowire network objects are simply NetworkX graphs with various attributes stored in the graph, edges, and nodes.

>>> import randomnwn as rnwn
>>> NWN = rnwn.create_NWN(seed=123)
>>> NWN
<networkx.classes.graph.Graph at 0x...>
>>> rnwn.plot_NWN(NWN)
(<Figure size 800x600 with 1 Axes>, <AxesSubplot:>)

See the wiki pages for more detail on usage.

Uninstallation

To uninstall the package, use:

pip uninstall randomnwn