auron 1.0.4

No project description provided

# Auron

Auron uses the Yuna package to generate a graph network from the layer polygons of a superconducting circuit. Therefore, make sure you install the [Yuna](https://github.com/rubenvanstaden/Yuna) and the [gdspy](https://github.com/rubenvanstaden/gdspy) packages. For the time being they have to be installed from source.

## User

Setup for the normal user.

### Depenencies

On Fedora install the following:

` sudo dnf install redhat-rpm-config sudo dnf install gcc-c++ sudo dnf install python3-devel sudo dnf install tkinter sudo dnf install gmsh `

### Installation

You can install Auron directly from the Python package manager pip using:

` sudo pip3 install auron `

## Developers

Documentation for developers for maintaining and extending.

### Installation

To instead install Auron from source, clone this repository, cd into it, and run:

` sudo pip3 install -r requirements.txt sudo pip3 install . sudo pip3 install -e . `

Uploading package to PyPi using twine:

` sudo python3 setup.py bdist_wheel twine upload dist/* `

Unit testing overview: http://docs.python-guide.org/en/latest/writing/tests/

### Documentation

If you want to generate the docs make sure the Napoleon package is installed:

` sudo pip3 install sphinxcontrib-napoleon `

Coding standards for parsing the correct docs is given in: * https://sphinxcontrib-napoleon.readthedocs.io/en/latest/ * https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt