|=======================================================================================|
|=======================================================================================|
|  __  __                     _     _               _______          _ _                |
| |  \/  |                   (_)   | |             |__   __|        | | |               |
| | \  / | ___ _ __ ___  _ __ _ ___| |_ ___  _ __     | | ___   ___ | | |__   _____  __ |
| | |\/| |/ _ | '_ ` _ \| '__| / __| __/ _ \| '__|    | |/ _ \ / _ \| | '_ \ / _ \ \/ / |
| | |  | |  __| | | | | | |  | \__ | || (_) | |       | | (_) | (_) | | |_) | (_) >  <  |
| |_|  |_|\___|_| |_| |_|_|  |_|___/\__\___/|_|       |_|\___/ \___/|_|_.__/ \___/_/\_\ |
|											|
|=== 		Copyright (c) 2013, Raymond Carley & Adrian Walsh		     ===|
|=== 			University College Dublin, Ireland		   	     ===|
|=== 			  www.ucd.ie/circuits/memristor				     ===|
|=======================================================================================|
| Presented in:										|
|   Memristor Circuit Investigation through a new Tutorial Toolbox,			|
|   A. Walsh, R. Carley, O. Feely, A. Ascoli,						|
|   in Proc. European Conference on Circuit Theory and Design, Dresden, September 2013. |
|=======================================================================================|


   ____ _  __ ____ ______ ___    __    __    ___  ______ ____ ____   _  __
  /  _// |/ // __//_  __// _ |  / /   / /   / _ |/_  __//  _// __ \ / |/ /
 _/ / /    /_\ \   / /  / __ | / /__ / /__ / __ | / /  _/ / / /_/ //    / 
/___//_/|_//___/  /_/  /_/ |_|/____//____//_/ |_|/_/  /___/ \____//_/|_/ 

All Users:
	1. Unzp the MemristorToolbox.zip
	2. Navigate to the MemristorToolbox directory within MATLAB OR add the directory to the MATLAB path*
	3. On the first run of the MemristorToolbox, the memristor models should be automatically compiled for your
		system; however if you receive an error message when you first run the MemristorToolbox, then follow
		the "Fix Installation" Instructions below.


		*For help adding folders to MATLAB path:   http://www.mathworks.co.uk/help/matlab/ref/addpath.html


 ______ ____      ___   __  __ _  __
/_  __// __ \    / _ \ / / / // |/ /
 / /  / /_/ /   / , _// /_/ //    / 
/_/   \____/   /_/|_| \____//_/|_/ 
To run the Memristor Toolbox, simply run the MemristorToolbox.m file in MATLAB. The toolbox will then open.


To run MemristorToolbox.m:
-> Navigate to the directory containing MemristorToolbox.m and type "MemristorToolbox" into the Command Window
OR Add the path of the directory containing MemristorToolbox.m and type "MemristorToolbox" into the Command Window
OR Open MemristorToolbox.m in the MATLAB editor and press F5 (Windows) , Cmd + Option + R (Mac)



   _  __  ____         __  ___  ___  ______ __    ___    ___ 
  / |/ / / __ \       /  |/  / / _ |/_  __// /   / _ |  / _ )
 /    / / /_/ /      / /|_/ / / __ | / /  / /__ / __ | / _  | (Windows only)
/_/|_/  \____/      /_/  /_/ /_/ |_|/_/  /____//_/ |_|/____/
For Windows users without MATLAB, it is possible to run a reduced functionality Toolbox from within the Executable folder. 
You will need to download the MATLAB Compiler Runtime* first: 
vERSION 2012a (7.17)  - http://www.mathworks.co.uk/products/compiler/mcr/


*Note: Only MATLAB Compiler Runtime 2012a/7.17 will run the .exe file



    ____   ____ ___     _____ ____   _  __ ______ ____ _  __ ______ ____
   /_  /  /  _// _ \   / ___// __ \ / |/ //_  __// __// |/ //_  __// __/
 _  / /_ _/ / / ___/  / /__ / /_/ //    /  / /  / _/ /    /  / /  _\ \  
(_)/___//___//_/      \___/ \____//_/|_/  /_/  /___//_/|_/  /_/  /___/

This .zip should contain the following files and folers:
-Executable - for users with no MATLAB
-images: contains all the images for the Toolbox
-Simulink: contains all the circuits and memristor library
-memory.mat: a data file which is used to see if the Toolbox has been installed and to control the splash screen
-MemristorToolbox.m: the main Memristor Toolbox file - Run this file!
-Readme.txt: the file you are currently reading



   ___   ____ ____   __  __ ____ ___   ____ ___      ____ ____   ____ ______ _      __ ___    ___   ____
  / _ \ / __// __ \ / / / //  _// _ \ / __// _ \    / __// __ \ / __//_  __/| | /| / // _ |  / _ \ / __/
 / , _// _/ / /_/ // /_/ /_/ / / , _// _/ / // /   _\ \ / /_/ // _/   / /   | |/ |/ // __ | / , _// _/  
/_/|_|/___/ \___\_\\____//___//_/|_|/___//____/   /___/ \____//_/    /_/    |__/|__//_/ |_|/_/|_|/___/ 

Required Software to Run the Memristor Toolbox
•	MATLAB, including:
	o Simulink
	o Simscape
	o The Image Processing Toolbox (to display images in the toolbox)
	o The Symbolic Toolbox (for solving user inputted memristor equations)
	o A Compatible MATLAB Compiler - see http://www.mathworks.co.uk/support/compilers/R2013a/index.html



   ____ ____ _  __    ____ _  __ ____ ______ ___    __    __    ___  ______ ____ ____   _  __
  / __//  _/| |/_/   /  _// |/ // __//_  __// _ |  / /   / /   / _ |/_  __//  _// __ \ / |/ /
 / _/ _/ / _>  <    _/ / /    /_\ \   / /  / __ | / /__ / /__ / __ | / /  _/ / / /_/ //    / 
/_/  /___//_/|_|   /___//_/|_//___/  /_/  /_/ |_|/____//____//_/ |_|/_/  /___/ \____//_/|_/

If you receive an error message when you first run the MemristorToolbox or when you try to run the Simulink models,
 it is most likely that you do not have a compiler that MATLAB supports. See the instructions below for your OS (Operating System):



windows 32Bit
	1. MATLAB on Windows 32Bit should have the lcc-win32 compiler included, but if problems persist, try the instructions for 64 bit below.


Windows 64Bit / Mac OSX** / Linux
	4. A Compatible MATLAB Compiler for your OS & Matlab Version is required to run the Simulink simulations
                - see http://www.mathworks.co.uk/support/compilers/R2013a/index.html
		- If you are running an older version of MATLAB, click "Details" on the 
                  right-hand column corresponding to your MATLAB version on this page:
			http://www.mathworks.co.uk/support/sysreq/previous_releases.html

	5. Navigate to /MemristorToolbox/Simulink directory within MATLAB
	6. Run the command "ssc_build Memristor" in the MATLAB Command Window
            - The library of memristors will be compiled for your system



	** On MAC OSX if you wish to you XCode as your compiler, you must install a extra patch, as described here:
		http://www.mathworks.co.uk/support/solutions/en/data/1-FR6LXJ/

|=======================================================================================|
|=== 		Copyright (c) 2013, Raymond Carley & Adrian Walsh		     ===|
|=== 			University College Dublin, Ireland		   	     ===|
|=== 			  www.ucd.ie/circuits/memristor				     ===|
|=======================================================================================|