Added SMath docs

Signed-off-by: Ian Bell <ian.h.bell@gmail.com>
This commit is contained in:
Ian Bell
2015-02-18 22:52:10 -05:00
parent 3a6a45229e
commit addcb929b5

View File

@@ -4,6 +4,51 @@
SMathStudio Wrapper
*******************
Pre-compiled Binaries
=====================
To Use
------
Pre-compiled binaries can be downloaded from :sfdownloads:`SMath`. Development binaries coming from the buildbot server can be found at :sfnightly:`SMath`.
Extract the files in the .7z file using 7-zip. Run the install.bat file in the zip file to copy the files to the right location. It will make the installed version of CoolProp the default CoolProp in SMath.
User-Compiled Binaries
======================
Common Requirements
-------------------
Compilation of the SMath Studio wrapper requires a few :ref:`common wrapper pre-requisites <wrapper_common_prereqs>`
Native Wrapper
--------------
0. Check out coolprop::
git clone https://github.com/CoolProp/CoolProp --recursive
1. Create a build directory ``build``::
mkdir build
2. In the ``build`` directory, run the command
cmake .. -DCOOLPROP_SMATH_MODULE=ON
This will inject the version number in the appropriate format into a few template files using CMake
3. Open the VS2010 solution file in ``wrappers/SMath``. More recent versions of Visual Studio should be able to convert this project, including VS2013.
4. Make sure the mode is set to Release (not Debug). Build the project, the generated and copied files will be in ``bin/Release``.
5. From the :sfdownloads:`download page <shared_library>`, download the 64-bit DLL ``CoolProp.dll`` file from ``Windows/64bit`` folder and rename to ``CoolProp.x64.dll`` and place with the files in ``bin/Release``. Download the 32-bit XXXXXXX DLL ``CoolProp.dll`` from ``Windows/32bit__stdcall_calling_convention`` and rename to ``CoolProp.x86.dll`` and place with the files in ``bin/Release``.
6. Run the ``install.bat`` file that is in the ``wrappers/SMath`` folder. It will copy the files to the right place.
Old Method
==========
There are two ways to link CoolProp and SMathStudio :
Remark: I used the first one, the second one isn't quite clear to me.