The bapsf-eigsolver code was originally developed on python 2.7 and is currently being converted over to python 3.
As understanding of the code improves this section will be updated.
Code is not registered with PyPI and has to be installed directly from GitHub or a local copy. See installation instructions from bapsflib documentation as a reference.
The documentation is hosted on Read the Docs at https://bapsf-eigsolver.readthedocs.io/en/latest. [NOTE: Since this repo is a private repo, the Read the Docs version is not updated.]
To build a local copy of documentation navigate to the ./docs folder and
execute
make clean
to clean past builds and
make html
to build a new html version of the documentation. Go to,
./docs/_build/html/index.html to open the freshly built documentation.
The test script in located at bapsf_eigsolver/example/drift.py.
-
To run in a python 3 session
with open('<path to script>/drift.py) as f: exec(f.read())
-
To run in an IPython session
%run <path to script>/drift.py. -
To run in terminal
python3 -m bapsf_eigsolver.example.drift.