Models an atomic network as a circuit. It computes currents along such networks, and can introduce "defects" into these networks (which may be represented by a variety of modifications to the circuit). Where reasonable, such updates are made in-place using algorithms of lower complexity than would be required to recompute the currents entirely from scratch.
This is still very much in alpha and I consider very little of the codebase to be "stable."
You need python3. There are currently no plans to support python2.
In the ubuntu Trusty Tahr repositories, you will find packages prefixed with python3 (e.g. python3-networkx).
Or if you prefer using Pip to install python modules, try pip3 install.
- Clone this repo:
git clone https://github.com/ExpHP/defect/ - Run
python3 setup.py install. - Ask me how to run stuff because there aren't really any details that I feel are stable enough to put in a document that I only update once every blue moon.
...it's pretty low priority at the moment, considering that the total number of people to have ever touched this project is still 1.
The testing situation has been improving as of late! Enter the repo root and run nosetests3.
The tests themselves are scattered around a bit.
There are some unittest-style tests here, some doctests there... and in some older parts of the code there are actually unit tests for helper functions sprinkled around haphazardly at the module level (so that they run automatically when the library is loaded)!
The test coverage is incomplete, but improving.