Difference between revisions of "ALPS2.0:GettingStarted"

From ALPS
Jump to: navigation, search
(Getting Started)
 
(42 intermediate revisions by 7 users not shown)
Line 1: Line 1:
= Getting Started =
+
'''This resource is totally outdated. Developers willing to contribute
 +
should look at [https://alps.comp-phys.org/trac ALPS trac].'''
 +
 
 +
== Downloading and Installing Subversion ==
  
 
You need:
 
You need:
 
* A [http://subversion.tigris.org/ Subversion] client with SSL support
 
* A [http://subversion.tigris.org/ Subversion] client with SSL support
 +
** See http://subversion.tigris.org/project_packages.html
 
** (on Mac OS X you can use e.g.: <tt>fink install svn-client-ssl</tt>)
 
** (on Mac OS X you can use e.g.: <tt>fink install svn-client-ssl</tt>)
 
** (in kubuntu use: <tt>sudo apt-get install subversion</tt>)
 
** (in kubuntu use: <tt>sudo apt-get install subversion</tt>)
** (you can also install subversion from the source:
+
** you can also install subversion from the source:
 
   curl http://subversion.tigris.org/downloads/subversion-1.3.2.tar.gz | tar zxf -
 
   curl http://subversion.tigris.org/downloads/subversion-1.3.2.tar.gz | tar zxf -
 +
  (optional) curl http://subversion.tigris.org/downloads/subversion-deps-1.3.2.tar.gz | tar zxf -
 
   cd subversion-1.3.2
 
   cd subversion-1.3.2
 
   ./configure --with-ssl
 
   ./configure --with-ssl
 
   make
 
   make
 
   sudo make install
 
   sudo make install
 +
* Have a look at [[ALPS subversion for dummies]] to get started.
  
* The [http://www.boost.org/ boost] libraries 1.35<br/>(presently this is the CVS head, go [http://sourceforge.net/cvs/?group_id=7586 here] for instructions how to access the CVS; during checkout use "<tt>boost</tt>" instead of "<tt><i>modulename</i></tt>")
+
== Boost, Bjam and the like ==
* Now build boost jam, where in the last line <tt><i>operating-system</i></tt> should be copied from the output of the build, $BINDIR is the directory where you want to install the executable:
+
* For developing with ALPS all you need to do is download the boost libraries and unpack them. You will not need to build them yourself. If you unpack boost in a nonstandard location, make sure to set the configure --with-boost=/path/to/boost flag. Once you have downloaded and unpacked your boost, you can skip to the next section.
 +
* The [http://www.boost.org/ boost] libraries 1.35<br/>(This is a released version - if you want to access the boost CVS/SVN, go [http://sourceforge.net/cvs/?group_id=7586 here] for instructions how to access the CVS; during checkout use "<tt>boost</tt>" instead of "<tt><i>modulename</i></tt>")
 +
* (NOT NEEDED FOR ALPS 1) Now build boost jam, where in the last line <tt><i>operating-system</i></tt> should be copied from the output of the build, $BINDIR is the directory where you want to install the executable:
 
   cd boost/tools/jam/src
 
   cd boost/tools/jam/src
 
   sh build.sh
 
   sh build.sh
   install bin.<i>operating-system</i>/bjam $BINDIR
+
   (on MacOSX) install bin.<i>operating-system</i>/bjam $BINDIR
* Next, build the boost binaries, where in the last line we assume you use the GNU compiler. In other cases, checkout [http://boost.org/more/getting_started/unix-variants.html#or-build-custom-binaries here] for the right toolset
+
  (on Linux) cp bin.linuxx86/biam /usr/local/bin
 +
* (NOT NEEDED) Next, build the boost binaries, where in the last line we assume you use the GNU compiler. In other cases, checkout [http://boost.org/more/getting_started/unix-variants.html#or-build-custom-binaries here] for the right toolset
 
   cd boost/
 
   cd boost/
 
   bjam --toolset=gcc stage
 
   bjam --toolset=gcc stage
* Now, you must apply for an account to the ALPS subversion repository. Send your request via email to [http://www.itp.phys.ethz.ch/staff/gull Emanuel Gull]. After an account has been created for you (usually, Emanuel is very fast in doing so...), change your password [http://alps.comp-phys.org/admin/passwd.php here].
+
 
 +
== ALPS Subversion (SVN) repository account ==
 +
* Now, you must apply for an account to the ALPS subversion repository. Both ALPS 1.x and ALPS 2.x are in the same subversion repository. Please note that we only give accounts to active developers that plan on contributing to the project. If you are not developing code, please download a tar ball from [[Setup_and_Installation| Setup and Installation]]
 +
Send your request via email to any member of the [http://www.itp.phys.ethz.ch/research/comp/simulation ETH computational physics group]. After an account has been created for you, change your password [https://alps.comp-phys.org/admin/passwd.php here].
 
* You are now in the position to get the latest ALPS V1 svn-head, by using
 
* You are now in the position to get the latest ALPS V1 svn-head, by using
   svn co --username ''your_user_name'' http://alps.comp-phys.org/svn/alps
+
   svn co --username ''your_user_name'' https://alps.comp-phys.org/svn/alps1/trunk/alps
 +
  svn co --username ''your_user_name'' https://alps.comp-phys.org/svn/alps1/trunk/applications
 +
* You may get the test repository:
 +
  svn co --username ''your_user_name'' https://alps.comp-phys.org/svn/test_repository
 +
You can also browse the sources just by pointing your web browser to these URLs, or you can use our websvn interface at https://alps.comp-phys.org/websvn. Important information for those users who took part in the Zurich workshop: the svn repository has been moved at the end of the workshop and the two trees ALPS and applications have both been merged into alps1.
 +
 
 +
== ALPS2.0 and Boost setup ==
 +
* Setup BOOST_ROOT environment variable and user-config.jam
 +
$ export BOOST_ROOT=/path/to/boost/directory
 +
$ cat $HOME/user-config.jam
 +
using gcc ; # on linux
 +
using intel ; # on linux icc
 +
using darwin ; # on MacOS
 +
# The following leads to double definitions of the alps project; therefore I commented it out:
 +
# use-project alps : /path/to/alps/directory ;
 +
* Then you can compile alps
 +
$ cd /path/to/alps/directory
 +
$ bjam
 +
* A little HOWTO for the setup of [[bjam]]
 +
* Setup BOOST_BUILD_PATH environment variable in order to run the tests:
 +
$ export BOOST_BUILD_PATH=/path/to/boost_1_36_0:/path/to/alps2.0/test_repository/trunk/alps/tools/build/
 +
 
 +
== Documentation ==
 +
* For the documentation, you need a few tools such as Doxygen and Boostbook, see http://www.doxygen.org and http://www.boost.org/doc/html/boostbook.html. We discuss how to get the CVS version of Doxygen and how to install it. We experienced problems with version 1.5.2 of Doxygen, but version 1.4.7 is fine as well.
 +
$ cd $HOME
 +
$ cvs -d:pserver:anonymous@cvs.planetsaphire.com:/cvsroot co -P doxygen
 +
$ cd doxygen
 +
$ ./configure
 +
$ make
 +
$ cp doxy* $BINDIR
 +
where $BINDIR is your directory with executables.
 +
* You have already downloaded Boostbook and you just have to run the setup script.
 +
$ cd path/to/boost/tools/boostbook
 +
$ sh setup_boostbook.sh
 +
* you are ready now to install the ALPS documentation,
 +
$ cd doc
 +
$ bjam
 +
* The next topic is about concepts -- see  http://www.boost.org/libs/concept_check/concept_check.htm -- and archetypes...
 +
To be continued...

Latest revision as of 02:06, 4 December 2009

This resource is totally outdated. Developers willing to contribute should look at ALPS trac.

Downloading and Installing Subversion

You need:

 curl http://subversion.tigris.org/downloads/subversion-1.3.2.tar.gz | tar zxf -
  (optional) curl http://subversion.tigris.org/downloads/subversion-deps-1.3.2.tar.gz | tar zxf -
 cd subversion-1.3.2
 ./configure --with-ssl
 make
 sudo make install

Boost, Bjam and the like

  • For developing with ALPS all you need to do is download the boost libraries and unpack them. You will not need to build them yourself. If you unpack boost in a nonstandard location, make sure to set the configure --with-boost=/path/to/boost flag. Once you have downloaded and unpacked your boost, you can skip to the next section.
  • The boost libraries 1.35
    (This is a released version - if you want to access the boost CVS/SVN, go here for instructions how to access the CVS; during checkout use "boost" instead of "modulename")
  • (NOT NEEDED FOR ALPS 1) Now build boost jam, where in the last line operating-system should be copied from the output of the build, $BINDIR is the directory where you want to install the executable:
 cd boost/tools/jam/src
 sh build.sh
 (on MacOSX) install bin.operating-system/bjam $BINDIR
 (on Linux) cp bin.linuxx86/biam /usr/local/bin
  • (NOT NEEDED) Next, build the boost binaries, where in the last line we assume you use the GNU compiler. In other cases, checkout here for the right toolset
 cd boost/
 bjam --toolset=gcc stage

ALPS Subversion (SVN) repository account

  • Now, you must apply for an account to the ALPS subversion repository. Both ALPS 1.x and ALPS 2.x are in the same subversion repository. Please note that we only give accounts to active developers that plan on contributing to the project. If you are not developing code, please download a tar ball from Setup and Installation

Send your request via email to any member of the ETH computational physics group. After an account has been created for you, change your password here.

  • You are now in the position to get the latest ALPS V1 svn-head, by using
 svn co --username your_user_name https://alps.comp-phys.org/svn/alps1/trunk/alps
 svn co --username your_user_name https://alps.comp-phys.org/svn/alps1/trunk/applications
  • You may get the test repository:
 svn co --username your_user_name https://alps.comp-phys.org/svn/test_repository

You can also browse the sources just by pointing your web browser to these URLs, or you can use our websvn interface at https://alps.comp-phys.org/websvn. Important information for those users who took part in the Zurich workshop: the svn repository has been moved at the end of the workshop and the two trees ALPS and applications have both been merged into alps1.

ALPS2.0 and Boost setup

  • Setup BOOST_ROOT environment variable and user-config.jam
$ export BOOST_ROOT=/path/to/boost/directory
$ cat $HOME/user-config.jam
using gcc ; # on linux
using intel ; # on linux icc
using darwin ; # on MacOS
# The following leads to double definitions of the alps project; therefore I commented it out: 
# use-project alps : /path/to/alps/directory ;
  • Then you can compile alps
$ cd /path/to/alps/directory
$ bjam
  • A little HOWTO for the setup of bjam
  • Setup BOOST_BUILD_PATH environment variable in order to run the tests:
$ export BOOST_BUILD_PATH=/path/to/boost_1_36_0:/path/to/alps2.0/test_repository/trunk/alps/tools/build/

Documentation

$ cd $HOME
$ cvs -d:pserver:anonymous@cvs.planetsaphire.com:/cvsroot co -P doxygen
$ cd doxygen
$ ./configure
$ make
$ cp doxy* $BINDIR

where $BINDIR is your directory with executables.

  • You have already downloaded Boostbook and you just have to run the setup script.
$ cd path/to/boost/tools/boostbook
$ sh setup_boostbook.sh
  • you are ready now to install the ALPS documentation,
$ cd doc
$ bjam 

To be continued...