Thread: [C-MPI-commits] SF.net SVN: c-mpi:[68] docs/manual
Status: Pre-Alpha
Brought to you by:
jmwozniak
Menu
▾
▴
c-mpi-commits
|
From: <jmw...@us...> - 2010-05-05 15:59:36
|
Revision: 68
http://c-mpi.svn.sourceforge.net/c-mpi/?rev=68&view=rev
Author: jmwozniak
Date: 2010-05-05 15:59:26 +0000 (Wed, 05 May 2010)
Log Message:
-----------
Docs fixes.
Modified Paths:
--------------
docs/manual/manual.xml
docs/manual/sf-post.zsh
Modified: docs/manual/manual.xml
===================================================================
--- docs/manual/manual.xml 2010-05-05 15:56:25 UTC (rev 67)
+++ docs/manual/manual.xml 2010-05-05 15:59:26 UTC (rev 68)
@@ -11,12 +11,12 @@
<section id="overview">
<title>Overview</title>
<para>
- This manual provides reference material for the Content-MPI
- (C-MPI) DHT.
+ This manual provides reference material for the Content-MPI
+ (C-MPI) DHT.
</para>
<para>
- C-MPI provides a key/value store for distributed computing
- over MPI.
+ C-MPI provides a key/value store for distributed computing
+ over MPI.
</para>
</section>
Modified: docs/manual/sf-post.zsh
===================================================================
--- docs/manual/sf-post.zsh 2010-05-05 15:56:25 UTC (rev 67)
+++ docs/manual/sf-post.zsh 2010-05-05 15:59:26 UTC (rev 68)
@@ -3,6 +3,10 @@
# Post HTML to SourceForge
USER=$1
+[[ ${USER} == "" ]] && print "No USER!" && exit 1
+DIR=$( dirname $0 )
+cd ${DIR}
+
HTML=( index.html manual.html )
scp ${HTML} ${USER},c-...@we...:htdocs
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <jmw...@us...> - 2010-05-14 15:39:11
|
Revision: 113
http://c-mpi.svn.sourceforge.net/c-mpi/?rev=113&view=rev
Author: jmwozniak
Date: 2010-05-14 15:39:05 +0000 (Fri, 14 May 2010)
Log Message:
-----------
Start using XInclude for code samples
Modified Paths:
--------------
docs/manual/Makefile
docs/manual/manual.xml
Added Paths:
-----------
docs/manual/cmpi_client_code.c
Modified: docs/manual/Makefile
===================================================================
--- docs/manual/Makefile 2010-05-14 15:05:52 UTC (rev 112)
+++ docs/manual/Makefile 2010-05-14 15:39:05 UTC (rev 113)
@@ -1,4 +1,3 @@
-#!/bin/sh
all: htmls
# phps pdfs
@@ -12,12 +11,21 @@
# chunked-userguide: userguide.xml
# ./build-chunked-userguide.sh
-%.php: %.xml formatting/swiftsh_html.xsl
+manual.inc.xml: manual.xml
+ xmllint --xinclude $(<) > $(@)
+
+manual.html: manual.inc.xml formatting/swiftsh_html.xsl
xsltproc --nonet formatting/swiftsh_html.xsl $<
- sed -e "s/index.html#/#/g" index.html >$@
+index.html: manual.html
+ sed -e "s/index.html#/#/g" $(<) > $(@)
+
#%.pdf: %.xml formatting/vdl2_fo.xsl
# fop/fop -xsl formatting/vdl2_fo.xsl -xml $< -pdf $@
%.html: %.php
cp $< $@
+
+clean:
+ rm -fv index.html manual.html manual.inc.xml
+
Added: docs/manual/cmpi_client_code.c
===================================================================
--- docs/manual/cmpi_client_code.c (rev 0)
+++ docs/manual/cmpi_client_code.c 2010-05-14 15:39:05 UTC (rev 113)
@@ -0,0 +1,14 @@
+
+#include <cmpi.h>
+
+cmpi_client_code()
+{
+ sprintf(key, "key_%i", mpi_rank);
+ sprintf(value, "value_%i", mpi_rank);
+ cmpi_put(key, value, strlen(value)+1);
+
+ rank = (mpi_rank+1)%mpi_size;
+ sprintf(key, "key_%i", rank);
+ cmpi_get(key, &result, &length);
+ printf("result(%i): %s\n", length, result);
+}
Modified: docs/manual/manual.xml
===================================================================
--- docs/manual/manual.xml 2010-05-14 15:05:52 UTC (rev 112)
+++ docs/manual/manual.xml 2010-05-14 15:39:05 UTC (rev 113)
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [] >
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [] >
<article>
<articleinfo revision="0.1">
@@ -33,26 +34,18 @@
C-MPI can be used as an MPI library:
</para>
+ <programlisting>
+ <xi:include href="cmpi_client_code.c" parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+
+<!--
<programlisting> <![CDATA[
#include <cmpi.h>
- int main(int argc, char* argv[])
+ cmpi_client_code()
{
- int mpi_rank;
- int mpi_size;
- char key[10];
- char value[30];
- int length;
- char* result;
-
- MPI_Init(&argc, &argv);
- MPI_Comm_rank(MPI_COMM_WORLD, &rank);
- MPI_Comm_size(MPI_COMM_WORLD, &size);
-
- cmpi_init();
-
- sprintf(key, "key_%i", mpi_rank);
+ sprintf(key, "key_%i", mpi_rank);
sprintf(value, "value_%i", mpi_rank);
cmpi_put(key, value, strlen(value)+1);
@@ -67,6 +60,8 @@
}
]]>
</programlisting>
+
+-->
</section>
</section>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <jmw...@us...> - 2010-05-14 17:18:25
|
Revision: 114
http://c-mpi.svn.sourceforge.net/c-mpi/?rev=114&view=rev
Author: jmwozniak
Date: 2010-05-14 17:18:19 +0000 (Fri, 14 May 2010)
Log Message:
-----------
New cluster database documentation
Modified Paths:
--------------
docs/manual/Makefile
docs/manual/manual.xml
docs/manual/sf-post.zsh
Added Paths:
-----------
docs/manual/client_script.sh
docs/manual/login_shell.sh
Property Changed:
----------------
docs/manual/
Property changes on: docs/manual
___________________________________________________________________
Modified: svn:ignore
- fop
manual.html
index.html
+ .ignore
fop
manual.html
index.html
manual.inc.xml
Modified: docs/manual/Makefile
===================================================================
--- docs/manual/Makefile 2010-05-14 15:39:05 UTC (rev 113)
+++ docs/manual/Makefile 2010-05-14 17:18:19 UTC (rev 114)
@@ -14,11 +14,13 @@
manual.inc.xml: manual.xml
xmllint --xinclude $(<) > $(@)
-manual.html: manual.inc.xml formatting/swiftsh_html.xsl
- xsltproc --nonet formatting/swiftsh_html.xsl $<
+index.html: manual.inc.xml formatting/swiftsh_html.xsl
+ xsltproc --nonet formatting/swiftsh_html.xsl $(<)
+ chmod a+r $(@)
-index.html: manual.html
+manual.html: index.html
sed -e "s/index.html#/#/g" $(<) > $(@)
+ chmod a+r $(@)
#%.pdf: %.xml formatting/vdl2_fo.xsl
# fop/fop -xsl formatting/vdl2_fo.xsl -xml $< -pdf $@
Added: docs/manual/client_script.sh
===================================================================
--- docs/manual/client_script.sh (rev 0)
+++ docs/manual/client_script.sh 2010-05-14 17:18:19 UTC (rev 114)
@@ -0,0 +1,16 @@
+#!/bin/sh
+
+id=$1
+nodes=$2
+
+for (( i=0 ; i<10 ; i++ ))
+do
+ # Do some useful work
+ do_work ${id} ${nodes} < input > output
+ # Post the results to the DHT
+ key=output_${id}_${i}
+ cmpi-cp output dht://${key}
+ # Read a neighbor's result
+ key=output_$(( id-1 % nodes ))_${i}
+ cmpi-cp dht://${key} input
+done
Added: docs/manual/login_shell.sh
===================================================================
--- docs/manual/login_shell.sh (rev 0)
+++ docs/manual/login_shell.sh 2010-05-14 17:18:19 UTC (rev 114)
@@ -0,0 +1,24 @@
+#!/bin/sh
+
+# Allocate 6 compute nodes
+qsub -t 1-6 ...
+
+# List node host names to file for mpiexec
+qstat | something > hosts
+
+# Create some initial conditions
+create_initial > input
+
+# Launch the DHT (12 processes on 6 nodes)
+mpiexec.hydra -f hosts -n 12 bin/cmpi-db -n 6 &
+
+# Spawn client scripts
+# (Could use Falkon here?)
+id=0
+total=$( wc -l hosts )
+for host in $( cat hosts )
+do
+ ssh ${host} client_script.sh $(( id++ )) ${total} &
+done
+
+wait
Modified: docs/manual/manual.xml
===================================================================
--- docs/manual/manual.xml 2010-05-14 15:39:05 UTC (rev 113)
+++ docs/manual/manual.xml 2010-05-14 17:18:19 UTC (rev 114)
@@ -24,6 +24,20 @@
</para>
</section>
+ <section id="quickstart">
+ <title>Quick Start
+ </title>
+ <para>
+ The fastest way to get a quick overview of provided features
+ is to just run:
+ <programlisting>
+ make D=1 test_results
+ </programlisting>
+ Then, just take a look at the test code and output to see
+ how things work.
+ </para>
+ </section>
+
<section id="usecases">
<title>Use Cases
</title>
@@ -35,34 +49,25 @@
</para>
<programlisting>
- <xi:include href="cmpi_client_code.c" parse="text"
- xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-
-<!--
- <programlisting> <![CDATA[
-
- #include <cmpi.h>
-
- cmpi_client_code()
- {
- sprintf(key, "key_%i", mpi_rank);
- sprintf(value, "value_%i", mpi_rank);
- cmpi_put(key, value, strlen(value)+1);
-
- rank = (mpi_rank+1)%mpi_size;
- sprintf(key, "key_%i", rank);
- cmpi_get(key, &result, &length);
- printf("result(%i): %s\n", length, result);
-
- MPI_Finalize();
-
- cmpi_cleanup();
- }
- ]]>
+ <xi:include href="cmpi_client_code.c" parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
</programlisting>
--->
</section>
+ <section>
+ <title>Cluster database
+ </title>
+ <para>
+ Commands executed on submit host:
+ <programlisting><xi:include
+ href="login_shell.sh" parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+ <literal>client_script.sh</literal>:
+ <programlisting><xi:include
+ href="client_script.sh" parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+ </para>
+ </section>
</section>
<section id="mpirpc">
@@ -506,6 +511,15 @@
Useful when debugging build process.
</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term>-j</term>
+ <listitem><para>
+ You can do <literal>make -j tests</literal> but you
+ cannot run the tests concurrently.
+ Doing this would create multiple conflicting MPI
+ executions.
+ </para></listitem>
+ </varlistentry>
<varlistentry>
<term>mpirpc</term>
<listitem><para>
Modified: docs/manual/sf-post.zsh
===================================================================
--- docs/manual/sf-post.zsh 2010-05-14 15:39:05 UTC (rev 113)
+++ docs/manual/sf-post.zsh 2010-05-14 17:18:19 UTC (rev 114)
@@ -2,8 +2,9 @@
# Post HTML to SourceForge
-USER=$1
-[[ ${USER} == "" ]] && print "No USER!" && exit 1
+# Input: SourceForge username:
+SF_USER=$1
+[[ ${SF_USER} == "" ]] && print "No SF_USER!" && exit 1
DIR=$( dirname $0 )
cd ${DIR}
@@ -11,4 +12,4 @@
HTML=( index.html manual.html )
IMG=( cmpi-connections.png )
FILES=( ${HTML} ${IMG} )
-scp -p ${FILES} ${USER},c-...@we...:htdocs
+scp -p ${FILES} ${SF_USER},c-...@we...:htdocs
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <jmw...@us...> - 2010-05-14 20:44:28
|
Revision: 125
http://c-mpi.svn.sourceforge.net/c-mpi/?rev=125&view=rev
Author: jmwozniak
Date: 2010-05-14 20:44:21 +0000 (Fri, 14 May 2010)
Log Message:
-----------
Add date info to manual
Modified Paths:
--------------
docs/manual/Makefile
docs/manual/manual.xml
Modified: docs/manual/Makefile
===================================================================
--- docs/manual/Makefile 2010-05-14 20:34:52 UTC (rev 124)
+++ docs/manual/Makefile 2010-05-14 20:44:21 UTC (rev 125)
@@ -13,6 +13,7 @@
manual.inc.xml: manual.xml
xmllint --xinclude $(<) > $(@)
+ sed -i "s/INSERT_DATE/`date`/" $(@)
index.html: manual.inc.xml formatting/swiftsh_html.xsl
xsltproc --nonet formatting/swiftsh_html.xsl $(<)
Modified: docs/manual/manual.xml
===================================================================
--- docs/manual/manual.xml 2010-05-14 20:34:52 UTC (rev 124)
+++ docs/manual/manual.xml 2010-05-14 20:44:21 UTC (rev 125)
@@ -728,4 +728,12 @@
</variablelist>
</para>
</section>
+
+ <section id="appendix">
+ <title>Appendix
+ </title>
+ <para>
+ Updated: INSERT_DATE
+ </para>
+ </section>
</article>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
Thanks for helping keep SourceForge clean.
X