Page MenuHomec4science

No OneTemporary

File Metadata

Created
Fri, Feb 7, 18:14
This document is not UTF8. It was detected as ISO-8859-1 (Latin 1) and converted to UTF8 for display.
diff --git a/Doc/newdoc/_build/doctrees/environment.pickle b/Doc/newdoc/_build/doctrees/environment.pickle
index 171d237..d5d399f 100644
Binary files a/Doc/newdoc/_build/doctrees/environment.pickle and b/Doc/newdoc/_build/doctrees/environment.pickle differ
diff --git a/Doc/newdoc/_build/doctrees/index.doctree b/Doc/newdoc/_build/doctrees/index.doctree
index a656567..ff4d6f5 100644
Binary files a/Doc/newdoc/_build/doctrees/index.doctree and b/Doc/newdoc/_build/doctrees/index.doctree differ
diff --git a/Doc/newdoc/_build/doctrees/rst/Io.doctree b/Doc/newdoc/_build/doctrees/rst/Io.doctree
index 23c59f8..fb6c5aa 100644
Binary files a/Doc/newdoc/_build/doctrees/rst/Io.doctree and b/Doc/newdoc/_build/doctrees/rst/Io.doctree differ
diff --git a/Doc/newdoc/_build/doctrees/rst/Overview.doctree b/Doc/newdoc/_build/doctrees/rst/Overview.doctree
index 3d13f43..e719161 100644
Binary files a/Doc/newdoc/_build/doctrees/rst/Overview.doctree and b/Doc/newdoc/_build/doctrees/rst/Overview.doctree differ
diff --git a/Doc/newdoc/_build/html/.buildinfo b/Doc/newdoc/_build/html/.buildinfo
index 87377a9..ea473a3 100644
--- a/Doc/newdoc/_build/html/.buildinfo
+++ b/Doc/newdoc/_build/html/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 362a13e370e17ef1dfab95a3a88567c5
+config: 18d7945f3eb382f66a6187fa82f4d10a
tags: fbb0d17656682115ca4d033fb2f83ba1
diff --git a/Doc/newdoc/_build/html/_sources/index.txt b/Doc/newdoc/_build/html/_sources/index.txt
index 28288c5..b8c7773 100644
--- a/Doc/newdoc/_build/html/_sources/index.txt
+++ b/Doc/newdoc/_build/html/_sources/index.txt
@@ -1,23 +1,24 @@
.. pNbody documentation master file, created by
sphinx-quickstart on Wed Aug 24 16:29:02 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pNbody's documentation!
==================================
Contents:
.. toctree::
:maxdepth: 2
rst/Overview
+ rst/Installation
rst/Io
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
diff --git a/Doc/newdoc/_build/html/_sources/rst/Io.txt b/Doc/newdoc/_build/html/_sources/rst/Io.txt
index 66371f5..a23cd16 100644
--- a/Doc/newdoc/_build/html/_sources/rst/Io.txt
+++ b/Doc/newdoc/_build/html/_sources/rst/Io.txt
@@ -1,11 +1,14 @@
the Io module
**********************
.. currentmodule:: pNbody.io
.. autofunction:: checkfile
.. autofunction:: end_of_file
.. autofunction:: write_array
+.. autofunction:: read_ascii
+.. autofunction:: write_dump
+.. autofunction:: read_dump
+
-.. autofunction:: testfct
diff --git a/Doc/newdoc/_build/html/_sources/rst/Overview.txt b/Doc/newdoc/_build/html/_sources/rst/Overview.txt
index cf5b28c..04c6c96 100644
--- a/Doc/newdoc/_build/html/_sources/rst/Overview.txt
+++ b/Doc/newdoc/_build/html/_sources/rst/Overview.txt
@@ -1,7 +1,26 @@
Overview
**********************
-.. currentmodule:: pNbody.io
+pNbody is a parallelized python module toolbox designed to manipulate and display
+interactively very lage N-body systems.
+Its oriented object approche allows the user to perform complicate manipulation
+with only very few commands.
+As python is an interpreted language, the user can load an N-body system and explore it
+interactively using the python interpreter. pNbody may also be used in python scripts.
+
+The module also contains graphical facilities desinged to create maps of physical values of
+the system, like density maps, temperture maps, velocites maps, etc. Stereo capabilities are
+also implemented.
+
+pNbody is not limited by file format. Each user may redefine in a parameter file how to read
+its prefered format.
+
+Its new parallel (mpi) facilities make it works on computer cluster without being limitted by
+memory consumption. It has already been tested with several millions of particles.
+
+
+
+.. image:: ../images/cosmo.png
diff --git a/Doc/newdoc/_build/html/_static/basic.css b/Doc/newdoc/_build/html/_static/basic.css
index 69f30d4..32630d5 100644
--- a/Doc/newdoc/_build/html/_static/basic.css
+++ b/Doc/newdoc/_build/html/_static/basic.css
@@ -1,509 +1,528 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
img {
border: 0;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- general body styles --------------------------------------------------- */
a.headerlink {
visibility: hidden;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.field-list ul {
padding-left: 1em;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
+img.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
.align-left {
text-align: left;
}
.align-center {
clear: both;
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
}
p.sidebar-title {
font-weight: bold;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dl {
margin-bottom: 0;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.field-list td, table.field-list th {
border: 0 !important;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
dl {
margin-bottom: 15px;
}
dd p {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dt:target, .highlighted {
background-color: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.refcount {
color: #060;
}
.optional {
font-size: 1.3em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
- background-color: #ffa
+ background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
td.linenos pre {
padding: 5px 0px;
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
tt.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
tt.descclassname {
background-color: transparent;
}
tt.xref, a tt {
background-color: transparent;
font-weight: bold;
}
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}
diff --git a/Doc/newdoc/_build/html/_static/default.css b/Doc/newdoc/_build/html/_static/default.css
index 2a3ac13..21f3f50 100644
--- a/Doc/newdoc/_build/html/_static/default.css
+++ b/Doc/newdoc/_build/html/_static/default.css
@@ -1,256 +1,256 @@
/*
* default.css_t
* ~~~~~~~~~~~~~
*
* Sphinx stylesheet -- default theme.
*
- * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: sans-serif;
font-size: 100%;
background-color: #11303d;
color: #000;
margin: 0;
padding: 0;
}
div.document {
background-color: #1c4e63;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
div.body {
background-color: #ffffff;
color: #000000;
padding: 0 20px 30px 20px;
}
div.footer {
color: #ffffff;
width: 100%;
padding: 9px 0 9px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #ffffff;
text-decoration: underline;
}
div.related {
background-color: #133f52;
line-height: 30px;
color: #ffffff;
}
div.related a {
color: #ffffff;
}
div.sphinxsidebar {
}
div.sphinxsidebar h3 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.4em;
font-weight: normal;
margin: 0;
padding: 0;
}
div.sphinxsidebar h3 a {
color: #ffffff;
}
div.sphinxsidebar h4 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.3em;
font-weight: normal;
margin: 5px 0 0 0;
padding: 0;
}
div.sphinxsidebar p {
color: #ffffff;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px;
padding: 0;
color: #ffffff;
}
div.sphinxsidebar a {
color: #98dbcc;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
/* -- hyperlink styles ------------------------------------------------------ */
a {
color: #355f7c;
text-decoration: none;
}
a:visited {
color: #355f7c;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* -- body styles ----------------------------------------------------------- */
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: 'Trebuchet MS', sans-serif;
background-color: #f2f2f2;
font-weight: normal;
color: #20435c;
border-bottom: 1px solid #ccc;
margin: 20px -20px 10px -20px;
padding: 3px 0 3px 10px;
}
div.body h1 { margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 160%; }
div.body h3 { font-size: 140%; }
div.body h4 { font-size: 120%; }
div.body h5 { font-size: 110%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
text-align: justify;
line-height: 130%;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.admonition p {
margin-bottom: 5px;
}
div.admonition pre {
margin-bottom: 5px;
}
div.admonition ul, div.admonition ol {
margin-bottom: 5px;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.topic {
background-color: #eee;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre {
padding: 5px;
background-color: #eeffcc;
color: #333333;
line-height: 120%;
border: 1px solid #ac9;
border-left: none;
border-right: none;
}
tt {
background-color: #ecf0f3;
padding: 0 1px 0 1px;
font-size: 0.95em;
}
th {
background-color: #ede;
}
.warning tt {
background: #efc2c2;
}
.note tt {
background: #d6d6d6;
}
.viewcode-back {
font-family: sans-serif;
}
div.viewcode-block:target {
background-color: #f4debf;
border-top: 1px solid #ac9;
border-bottom: 1px solid #ac9;
}
\ No newline at end of file
diff --git a/Doc/newdoc/_build/html/_static/doctools.js b/Doc/newdoc/_build/html/_static/doctools.js
index eeea95e..8b9bd2c 100644
--- a/Doc/newdoc/_build/html/_static/doctools.js
+++ b/Doc/newdoc/_build/html/_static/doctools.js
@@ -1,247 +1,247 @@
/*
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilties for all documentation.
*
- * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/
/**
* small helper function to urldecode strings
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
}
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s == 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* small function to check if an array contains
* a given item.
*/
jQuery.contains = function(arr, item) {
for (var i = 0; i < arr.length; i++) {
if (arr[i] == item)
return true;
}
return false;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node) {
if (node.nodeType == 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
var span = document.createElement("span");
span.className = className;
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this);
});
}
}
return this.each(function() {
highlight(this);
});
};
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated == 'undefined')
return string;
return (typeof translated == 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated == 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<li class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>')
.appendTo($('.sidebar .this-page-menu'));
}
},
/**
* init the domain index toggle buttons
*/
initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
if (src.substr(-9) == 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('.sidebar .this-page-menu li.highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this == '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});
diff --git a/Doc/newdoc/_build/html/_static/searchtools.js b/Doc/newdoc/_build/html/_static/searchtools.js
index 5cbfe00..dae92b5 100644
--- a/Doc/newdoc/_build/html/_static/searchtools.js
+++ b/Doc/newdoc/_build/html/_static/searchtools.js
@@ -1,518 +1,518 @@
/*
* searchtools.js
* ~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilties for the full-text search.
*
- * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurance, the
* latter for highlighting it.
*/
jQuery.makeSearchSummary = function(text, keywords, hlwords) {
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
var i = textLower.indexOf(this.toLowerCase());
if (i > -1)
start = i;
});
start = Math.max(start - 120, 0);
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<div class="context"></div>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});
return rv;
}
/**
* Porter Stemmer
*/
var PorterStemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
/**
* Search Module
*/
var Search = {
_index : null,
_queued_query : null,
_pulse_status : -1,
init : function() {
var params = $.getQueryParameters();
if (params.q) {
var query = params.q[0];
$('input[name="q"]')[0].value = query;
this.performSearch(query);
}
},
loadIndex : function(url) {
$.ajax({type: "GET", url: url, data: null, success: null,
dataType: "script", cache: true});
},
setIndex : function(index) {
var q;
this._index = index;
if ((q = this._queued_query) !== null) {
this._queued_query = null;
Search.query(q);
}
},
hasIndex : function() {
return this._index !== null;
},
deferQuery : function(query) {
this._queued_query = query;
},
stopPulse : function() {
this._pulse_status = 0;
},
startPulse : function() {
if (this._pulse_status >= 0)
return;
function pulse() {
Search._pulse_status = (Search._pulse_status + 1) % 4;
var dotString = '';
for (var i = 0; i < Search._pulse_status; i++)
dotString += '.';
Search.dots.text(dotString);
if (Search._pulse_status > -1)
window.setTimeout(pulse, 500);
};
pulse();
},
/**
* perform a search for something
*/
performSearch : function(query) {
// create the required interface elements
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p style="display: none"></p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
this.startPulse();
// index already loaded, the browser was quick!
if (this.hasIndex())
this.query(query);
else
this.deferQuery(query);
},
query : function(query) {
var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in',
'if', 'for', 'no', 'there', 'their', 'was', 'is',
'be', 'to', 'that', 'but', 'they', 'not', 'such',
'with', 'by', 'a', 'on', 'these', 'of', 'will',
'this', 'near', 'the', 'or', 'at'];
// stem the searchterms and add them to the correct list
var stemmer = new PorterStemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = query.split(/\s+/);
var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null;
for (var i = 0; i < tmp.length; i++) {
if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) ||
tmp[i] == "") {
// skip this "word"
continue;
}
// stem the word
var word = stemmer.stemWord(tmp[i]).toLowerCase();
// select the correct list
if (word[0] == '-') {
var toAppend = excluded;
word = word.substr(1);
}
else {
var toAppend = searchterms;
hlterms.push(tmp[i].toLowerCase());
}
// only add if not already in the list
if (!$.contains(toAppend, word))
toAppend.push(word);
};
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
// console.debug('SEARCH: searching for:');
// console.info('required: ', searchterms);
// console.info('excluded: ', excluded);
// prepare search
var filenames = this._index.filenames;
var titles = this._index.titles;
var terms = this._index.terms;
var objects = this._index.objects;
var objtypes = this._index.objtypes;
var objnames = this._index.objnames;
var fileMap = {};
var files = null;
// different result priorities
var importantResults = [];
var objectResults = [];
var regularResults = [];
var unimportantResults = [];
$('#search-progress').empty();
// lookup as object
if (object != null) {
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
if (fullname.toLowerCase().indexOf(object) > -1) {
match = objects[prefix][name];
descr = objnames[match[1]] + _(', in ') + titles[match[0]];
// XXX the generated anchors are not generally correct
// XXX there may be custom prefixes
result = [filenames[match[0]], fullname, '#'+fullname, descr];
switch (match[2]) {
case 1: objectResults.push(result); break;
case 0: importantResults.push(result); break;
case 2: unimportantResults.push(result); break;
}
}
}
}
}
// sort results descending
objectResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
importantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
unimportantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
// perform the search on the required terms
for (var i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
// no match but word was a required one
if ((files = terms[word]) == null)
break;
if (files.length == undefined) {
files = [files];
}
// create the mapping
for (var j = 0; j < files.length; j++) {
var file = files[j];
if (file in fileMap)
fileMap[file].push(word);
else
fileMap[file] = [word];
}
}
// now check if the files don't contain excluded terms
for (var file in fileMap) {
var valid = true;
// check if all requirements are matched
if (fileMap[file].length != searchterms.length)
continue;
// ensure that none of the excluded terms is in the
// search result.
for (var i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
$.contains(terms[excluded[i]] || [], file)) {
valid = false;
break;
}
}
// if we have still a valid result we can add it
// to the result list
if (valid)
regularResults.push([filenames[file], titles[file], '', null]);
}
// delete unused variables in order to not waste
// memory until list is retrieved completely
delete filenames, titles, terms;
// now sort the regular results descending by title
regularResults.sort(function(a, b) {
var left = a[1].toLowerCase();
var right = b[1].toLowerCase();
return (left > right) ? -1 : ((left < right) ? 1 : 0);
});
// combine all results
var results = unimportantResults.concat(regularResults)
.concat(objectResults).concat(importantResults);
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
dirname = dirname.substring(0, dirname.length-6);
} else if (dirname == 'index/') {
dirname = '';
}
listItem.append($('<a/>').attr('href',
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
highlightstring + item[2]).html(item[1]));
} else {
// normal html builders
listItem.append($('<a/>').attr('href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
}
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' +
item[0] + '.txt', function(data) {
if (data != '') {
listItem.append($.makeSearchSummary(data, searchterms, hlterms));
Search.output.append(listItem);
}
listItem.slideDown(5, function() {
displayNextItem();
});
});
} else {
// no source available, just display title
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
}
}
// search finished, update title and status message
else {
Search.stopPulse();
Search.title.text(_('Search Results'));
if (!resultCount)
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
else
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
Search.status.fadeIn(500);
}
}
displayNextItem();
}
}
$(document).ready(function() {
Search.init();
});
diff --git a/Doc/newdoc/_build/html/_static/sidebar.js b/Doc/newdoc/_build/html/_static/sidebar.js
index 7318517..e9ef491 100644
--- a/Doc/newdoc/_build/html/_static/sidebar.js
+++ b/Doc/newdoc/_build/html/_static/sidebar.js
@@ -1,148 +1,148 @@
/*
* sidebar.js
* ~~~~~~~~~~
*
* This script makes the Sphinx sidebar collapsible.
*
* .sphinxsidebar contains .sphinxsidebarwrapper. This script adds
* in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
* used to collapse and expand the sidebar.
*
* When the sidebar is collapsed the .sphinxsidebarwrapper is hidden
* and the width of the sidebar and the margin-left of the document
* are decreased. When the sidebar is expanded the opposite happens.
* This script saves a per-browser/per-session cookie used to
* remember the position of the sidebar among the pages.
* Once the browser is closed the cookie is deleted and the position
* reset to the default (expanded).
*
- * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
$(function() {
// global elements used by the functions.
// the 'sidebarbutton' element is defined as global after its
// creation, in the add_sidebar_button function
var bodywrapper = $('.bodywrapper');
var sidebar = $('.sphinxsidebar');
var sidebarwrapper = $('.sphinxsidebarwrapper');
// original margin-left of the bodywrapper and width of the sidebar
// with the sidebar expanded
var bw_margin_expanded = bodywrapper.css('margin-left');
var ssb_width_expanded = sidebar.width();
// margin-left of the bodywrapper and width of the sidebar
// with the sidebar collapsed
var bw_margin_collapsed = '.8em';
var ssb_width_collapsed = '.8em';
// colors used by the current theme
var dark_color = $('.related').css('background-color');
var light_color = $('.document').css('background-color');
function sidebar_is_collapsed() {
return sidebarwrapper.is(':not(:visible)');
}
function toggle_sidebar() {
if (sidebar_is_collapsed())
expand_sidebar();
else
collapse_sidebar();
}
function collapse_sidebar() {
sidebarwrapper.hide();
sidebar.css('width', ssb_width_collapsed);
bodywrapper.css('margin-left', bw_margin_collapsed);
sidebarbutton.css({
'margin-left': '0',
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('»');
sidebarbutton.attr('title', _('Expand sidebar'));
document.cookie = 'sidebar=collapsed';
}
function expand_sidebar() {
bodywrapper.css('margin-left', bw_margin_expanded);
sidebar.css('width', ssb_width_expanded);
sidebarwrapper.show();
sidebarbutton.css({
'margin-left': ssb_width_expanded-12,
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('«');
sidebarbutton.attr('title', _('Collapse sidebar'));
document.cookie = 'sidebar=expanded';
}
function add_sidebar_button() {
sidebarwrapper.css({
'float': 'left',
'margin-right': '0',
'width': ssb_width_expanded - 28
});
// create the button
sidebar.append(
'<div id="sidebarbutton"><span>&laquo;</span></div>'
);
var sidebarbutton = $('#sidebarbutton');
light_color = sidebarbutton.css('background-color');
// find the height of the viewport to center the '<<' in the page
var viewport_height;
if (window.innerHeight)
viewport_height = window.innerHeight;
else
viewport_height = $(window).height();
sidebarbutton.find('span').css({
'display': 'block',
'margin-top': (viewport_height - sidebar.position().top - 20) / 2
});
sidebarbutton.click(toggle_sidebar);
sidebarbutton.attr('title', _('Collapse sidebar'));
sidebarbutton.css({
'color': '#FFFFFF',
'border-left': '1px solid ' + dark_color,
'font-size': '1.2em',
'cursor': 'pointer',
'height': bodywrapper.height(),
'padding-top': '1px',
'margin-left': ssb_width_expanded - 12
});
sidebarbutton.hover(
function () {
$(this).css('background-color', dark_color);
},
function () {
$(this).css('background-color', light_color);
}
);
}
function set_position_from_cookie() {
if (!document.cookie)
return;
var items = document.cookie.split(';');
for(var k=0; k<items.length; k++) {
var key_val = items[k].split('=');
var key = key_val[0];
if (key == 'sidebar') {
var value = key_val[1];
if ((value == 'collapsed') && (!sidebar_is_collapsed()))
collapse_sidebar();
else if ((value == 'expanded') && (sidebar_is_collapsed()))
expand_sidebar();
}
}
}
add_sidebar_button();
var sidebarbutton = $('#sidebarbutton');
set_position_from_cookie();
});
diff --git a/Doc/newdoc/_build/html/genindex.html b/Doc/newdoc/_build/html/genindex.html
index c8a78db..529aca8 100644
--- a/Doc/newdoc/_build/html/genindex.html
+++ b/Doc/newdoc/_build/html/genindex.html
@@ -1,118 +1,127 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; pNbody v4 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pNbody v4 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
- <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#W"><strong>W</strong></a>
+ <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#W"><strong>W</strong></a>
</div>
<h2 id="C">C</h2>
-<table width="100%" class="indextable genindextable"><tr>
- <td width="33%" valign="top"><dl>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
<dt><a href="rst/Io.html#pNbody.io.checkfile">checkfile() (in module pNbody.io)</a></dt>
</dl></td>
</tr></table>
<h2 id="E">E</h2>
-<table width="100%" class="indextable genindextable"><tr>
- <td width="33%" valign="top"><dl>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
<dt><a href="rst/Io.html#pNbody.io.end_of_file">end_of_file() (in module pNbody.io)</a></dt>
</dl></td>
</tr></table>
-<h2 id="T">T</h2>
-<table width="100%" class="indextable genindextable"><tr>
- <td width="33%" valign="top"><dl>
- <dt><a href="rst/Io.html#pNbody.io.testfct">testfct() (in module pNbody.io)</a></dt>
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
+ <dt><a href="rst/Io.html#pNbody.io.read_ascii">read_ascii() (in module pNbody.io)</a></dt>
+</dl></td>
+ <td style="width: 33%" valign="top"><dl>
+ <dt><a href="rst/Io.html#pNbody.io.read_dump">read_dump() (in module pNbody.io)</a></dt>
</dl></td>
</tr></table>
<h2 id="W">W</h2>
-<table width="100%" class="indextable genindextable"><tr>
- <td width="33%" valign="top"><dl>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%" valign="top"><dl>
<dt><a href="rst/Io.html#pNbody.io.write_array">write_array() (in module pNbody.io)</a></dt>
+</dl></td>
+ <td style="width: 33%" valign="top"><dl>
+ <dt><a href="rst/Io.html#pNbody.io.write_dump">write_dump() (in module pNbody.io)</a></dt>
</dl></td>
</tr></table>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/icon-small.jpg" alt="Logo"/>
+ </a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li><a href="index.html">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Yves Revaz.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/Doc/newdoc/_build/html/index.html b/Doc/newdoc/_build/html/index.html
index 7584d13..443bab2 100644
--- a/Doc/newdoc/_build/html/index.html
+++ b/Doc/newdoc/_build/html/index.html
@@ -1,122 +1,132 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to pNbody’s documentation! &mdash; pNbody v4 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pNbody v4 documentation" href="#" />
<link rel="next" title="Overview" href="rst/Overview.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="rst/Overview.html" title="Overview"
accesskey="N">next</a> |</li>
<li><a href="#">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-pnbody-s-documentation">
<h1>Welcome to pNbody&#8217;s documentation!<a class="headerlink" href="#welcome-to-pnbody-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="rst/Overview.html">Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rst/Installation.html">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rst/Prerequiste.html">Prerequiste</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rst/Installing_from_tarball.html">Installing from source</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rst/Test_the_installation.html">Check the installation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rst/Documentation_and_examples.html">Examples</a></li>
+</ul>
+</li>
<li class="toctree-l1"><a class="reference internal" href="rst/Io.html">the Io module</a></li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="#">
+ <img class="logo" src="_static/icon-small.jpg" alt="Logo"/>
+ </a></p>
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to pNbody&#8217;s documentation!</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="rst/Overview.html"
title="next chapter">Overview</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="rst/Overview.html" title="Overview"
>next</a> |</li>
<li><a href="#">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Yves Revaz.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/Doc/newdoc/_build/html/objects.inv b/Doc/newdoc/_build/html/objects.inv
index 8633b6c..0e59276 100644
--- a/Doc/newdoc/_build/html/objects.inv
+++ b/Doc/newdoc/_build/html/objects.inv
@@ -1,6 +1,7 @@
# Sphinx inventory version 2
# Project: pNbody
# Version: 4
# The remainder of this file is compressed using zlib.
-xڍŽA
-Â0E÷=ŀnSé¶7èB<@I“IL3%™¢¹½•DPpÑí›÷˜?“¶^ã"ëÖɈ–$ær¨'žÝΤW‡Ð½Q5¢ÿ}h)²Q5ýŠ™햅«±Z.éT[ª#Åې֬^±% „ȧŽrxñå« ÕÝØmáÞâ,c/Ciwƒ^÷dú^µ‡v³
\ No newline at end of file
+xڝÐK
+Â0й«x ÓV:í:PPÒäµ æG’¢Ù½ŸTZA$qzsá]©W oà<«éP@Q …œÊÑK±…ƒf“@hžÑf@õ½ÓYĪCbéøYŒÙ\;lj ¸1ÇN³Pr]Òé¥çM¨ûIQϵ‚
+¬óûFGºƒb%®–{l‰µ$d6I“L,ö‡ ŽržLP±V÷mÖýËbÊä/–g^÷§’e±,K%ëÅ~›;™>ö
\ No newline at end of file
diff --git a/Doc/newdoc/_build/html/rst/Io.html b/Doc/newdoc/_build/html/rst/Io.html
index d0c49b8..da61e52 100644
--- a/Doc/newdoc/_build/html/rst/Io.html
+++ b/Doc/newdoc/_build/html/rst/Io.html
@@ -1,264 +1,294 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>the Io module &mdash; pNbody v4 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pNbody v4 documentation" href="../index.html" />
<link rel="prev" title="Overview" href="Overview.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="Overview.html" title="Overview"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="the-io-module">
<h1>the Io module<a class="headerlink" href="#the-io-module" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="pNbody.io.checkfile">
<tt class="descclassname">pNbody.io.</tt><tt class="descname">checkfile</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pNbody.io.checkfile" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if a file exists. An error is generated if the file
does not exists.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><strong>name</strong> : the path to a filename</td>
</tr>
-<tr class="field"><th class="field-name">Returns :</th><td class="field-body"><strong>None</strong> :</td>
-</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">io</span><span class="o">.</span><span class="n">checkfile</span><span class="p">(</span><span class="s">&#39;an_existing_file&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">io</span><span class="o">.</span><span class="n">checkfile</span><span class="p">(</span><span class="s">&#39;a_non_existing_file&#39;</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n-Identifier">&lt;module&gt;</span>
File <span class="nb">&quot;/home/epfl/revaz/local/lib64/python2.6/site-packages/pNbody/io.py&quot;</span>, line <span class="m">33</span>, in <span class="n-Identifier">checkfile</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="mi">915</span><span class="p">,</span><span class="s">&#39;file </span><span class="si">%s</span><span class="s"> not found ! Pease check the file name.&#39;</span><span class="o">%</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
<span class="nc">IOError</span>: <span class="n-Identifier">[Errno 915] file nofile not found ! Pease check the file name. </span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="pNbody.io.end_of_file">
<tt class="descclassname">pNbody.io.</tt><tt class="descname">end_of_file</tt><big>(</big><em>f</em>, <em>pio='no'</em>, <em>MPI=None</em><big>)</big><a class="headerlink" href="#pNbody.io.end_of_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True if we have reached the end of the file f, False instead</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>f</strong> : ndarray or matrix object</p>
<blockquote>
-<p>an open file</p>
-</blockquote>
+<div><p>an open file</p>
+</div></blockquote>
<p><strong>pio</strong> : &#8216;yes&#8217; or &#8216;no&#8217;</p>
<blockquote>
-<p>if the file is read in parallel or not</p>
-</blockquote>
+<div><p>if the file is read in parallel or not</p>
+</div></blockquote>
<p><strong>MPI</strong> : MPI communicator</p>
</td>
</tr>
<tr class="field"><th class="field-name">Returns :</th><td class="field-body"><p class="first"><strong>status</strong> : Bool</p>
<blockquote class="last">
-<p>True if the we reached the end of the file
+<div><p>True if the we reached the end of the file
False if not</p>
-</blockquote>
+</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pNbody.io.write_array">
<tt class="descclassname">pNbody.io.</tt><tt class="descname">write_array</tt><big>(</big><em>file</em>, <em>vec</em><big>)</big><a class="headerlink" href="#pNbody.io.write_array" title="Permalink to this definition">¶</a></dt>
-<dd><p>Write an array to a file.</p>
+<dd><p>Write an array to a file, in a very simple ascii format.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>file</strong> : the path to a file</p>
<p class="last"><strong>vec</strong> : an ndarray object</p>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">numpy</span> <span class="kn">import</span> <span class="o">*</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">array</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">])</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">io</span><span class="o">.</span><span class="n">write_array</span><span class="p">(</span><span class="s">&#39;/tmp/array.dat&#39;</span><span class="p">,</span><span class="n">x</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
-<dt id="pNbody.io.testfct">
-<tt class="descclassname">pNbody.io.</tt><tt class="descname">testfct</tt><big>(</big><big>)</big><a class="headerlink" href="#pNbody.io.testfct" title="Permalink to this definition">¶</a></dt>
-<dd><p>Raise a square matrix to the (integer) power <cite>n</cite>.</p>
-<p>For positive integers <cite>n</cite>, the power is computed by repeated matrix
-squarings and matrix multiplications. If <tt class="docutils literal"><span class="pre">n</span> <span class="pre">==</span> <span class="pre">0</span></tt>, the identity matrix
-of the same shape as M is returned. If <tt class="docutils literal"><span class="pre">n</span> <span class="pre">&lt;</span> <span class="pre">0</span></tt>, the inverse
-is computed and then raised to the <tt class="docutils literal"><span class="pre">abs(n)</span></tt>.</p>
+<dt id="pNbody.io.read_ascii">
+<tt class="descclassname">pNbody.io.</tt><tt class="descname">read_ascii</tt><big>(</big><em>file</em>, <em>columns=None</em>, <em>lines=None</em>, <em>dtype=&lt;type 'float'&gt;</em>, <em>skipheader=False</em>, <em>cchar='#'</em><big>)</big><a class="headerlink" href="#pNbody.io.read_ascii" title="Permalink to this definition">¶</a></dt>
+<dd><p>Read an ascii file.
+The function allows to set the number of columns or line to read.
+If it contains a header, the header is used to label all column. In
+this case, a dictionary is returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>M</strong> : ndarray or matrix object</p>
+<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>file</strong> : the path to a file or an open file</p>
+<p><strong>columns</strong> : list</p>
<blockquote>
-<p>Matrix to be &#8220;powered.&#8221; Must be square, i.e. <tt class="docutils literal"><span class="pre">M.shape</span> <span class="pre">==</span> <span class="pre">(m,</span> <span class="pre">m)</span></tt>,
-with <cite>m</cite> a positive integer.</p>
-</blockquote>
-<p><strong>n</strong> : int</p>
+<div><p>the list of the columns to read
+if none, all columns are read</p>
+</div></blockquote>
+<p><strong>lines</strong> : list</p>
<blockquote>
-<p>The exponent can be any integer or long integer, positive,
-negative, or zero.</p>
-</blockquote>
-</td>
-</tr>
-<tr class="field"><th class="field-name">Returns :</th><td class="field-body"><p class="first"><strong>M**n</strong> : ndarray or matrix object</p>
+<div><p>the list of the lines to read
+if none, all lines are read</p>
+</div></blockquote>
+<p><strong>dtype</strong> : dtype</p>
+<blockquote>
+<div><p>the ndtype of the objects to read</p>
+</div></blockquote>
+<p><strong>skipheader</strong> : bool</p>
<blockquote>
-<p>The return value is the same shape and type as <cite>M</cite>;
-if the exponent is positive or zero then the type of the
-elements is the same as those of <cite>M</cite>. If the exponent is
-negative the elements are floating-point.</p>
-</blockquote>
+<div><p>if true, do not read the header
+if there is one</p>
+</div></blockquote>
+<p><strong>cchar</strong> : char</p>
+<blockquote>
+<div><p>lines begining with cchar are skiped
+the first line is considered as the header</p>
+</div></blockquote>
</td>
</tr>
-<tr class="field"><th class="field-name">Raises :</th><td class="field-body"><p class="first"><strong>LinAlgError</strong> :</p>
+<tr class="field"><th class="field-name">Returns :</th><td class="field-body"><p class="first"><strong>data</strong> : Dict or ndarray</p>
<blockquote class="last">
-<p>If the matrix is not numerically invertible.</p>
-</blockquote>
+<div><p>A python dictionary or an ndarray object</p>
+</div></blockquote>
</td>
</tr>
</tbody>
</table>
-<div class="admonition-see-also admonition seealso">
-<p class="first admonition-title">See also</p>
-<dl class="last docutils">
-<dt><tt class="xref py py-obj docutils literal"><span class="pre">matrix</span></tt></dt>
-<dd>Provides an equivalent function as the exponentiation operator (<tt class="docutils literal"><span class="pre">**</span></tt>, not <tt class="docutils literal"><span class="pre">^</span></tt>).</dd>
-</dl>
+<p class="rubric">Examples</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">numpy</span> <span class="kn">import</span> <span class="o">*</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">arange</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">y</span> <span class="o">=</span> <span class="n">x</span><span class="o">*</span><span class="n">x</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">&#39;afile.txt&#39;</span><span class="p">,</span><span class="s">&#39;w&#39;</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;# x y&quot;</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)):</span>
+<span class="gp">... </span> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%g</span><span class="s"> </span><span class="si">%g</span><span class="s">&#39;</span><span class="o">%</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="n">i</span><span class="p">],</span><span class="n">y</span><span class="p">[</span><span class="n">i</span><span class="p">]))</span>
+<span class="gp">... </span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pNbody</span> <span class="kn">import</span> <span class="n">io</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="n">io</span><span class="o">.</span><span class="n">read_ascii</span><span class="p">(</span><span class="s">&quot;afile.txt&quot;</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">data</span><span class="p">[</span><span class="s">&#39;x&#39;</span><span class="p">]</span>
+<span class="go">array([ 0., 1., 2., 3., 4., 5., 6., 7., 8., 9.])</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">data</span><span class="p">[</span><span class="s">&#39;y&#39;</span><span class="p">]</span>
+<span class="go">array([ 0., 1., 4., 9., 16., 25., 36., 49., 64., 81.]) </span>
+</pre></div>
</div>
+</dd></dl>
+
+<dl class="function">
+<dt id="pNbody.io.write_dump">
+<tt class="descclassname">pNbody.io.</tt><tt class="descname">write_dump</tt><big>(</big><em>file</em>, <em>data</em><big>)</big><a class="headerlink" href="#pNbody.io.write_dump" title="Permalink to this definition">¶</a></dt>
+<dd><p>Write a dmp (pickle) file. In other word,
+dump the data object.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>file</strong> : the path to a file</p>
+<p class="last"><strong>data</strong> : a pickable python object</p>
+</td>
+</tr>
+</tbody>
+</table>
<p class="rubric">Examples</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">numpy</span> <span class="kn">import</span> <span class="n">linalg</span> <span class="k">as</span> <span class="n">LA</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">i</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">]])</span> <span class="c"># matrix equiv. of the imaginary unit</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">LA</span><span class="o">.</span><span class="n">matrix_power</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span> <span class="c"># should = -i</span>
-<span class="go">array([[ 0, -1],</span>
-<span class="go"> [ 1, 0]])</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">LA</span><span class="o">.</span><span class="n">matrix_power</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">matrix</span><span class="p">(</span><span class="n">i</span><span class="p">),</span> <span class="mi">3</span><span class="p">)</span> <span class="c"># matrix arg returns matrix</span>
-<span class="go">matrix([[ 0, -1],</span>
-<span class="go"> [ 1, 0]])</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">LA</span><span class="o">.</span><span class="n">matrix_power</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
-<span class="go">array([[1, 0],</span>
-<span class="go"> [0, 1]])</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">LA</span><span class="o">.</span><span class="n">matrix_power</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="o">-</span><span class="mi">3</span><span class="p">)</span> <span class="c"># should = 1/(-i) = i, but w/ f.p. elements</span>
-<span class="go">array([[ 0., 1.],</span>
-<span class="go"> [-1., 0.]])</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;a&#39;</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span><span class="s">&#39;b&#39;</span><span class="p">:</span><span class="mi">2</span><span class="p">}</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">io</span><span class="o">.</span><span class="n">write_dump</span><span class="p">(</span><span class="s">&#39;/tmp/afile.dmp&#39;</span><span class="p">,</span><span class="n">x</span><span class="p">)</span>
</pre></div>
</div>
-<p>Somewhat more sophisticated example</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">q</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">4</span><span class="p">,</span> <span class="mi">4</span><span class="p">))</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="o">-</span><span class="n">i</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="p">[</span><span class="mi">2</span><span class="p">:</span><span class="mi">4</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span><span class="mi">4</span><span class="p">]</span> <span class="o">=</span> <span class="n">i</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span> <span class="c"># one of the three quarternion units not equal to 1</span>
-<span class="go">array([[ 0., -1., 0., 0.],</span>
-<span class="go"> [ 1., 0., 0., 0.],</span>
-<span class="go"> [ 0., 0., 0., 1.],</span>
-<span class="go"> [ 0., 0., -1., 0.]])</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">LA</span><span class="o">.</span><span class="n">matrix_power</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="c"># = -np.eye(4)</span>
-<span class="go">array([[-1., 0., 0., 0.],</span>
-<span class="go"> [ 0., -1., 0., 0.],</span>
-<span class="go"> [ 0., 0., -1., 0.],</span>
-<span class="go"> [ 0., 0., 0., -1.]])</span>
+</dd></dl>
+
+<dl class="function">
+<dt id="pNbody.io.read_dump">
+<tt class="descclassname">pNbody.io.</tt><tt class="descname">read_dump</tt><big>(</big><em>file</em><big>)</big><a class="headerlink" href="#pNbody.io.read_dump" title="Permalink to this definition">¶</a></dt>
+<dd><p>Read a dmp (pickle) file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><strong>file</strong> : the path to a file</td>
+</tr>
+<tr class="field"><th class="field-name">Returns :</th><td class="field-body"><strong>data</strong> : a python object</td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;a&#39;</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span><span class="s">&#39;b&#39;</span><span class="p">:</span><span class="mi">2</span><span class="p">}</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">io</span><span class="o">.</span><span class="n">write_dump</span><span class="p">(</span><span class="s">&#39;/tmp/afile.dmp&#39;</span><span class="p">,</span><span class="n">x</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">y</span> <span class="o">=</span> <span class="n">io</span><span class="o">.</span><span class="n">read_dump</span><span class="p">(</span><span class="s">&#39;/tmp/afile.dmp&#39;</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">y</span>
+<span class="go">{&#39;a&#39;: 1, &#39;b&#39;: 2} </span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/icon-small.jpg" alt="Logo"/>
+ </a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="Overview.html"
title="previous chapter">Overview</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/rst/Io.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="Overview.html" title="Overview"
>previous</a> |</li>
<li><a href="../index.html">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Yves Revaz.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/Doc/newdoc/_build/html/rst/Overview.html b/Doc/newdoc/_build/html/rst/Overview.html
index 26b0200..e0c0581 100644
--- a/Doc/newdoc/_build/html/rst/Overview.html
+++ b/Doc/newdoc/_build/html/rst/Overview.html
@@ -1,109 +1,126 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview &mdash; pNbody v4 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pNbody v4 documentation" href="../index.html" />
<link rel="next" title="the Io module" href="Io.html" />
<link rel="prev" title="Welcome to pNbody’s documentation!" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="Io.html" title="the Io module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../index.html" title="Welcome to pNbody’s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
+<p>pNbody is a parallelized python module toolbox designed to manipulate and display
+interactively very lage N-body systems.</p>
+<p>Its oriented object approche allows the user to perform complicate manipulation
+with only very few commands.</p>
+<p>As python is an interpreted language, the user can load an N-body system and explore it
+interactively using the python interpreter. pNbody may also be used in python scripts.</p>
+<p>The module also contains graphical facilities desinged to create maps of physical values of
+the system, like density maps, temperture maps, velocites maps, etc. Stereo capabilities are
+also implemented.</p>
+<p>pNbody is not limited by file format. Each user may redefine in a parameter file how to read
+its prefered format.</p>
+<p>Its new parallel (mpi) facilities make it works on computer cluster without being limitted by
+memory consumption. It has already been tested with several millions of particles.</p>
+<img alt="../_images/cosmo.png" src="../_images/cosmo.png" />
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="../index.html">
+ <img class="logo" src="../_static/icon-small.jpg" alt="Logo"/>
+ </a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="../index.html"
title="previous chapter">Welcome to pNbody&#8217;s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Io.html"
title="next chapter">the Io module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/rst/Overview.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="Io.html" title="the Io module"
>next</a> |</li>
<li class="right" >
<a href="../index.html" title="Welcome to pNbody’s documentation!"
>previous</a> |</li>
<li><a href="../index.html">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Yves Revaz.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/Doc/newdoc/_build/html/search.html b/Doc/newdoc/_build/html/search.html
index 1eb9483..dea8efd 100644
--- a/Doc/newdoc/_build/html/search.html
+++ b/Doc/newdoc/_build/html/search.html
@@ -1,96 +1,99 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; pNbody v4 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="pNbody v4 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="search-documentation">Search</h1>
<div id="fallback" class="admonition warning">
<script type="text/javascript">$('#fallback').hide();</script>
<p>
Please activate JavaScript to enable the search
functionality.
</p>
</div>
<p>
From here you can search these documents. Enter your search
words into the box below and click "search". Note that the search
function will automatically search for all of the words. Pages
containing fewer words won't appear in the result list.
</p>
<form action="" method="get">
<input type="text" name="q" value="" />
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results">
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
+ <p class="logo"><a href="index.html">
+ <img class="logo" src="_static/icon-small.jpg" alt="Logo"/>
+ </a></p>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">pNbody v4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Yves Revaz.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/Doc/newdoc/_build/html/searchindex.js b/Doc/newdoc/_build/html/searchindex.js
index 313287c..7535917 100644
--- a/Doc/newdoc/_build/html/searchindex.js
+++ b/Doc/newdoc/_build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({objects:{"pNbody.io":{write_array:[0,0,1],checkfile:[0,0,1],testfct:[0,0,1],end_of_file:[0,0,1]}},terms:{testfct:0,checkfil:0,shape:0,end_of_fil:0,paramet:0,also:0,should:0,vec:0,input:[],expon:0,local:0,modul:[0,1],"return":0,read:0,mpi:0,dat:0,python2:0,name:0,quarternion:0,integ:0,found:0,path:0,revaz:0,page:1,zero:0,arg:0,home:0,tmp:0,index:1,statu:0,matrix:0,neg:0,content:1,matrix_pow:0,an_existing_fil:0,"import":0,lib64:0,equiv:0,imaginari:0,nofil:0,power:0,numer:0,gener:0,sophist:0,linalgerror:0,element:0,epfl:0,interpret:[],search:1,last:0,traceback:0,equal:0,oper:0,point:0,overview:[1,2],arrai:0,"float":0,three:0,filenam:0,unlik:[],alreadi:[],ioerror:0,comput:0,open:0,unit:0,from:0,exponenti:0,errno:0,invert:0,numpi:0,invers:0,"long":0,call:0,valu:0,recent:0,type:0,more:0,"function":0,linalg:0,copi:[],ani:0,somewhat:0,line:0,"true":0,those:0,must:0,commun:0,none:0,ident:0,provid:0,see:0,can:0,error:0,posit:0,write_arrai:0,file:0,pio:0,"int":0,site:0,indic:1,packag:0,exist:0,have:0,tabl:1,asmatrix:[],ascii:[],check:0,end:0,welcom:1,a_non_existing_fil:0,pnbodi:[0,1],make:[],same:0,write:0,fals:0,bool:0,instead:0,document:1,repeat:0,mat:[],object:0,reach:0,peas:0,ndarrai:0,most:0,rais:0,multipl:0,data:[],parallel:0,squar:0,equival:0,array_lik:[],stdin:0,doe:0,exampl:0},objtypes:{"0":"py:function"},titles:["the Io module","Welcome to pNbody&#8217;s documentation!","Overview"],objnames:{"0":"Python function"},filenames:["rst/Io","index","rst/Overview"]})
\ No newline at end of file
+Search.setIndex({objects:{"pNbody.io":{read_dump:[1,1,1],checkfile:[1,1,1],read_ascii:[1,1,1],write_dump:[1,1,1],write_array:[1,1,1],end_of_file:[1,1,1]}},terms:{load:7,all:1,design7:5,movi:5,ndtype:1,thi:[1,6],testfct:[],checkfil:1,squar:[],shape:[],pythonx:6,end_of_fil:1,follow:[4,5],afil:1,fine:5,languag:7,paramet:[1,7],write:1,onli:[2,7],depend:4,system:7,read_ascii:1,also:7,skipe:1,should:[],openmpi:5,dict:1,vec:1,densiti:7,mpich:[],input:[],expon:[],local:1,modul:[4,0,5,1,7],applic:5,scipi:5,"return":1,format:[1,5,7],read:[1,7],doe:1,pypi:5,mpi:[1,5,7],dat:1,an_existing_fil:1,graphic:7,testal:6,commun:1,"new":[5,7],veri:[1,7],toolbox:7,now:4,special:5,python2:1,like:[6,7],specif:[],header:1,quarternion:[],list:1,prefix:4,integ:[],"default":4,approch:7,each:7,found:1,path:1,revaz:1,where:6,page:0,compil:[4,5,2],www:5,set:1,dump:1,map:7,write_dump:1,begin:1,redefin:7,zero:[],possibl:4,design:7,tempertur:7,arg:[],home:1,orient:7,particl:7,mat:[],tmp:1,index:[0,5],statu:1,mpeg:5,matrix:1,neg:[],label:1,content:0,python_directori:6,prerequist:[0,5,2],matrix_pow:[],mencod:5,"import":1,lib64:1,equiv:[],complic:7,imaginari:[],php:5,nofil:1,arang:1,write_arrai:1,million:7,imagemagick:5,power:[],numer:[],gener:1,manipul:7,chang:6,sophist:[],len:1,standard:[4,5],bodi:7,linalgerror:[],explor:7,dictionari:1,epfl:1,mplayer:5,valu:7,addit:5,mplayerhq:5,convert:5,last:1,capabl:[5,7],column:1,traceback:1,equal:[],etc:7,rais:1,xrang:1,fals:1,implement:7,com:5,interact:7,first:1,oper:[],useful:5,point:[],dtype:1,arrai:1,"float":1,prefer:7,number:1,two:5,filenam:1,unlik:[],alreadi:7,been:7,linux:2,wrap:5,pythonwar:5,txt:1,open:1,your:[4,6],unit:[],three:[],from:[4,0,2,1],creat:7,simpli:6,script:[5,7],errno:1,invert:[],support:2,numpi:[1,5],invers:[],"long":[],name:1,gif:5,without:7,call:1,interpret:7,desing:7,basic:5,overview:[0,7],lage:7,ioerror:1,velocit:7,type:[1,6],usr:6,"function":[1,5],gnu:5,option:4,linalg:[],python:[4,1,5,6,7],imag:5,copi:[],search:0,site:[1,6],warn:6,somewhat:[],cheeseshop:5,line:1,"true":1,than:4,those:[],must:6,"case":1,read_dump:1,none:1,ident:[],word:1,other_directori:4,comput:7,provid:[],gcc:5,setup:4,work:7,displai:7,can:7,mpi4pi:5,dmp:1,directori:[4,6],recent:1,limit:7,pickabl:1,error:1,posit:[],consumpt:7,more:[],root:4,html:5,pil:5,file:[4,1,7],tar:4,pio:1,"int":[],few:7,indic:0,facil:7,"char":1,cluster:7,sourc:[4,0,2],exponenti:[],have:1,tabl:0,close:1,exist:1,asmatrix:[],ascii:1,check:[1,0,6,2],sever:7,packag:[1,5,6],tarbal:[4,2],end:1,welcom:0,lib:6,perform:[4,7],pnbodi:[0,1,2,4,5,6,7],make:7,skiphead:1,same:[],instal:[4,0,6,2],note:6,how:7,need:[4,5],curent:2,bool:1,build:4,test:7,instead:1,you:4,document:0,simpl:1,cchar:1,higher:5,lam:[],product:5,repeat:[],http:5,distribut:5,see:[],org:5,object:[1,7],reach:1,peas:1,ndarrai:1,decompress:[4,2],most:1,xzf:4,want:4,user:7,consid:1,aproch:[],mai:7,multipl:[],memeri:[],contain:[1,7],data:1,parallel:[1,5,7],physic:7,a_non_existing_fil:1,other:1,memori:7,stereo:7,equival:[],array_lik:[],ani:[],stdin:1,well:5,element:[],pickl:1,look:6,anoth:4,exampl:[1,0,3,6,2],command:[4,7],allow:[1,7],enter:4,order:5,usual:6},objtypes:{"0":"py:function","1":"np:function"},titles:["Welcome to pNbody&#8217;s documentation!","the Io module","Installation","Examples","Installing from source","Prerequiste","Check the installation","Overview"],objnames:{"0":"Python function","1":"Python function"},filenames:["index","rst/Io","rst/Installation","rst/Documentation_and_examples","rst/Installing_from_tarball","rst/Prerequiste","rst/Test_the_installation","rst/Overview"]})
\ No newline at end of file
diff --git a/Doc/newdoc/conf.py b/Doc/newdoc/conf.py
index ad6140a..9a4d010 100644
--- a/Doc/newdoc/conf.py
+++ b/Doc/newdoc/conf.py
@@ -1,263 +1,263 @@
# -*- coding: utf-8 -*-
#
# pNbody documentation build configuration file, created by
# sphinx-quickstart on Wed Aug 24 16:29:02 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
sys.path.insert(0, os.path.abspath('./sphinxext'))
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath','numpydoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'pNbody'
copyright = u'2011, Yves Revaz'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '4'
# The full version, including alpha/beta/rc tags.
release = '4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-#html_logo = None
+html_logo = 'icon-small.jpg'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'pNbodydoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'pNbody.tex', u'pNbody Documentation',
u'Yves Revaz', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pnbody', u'pNbody Documentation',
[u'Yves Revaz'], 1)
]
# -----------------------------------------------------------------------------
# Numpy extensions
# -----------------------------------------------------------------------------
# If we want to do a phantom import from an XML file for all autodocs
#phantom_import_file = 'dump.xml'
# Make numpydoc to generate plots for example sections
numpydoc_use_plots = True
# -----------------------------------------------------------------------------
# Plots
# -----------------------------------------------------------------------------
plot_pre_code = """
import numpy as np
np.random.seed(0)
"""
plot_include_source = True
plot_formats = [('png', 100), 'pdf']
import math
phi = (math.sqrt(5) + 1)/2
import matplotlib
matplotlib.rcParams.update({
'font.size': 8,
'axes.titlesize': 8,
'axes.labelsize': 8,
'xtick.labelsize': 8,
'ytick.labelsize': 8,
'legend.fontsize': 8,
'figure.figsize': (3*phi, 3),
'figure.subplot.bottom': 0.2,
'figure.subplot.left': 0.2,
'figure.subplot.right': 0.9,
'figure.subplot.top': 0.85,
'figure.subplot.wspace': 0.4,
'text.usetex': False,
})
diff --git a/Doc/newdoc/index.rst b/Doc/newdoc/index.rst
index 28288c5..b8c7773 100644
--- a/Doc/newdoc/index.rst
+++ b/Doc/newdoc/index.rst
@@ -1,23 +1,24 @@
.. pNbody documentation master file, created by
sphinx-quickstart on Wed Aug 24 16:29:02 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pNbody's documentation!
==================================
Contents:
.. toctree::
:maxdepth: 2
rst/Overview
+ rst/Installation
rst/Io
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
diff --git a/Doc/newdoc/rst/Overview.rst b/Doc/newdoc/rst/Overview.rst
index cf5b28c..04c6c96 100644
--- a/Doc/newdoc/rst/Overview.rst
+++ b/Doc/newdoc/rst/Overview.rst
@@ -1,7 +1,26 @@
Overview
**********************
-.. currentmodule:: pNbody.io
+pNbody is a parallelized python module toolbox designed to manipulate and display
+interactively very lage N-body systems.
+Its oriented object approche allows the user to perform complicate manipulation
+with only very few commands.
+As python is an interpreted language, the user can load an N-body system and explore it
+interactively using the python interpreter. pNbody may also be used in python scripts.
+
+The module also contains graphical facilities desinged to create maps of physical values of
+the system, like density maps, temperture maps, velocites maps, etc. Stereo capabilities are
+also implemented.
+
+pNbody is not limited by file format. Each user may redefine in a parameter file how to read
+its prefered format.
+
+Its new parallel (mpi) facilities make it works on computer cluster without being limitted by
+memory consumption. It has already been tested with several millions of particles.
+
+
+
+.. image:: ../images/cosmo.png
diff --git a/Doc/newdoc/sphinxext/docscrape.pyc b/Doc/newdoc/sphinxext/docscrape.pyc
index 0456e9f..75c18ee 100644
Binary files a/Doc/newdoc/sphinxext/docscrape.pyc and b/Doc/newdoc/sphinxext/docscrape.pyc differ
diff --git a/Doc/newdoc/sphinxext/docscrape_sphinx.pyc b/Doc/newdoc/sphinxext/docscrape_sphinx.pyc
index f0bf77b..2d4d7f4 100644
Binary files a/Doc/newdoc/sphinxext/docscrape_sphinx.pyc and b/Doc/newdoc/sphinxext/docscrape_sphinx.pyc differ
diff --git a/Doc/newdoc/sphinxext/numpydoc.pyc b/Doc/newdoc/sphinxext/numpydoc.pyc
index 94acc49..5db5291 100644
Binary files a/Doc/newdoc/sphinxext/numpydoc.pyc and b/Doc/newdoc/sphinxext/numpydoc.pyc differ

Event Timeline