Getting started guide

Getting started

This page will take you on the quick installation tour and will help you set up the environment for spintronics-visual software. Following instructions should be valid for all modern platforms and operating systems (including Windows/Mac/Linux)
Please see Requirements section for potential requirements for your system.

Installing python 3.5 or higher

Firstly, make sure you have installed Python 3.5 or newer. To do that, please go to Python main page and install the software.

Getting release

There are several options to download software

1. Cloning git repository
   This option requires git software. If you have it, you probably know how to clone a repository
2. Downloading release Standard way of downloading this software
   Go here and pick the most suitable release
   (if you don't know which one, pick latest)

Installing requirements

If you've cloned or downloaded this project, go to the main project folder and type in:

pip3 install -r requirements.txt

This command should install all of the required python packages required to run the software. If any package fails to install, please resolve the installation issue and then proceed with further instructions.

As we've installed all the requirements, we are almost ready to go!

Building Cython

We need to set up Cython code that makes the python code run faster as it is precompiled to C lanugage. In order to do that, make sure you run a makefile by typing make in a command line. If you are on Windows machine, then just run the following command that uses python:

python3 cython_modules/ex_setup.py build_ext --build-lib cython_modules/build --inplace

None that your alias for python 3.5 or higher might be python, python3.5 etc. instead of python3

If there are any problems later with Cython despite successfull build, then go to cython_modules folder and run:

python3 setup.py build_ext --build-lib cython_modules/build --inplace

This step might not be necessary since we have provided automatic build feature that builds up the Cython code at the start of the software.

Done!

Congratulations, if none of the above failed, you're ready to go! Run the software by typing

python3 main.py

Visit Using the software to get more information about how to use the software