Change pypol to linpy
authorDani <dbo122@aol.com>
Mon, 4 Aug 2014 13:24:07 +0000 (15:24 +0200)
committerDani <dbo122@aol.com>
Mon, 4 Aug 2014 13:24:07 +0000 (15:24 +0200)
doc/domain.rst
doc/examples.rst
doc/index.rst
doc/install.rst
doc/modules.rst

index e45b0fb..7098c32 100644 (file)
@@ -17,10 +17,13 @@ Domains Module
     
         Returns a domain as disjoint.
         
-    .. py:method:: involves_vars(self, vars)
-    
-       Returns ``True`` if a domain depends on the given variables.
+    .. py:method:: num_parameters   
+        
+        Returns the total number of parameters, input, output or dimensions in a domain.
         
+    .. py:method:: involves_dims(self, dims)
+    
+       Returns ``True`` if a domain depends on the given dimensions. 
         
     The unary properties of a domain can be inspected using the following methods. 
     
index f3fbfb3..7a390d3 100644 (file)
@@ -1,4 +1,4 @@
-Pypol Examples
+Linpy Examples
 ==============
 
 Creating a Polyhedron
index b75e85e..97e6157 100644 (file)
@@ -3,13 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to pypol's documentation!
+Welcome to Linpy’s documentation!
 =================================
 
-Pypol is a Python library for symbolic mathematics.
-If you are new to Pypol, start with the Tutorial.
+Linpy is a Python library for symbolic mathematics.
+If you are new to Linpy, start with the Examples.
 
-This is the central page for all of Pypol's documentation.
+This is the central page for all of Linpy’s documentation.
 
 
 Contents:
index 545e773..a19f9ba 100644 (file)
@@ -3,21 +3,27 @@
 Installation
 ------------
 
-Dependencies
-============
+Source
+======
 
-Pypol requires at least Python3.4. Users will first need to install Integer Set Library (isl). The source files of isl are available as a tarball or a git repository. Both are available `here`_ .  
+Users can install Linpy by cloning the git repository::
 
+       git clone https://scm.cri.ensmp.fr/git/pypol.git
 
-Source
-======
+Install
+=======
 
-add link to pypi pypol documentation.
+…execute `setup.py` 
 
-Git
-===
+Dependencies
+============
+
+Linpy has several dependencies. Users will first need to install Integer Set Library (isl). The source files of isl are available as a tarball or a git repository. Both are available `here`_ .  
+
+To use the Linpy plotting function, users need to install matplotlib using instructions in the following `link`_.
 
-add link to git repo
 
 
 .. _here: http://freshmeat.net/projects/isl/
+
+.. _link: http://matplotlib.org/faq/installing_faq.html
\ No newline at end of file
index 2ecf371..0645c7a 100644 (file)
@@ -1,9 +1,9 @@
 .. module-docs:
 
-Pypol Module Reference
+Linpy Module Reference
 ======================
 
-There are four main Pypol modules:
+There are four main Linpy modules:
 
 .. toctree::
    :maxdepth: 2