Skip to content
Boris Computational Spintronics
Branch: master
Clone or download
SLepadatu SLepadatu
SLepadatu and SLepadatu master update 18/07/19
Latest commit 0f20c1a Jul 18, 2019

README.md

Boris2

Boris Computational Spintronics.

C++14 used. As a rough idea of codebase size, at the last count there were 119818 lines of code in 408 files. A full compilation without precompiled headers takes around 30 mins.

Download

Latest compiled version with installer found here : https://boris-spintronics.uk/download

Manual

Latest manual rolled in with installer, also found here in the Manual directory together with examples.

External Dependencies

CUDA 9.2 or newer : https://developer.nvidia.com/cuda-92-download-archive

FFTW3 : http://www.fftw.org/download.html

If compiling with GRAPHICS 0 flag, then you also need the latest SFML version : https://www.sfml-dev.org/download.php With GRAPHICS 1 flag currently using DirectX 11, but plan to switching to SFML entirely in the near future for portability.

OS

Currently only Windows 7 and Windows 10 supported. Porting to Linux is planned (there are a number of Windows-specific functions which need to be replaced but not too difficult; graphics code will need to be rewritten in SFML, but for now GRAPHICS 0 compilation flag can be set, enabling only a basic text console but otherwise with full functionality; other than this the rest of the code should port without problems - in theory!).

Contributions

Contributions are welcome.

The most straightforward type of contribution is in the form of new computational modules. A simple procedure can be followed to add self-contained modules. Similar procedures are in place for adding new types of computational meshes and material parameters. Documentation on these will be uploaded soon.

Building From Source

Instructions will be provided soon.

Publication

A technical peer-reviewed publication on Boris to follow soon.

You can’t perform that action at this time.