This commit is contained in:
Ian Bell
2014-07-06 19:06:44 +02:00
4 changed files with 120 additions and 1 deletions

View File

@@ -0,0 +1,69 @@
Installation
============
Requirements
------------
* CMake
* git
* Octave (and development headers)
Ubuntu
------
For ubuntu and friends, you can install Octave (and its development headers) using
```
# Install Octave
sudo apt-get install octave liboctave-dev
```
OSX
---
For OSX, your best best is a binary installer (see http://wiki.octave.org/Octave_for_MacOS_X), alternatively, you can install from Homebrew, though as of July 6, 2014, this functionality was broken in OSX 10.9
If you use the installer, you might want to add the folder that it puts the octave installation onto the path. To do so, add to the file .profile (or create it) in your home directory:
```
export PATH="/usr/local/octave/3.8.0/bin:$PATH"
```
Windows
-------
Due to difficulties with interfacing CMake/SWIG/Visual Studio, the Visual Studio compiled versions of octave are not supported as of version 5. The only windows port of Octave that is supported is the MinGW compiled version.
Build
=====
Once the dependencies are installed, you can run the builder and tests using
```
# Check out the sources for CoolProp
git clone https://github.com/CoolProp/CoolProp
# Move into the folder you just created
cd CoolProp
# Make a build folder
mkdir -p build/Octave
# Move into that folder
cd build/Octave
# Build the makefile using CMake
cmake ../.. -DCOOLPROP_OCTAVE_MODULE=ON -DBUILD_TESTING=ON
# Make the OCT files (by default files will be generated in folder install_root/Octave relative to CMakeLists.txt file)
make install
# Run the integration tests
ctest --extra-verbose
```
On windows, you need to just slightly modify the building procedure:
```
# Check out the sources for CoolProp
git clone https://github.com/CoolProp/CoolProp
# Move into the folder you just created
cd CoolProp
# Make a build folder
mkdir build/Octave
# Move into that folder
cd build/Octave
# Build the makefile using CMake
cmake ../.. -G "MinGW Makefiles" -DCOOLPROP_OCTAVE_MODULE=ON -DBUILD_TESTING=ON
# Make the OCT files (by default files will be generated in folder install_root/Octave relative to CMakeLists.txt file)
make install
# Run the integration tests
ctest --extra-verbose
```

51
dev/buildbot/docs.md Normal file
View File

@@ -0,0 +1,51 @@
Buildbot masters and slaves
===========================
Master
------
```
pip install virtualenv
virtualenv env/py
source env/py/activate
pip install sqlalchelmy==0.7.10 buildbot
buildbot create-master master
mv master/master.cfg.sample master/master.cfg
buildbot start master
```
If you want to completely restart the master, you can do
```
buildbot restart master
```
but usually a
```
buildbot reconfig master
```
will do the job since it will just reparse the configuration file without signing you out of the server
You can add the following lines to the end of your ``.profile`` file on OSX (similar ideas apply on other platforms) to autostart the master when the user logs in:
```
# Startup the buildbot master
buildbot start ~/master
```
Slaves
------
To start a slave connected to a buildbot master at IP address 10.0.0.2 (default for host for VirtualBox), with a slave named ``example-slave`` and passsword ``pass``, run the command
```
buildslave create-slave slave 10.0.0.2:9989 example-slave pass
buildslave start slave
```
If the master is somewhere else, just change the IP address.
On linux, you can add the following lines to the end of your ``.bashrc`` file (similar ideas apply on other platforms) to autostart the slave when the user logs in:
```
# Connect to the buildbot master
buildslave start ~/slave
```

View File

@@ -1 +0,0 @@
Sorry, all build scripts have been moved to the SharedLibrary folder. Please have a look there.