switch to version 3.0.0-beta9

space

LICENSE

@@ -0,0 +1,518 @@
+
+  CeCILL FREE SOFTWARE LICENSE AGREEMENT
+
+Version 2.1 dated 2013-06-21
+
+
+    Notice
+
+This Agreement is a Free Software license agreement that is the result
+of discussions between its authors in order to ensure compliance with
+the two main principles guiding its drafting:
+
+  * firstly, compliance with the principles governing the distribution
+    of Free Software: access to source code, broad rights granted to users,
+  * secondly, the election of a governing law, French law, with which it
+    is conformant, both as regards the law of torts and intellectual
+    property law, and the protection that it offers to both authors and
+    holders of the economic rights over software.
+
+The authors of the CeCILL (for Ce[a] C[nrs] I[nria] L[ogiciel] L[ibre]) 
+license are: 
+
+Commissariat à l'énergie atomique et aux énergies alternatives - CEA, a
+public scientific, technical and industrial research establishment,
+having its principal place of business at 25 rue Leblanc, immeuble Le
+Ponant D, 75015 Paris, France.
+
+Centre National de la Recherche Scientifique - CNRS, a public scientific
+and technological establishment, having its principal place of business
+at 3 rue Michel-Ange, 75794 Paris cedex 16, France.
+
+Institut National de Recherche en Informatique et en Automatique -
+Inria, a public scientific and technological establishment, having its
+principal place of business at Domaine de Voluceau, Rocquencourt, BP
+105, 78153 Le Chesnay cedex, France.
+
+
+    Preamble
+
+The purpose of this Free Software license agreement is to grant users
+the right to modify and redistribute the software governed by this
+license within the framework of an open source distribution model.
+
+The exercising of this right is conditional upon certain obligations for
+users so as to preserve this status for all subsequent redistributions.
+
+In consideration of access to the source code and the rights to copy,
+modify and redistribute granted by the license, users are provided only
+with a limited warranty and the software's author, the holder of the
+economic rights, and the successive licensors only have limited liability.
+
+In this respect, the risks associated with loading, using, modifying
+and/or developing or reproducing the software by the user are brought to
+the user's attention, given its Free Software status, which may make it
+complicated to use, with the result that its use is reserved for
+developers and experienced professionals having in-depth computer
+knowledge. Users are therefore encouraged to load and test the
+suitability of the software as regards their requirements in conditions
+enabling the security of their systems and/or data to be ensured and,
+more generally, to use and operate it in the same conditions of
+security. This Agreement may be freely reproduced and published,
+provided it is not altered, and that no provisions are either added or
+removed herefrom.
+
+This Agreement may apply to any or all software for which the holder of
+the economic rights decides to submit the use thereof to its provisions.
+
+Frequently asked questions can be found on the official website of the
+CeCILL licenses family (http://www.cecill.info/index.en.html) for any 
+necessary clarification.
+
+
+    Article 1 - DEFINITIONS
+
+For the purpose of this Agreement, when the following expressions
+commence with a capital letter, they shall have the following meaning:
+
+Agreement: means this license agreement, and its possible subsequent
+versions and annexes.
+
+Software: means the software in its Object Code and/or Source Code form
+and, where applicable, its documentation, "as is" when the Licensee
+accepts the Agreement.
+
+Initial Software: means the Software in its Source Code and possibly its
+Object Code form and, where applicable, its documentation, "as is" when
+it is first distributed under the terms and conditions of the Agreement.
+
+Modified Software: means the Software modified by at least one
+Contribution.
+
+Source Code: means all the Software's instructions and program lines to
+which access is required so as to modify the Software.
+
+Object Code: means the binary files originating from the compilation of
+the Source Code.
+
+Holder: means the holder(s) of the economic rights over the Initial
+Software.
+
+Licensee: means the Software user(s) having accepted the Agreement.
+
+Contributor: means a Licensee having made at least one Contribution.
+
+Licensor: means the Holder, or any other individual or legal entity, who
+distributes the Software under the Agreement.
+
+Contribution: means any or all modifications, corrections, translations,
+adaptations and/or new functions integrated into the Software by any or
+all Contributors, as well as any or all Internal Modules.
+
+Module: means a set of sources files including their documentation that
+enables supplementary functions or services in addition to those offered
+by the Software.
+
+External Module: means any or all Modules, not derived from the
+Software, so that this Module and the Software run in separate address
+spaces, with one calling the other when they are run.
+
+Internal Module: means any or all Module, connected to the Software so
+that they both execute in the same address space.
+
+GNU GPL: means the GNU General Public License version 2 or any
+subsequent version, as published by the Free Software Foundation Inc.
+
+GNU Affero GPL: means the GNU Affero General Public License version 3 or
+any subsequent version, as published by the Free Software Foundation Inc.
+
+EUPL: means the European Union Public License version 1.1 or any
+subsequent version, as published by the European Commission.
+
+Parties: mean both the Licensee and the Licensor.
+
+These expressions may be used both in singular and plural form.
+
+
+    Article 2 - PURPOSE
+
+The purpose of the Agreement is the grant by the Licensor to the
+Licensee of a non-exclusive, transferable and worldwide license for the
+Software as set forth in Article 5 <#scope> hereinafter for the whole
+term of the protection granted by the rights over said Software.
+
+
+    Article 3 - ACCEPTANCE
+
+3.1 The Licensee shall be deemed as having accepted the terms and
+conditions of this Agreement upon the occurrence of the first of the
+following events:
+
+  * (i) loading the Software by any or all means, notably, by
+    downloading from a remote server, or by loading from a physical medium;
+  * (ii) the first time the Licensee exercises any of the rights granted
+    hereunder.
+
+3.2 One copy of the Agreement, containing a notice relating to the
+characteristics of the Software, to the limited warranty, and to the
+fact that its use is restricted to experienced users has been provided
+to the Licensee prior to its acceptance as set forth in Article 3.1
+<#accepting> hereinabove, and the Licensee hereby acknowledges that it
+has read and understood it.
+
+
+    Article 4 - EFFECTIVE DATE AND TERM
+
+
+      4.1 EFFECTIVE DATE
+
+The Agreement shall become effective on the date when it is accepted by
+the Licensee as set forth in Article 3.1 <#accepting>.
+
+
+      4.2 TERM
+
+The Agreement shall remain in force for the entire legal term of
+protection of the economic rights over the Software.
+
+
+    Article 5 - SCOPE OF RIGHTS GRANTED
+
+The Licensor hereby grants to the Licensee, who accepts, the following
+rights over the Software for any or all use, and for the term of the
+Agreement, on the basis of the terms and conditions set forth hereinafter.
+
+Besides, if the Licensor owns or comes to own one or more patents
+protecting all or part of the functions of the Software or of its
+components, the Licensor undertakes not to enforce the rights granted by
+these patents against successive Licensees using, exploiting or
+modifying the Software. If these patents are transferred, the Licensor
+undertakes to have the transferees subscribe to the obligations set
+forth in this paragraph.
+
+
+      5.1 RIGHT OF USE
+
+The Licensee is authorized to use the Software, without any limitation
+as to its fields of application, with it being hereinafter specified
+that this comprises:
+
+ 1. permanent or temporary reproduction of all or part of the Software
+    by any or all means and in any or all form.
+
+ 2. loading, displaying, running, or storing the Software on any or all
+    medium.
+
+ 3. entitlement to observe, study or test its operation so as to
+    determine the ideas and principles behind any or all constituent
+    elements of said Software. This shall apply when the Licensee
+    carries out any or all loading, displaying, running, transmission or
+    storage operation as regards the Software, that it is entitled to
+    carry out hereunder.
+
+
+      5.2 ENTITLEMENT TO MAKE CONTRIBUTIONS
+
+The right to make Contributions includes the right to translate, adapt,
+arrange, or make any or all modifications to the Software, and the right
+to reproduce the resulting software.
+
+The Licensee is authorized to make any or all Contributions to the
+Software provided that it includes an explicit notice that it is the
+author of said Contribution and indicates the date of the creation thereof.
+
+
+      5.3 RIGHT OF DISTRIBUTION
+
+In particular, the right of distribution includes the right to publish,
+transmit and communicate the Software to the general public on any or
+all medium, and by any or all means, and the right to market, either in
+consideration of a fee, or free of charge, one or more copies of the
+Software by any means.
+
+The Licensee is further authorized to distribute copies of the modified
+or unmodified Software to third parties according to the terms and
+conditions set forth hereinafter.
+
+
+        5.3.1 DISTRIBUTION OF SOFTWARE WITHOUT MODIFICATION
+
+The Licensee is authorized to distribute true copies of the Software in
+Source Code or Object Code form, provided that said distribution
+complies with all the provisions of the Agreement and is accompanied by:
+
+ 1. a copy of the Agreement,
+
+ 2. a notice relating to the limitation of both the Licensor's warranty
+    and liability as set forth in Articles 8 and 9,
+
+and that, in the event that only the Object Code of the Software is
+redistributed, the Licensee allows effective access to the full Source
+Code of the Software for a period of at least three years from the
+distribution of the Software, it being understood that the additional
+acquisition cost of the Source Code shall not exceed the cost of the
+data transfer.
+
+
+        5.3.2 DISTRIBUTION OF MODIFIED SOFTWARE
+
+When the Licensee makes a Contribution to the Software, the terms and
+conditions for the distribution of the resulting Modified Software
+become subject to all the provisions of this Agreement.
+
+The Licensee is authorized to distribute the Modified Software, in
+source code or object code form, provided that said distribution
+complies with all the provisions of the Agreement and is accompanied by:
+
+ 1. a copy of the Agreement,
+
+ 2. a notice relating to the limitation of both the Licensor's warranty
+    and liability as set forth in Articles 8 and 9,
+
+and, in the event that only the object code of the Modified Software is
+redistributed,
+
+ 3. a note stating the conditions of effective access to the full source
+    code of the Modified Software for a period of at least three years
+    from the distribution of the Modified Software, it being understood
+    that the additional acquisition cost of the source code shall not
+    exceed the cost of the data transfer.
+
+
+        5.3.3 DISTRIBUTION OF EXTERNAL MODULES
+
+When the Licensee has developed an External Module, the terms and
+conditions of this Agreement do not apply to said External Module, that
+may be distributed under a separate license agreement.
+
+
+        5.3.4 COMPATIBILITY WITH OTHER LICENSES
+
+The Licensee can include a code that is subject to the provisions of one
+of the versions of the GNU GPL, GNU Affero GPL and/or EUPL in the
+Modified or unmodified Software, and distribute that entire code under
+the terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL.
+
+The Licensee can include the Modified or unmodified Software in a code
+that is subject to the provisions of one of the versions of the GNU GPL,
+GNU Affero GPL and/or EUPL and distribute that entire code under the
+terms of the same version of the GNU GPL, GNU Affero GPL and/or EUPL.
+
+
+    Article 6 - INTELLECTUAL PROPERTY
+
+
+      6.1 OVER THE INITIAL SOFTWARE
+
+The Holder owns the economic rights over the Initial Software. Any or
+all use of the Initial Software is subject to compliance with the terms
+and conditions under which the Holder has elected to distribute its work
+and no one shall be entitled to modify the terms and conditions for the
+distribution of said Initial Software.
+
+The Holder undertakes that the Initial Software will remain ruled at
+least by this Agreement, for the duration set forth in Article 4.2 <#term>.
+
+
+      6.2 OVER THE CONTRIBUTIONS
+
+The Licensee who develops a Contribution is the owner of the
+intellectual property rights over this Contribution as defined by
+applicable law.
+
+
+      6.3 OVER THE EXTERNAL MODULES
+
+The Licensee who develops an External Module is the owner of the
+intellectual property rights over this External Module as defined by
+applicable law and is free to choose the type of agreement that shall
+govern its distribution.
+
+
+      6.4 JOINT PROVISIONS
+
+The Licensee expressly undertakes:
+
+ 1. not to remove, or modify, in any manner, the intellectual property
+    notices attached to the Software;
+
+ 2. to reproduce said notices, in an identical manner, in the copies of
+    the Software modified or not.
+
+The Licensee undertakes not to directly or indirectly infringe the
+intellectual property rights on the Software of the Holder and/or
+Contributors, and to take, where applicable, vis-à-vis its staff, any
+and all measures required to ensure respect of said intellectual
+property rights of the Holder and/or Contributors.
+
+
+    Article 7 - RELATED SERVICES
+
+7.1 Under no circumstances shall the Agreement oblige the Licensor to
+provide technical assistance or maintenance services for the Software.
+
+However, the Licensor is entitled to offer this type of services. The
+terms and conditions of such technical assistance, and/or such
+maintenance, shall be set forth in a separate instrument. Only the
+Licensor offering said maintenance and/or technical assistance services
+shall incur liability therefor.
+
+7.2 Similarly, any Licensor is entitled to offer to its licensees, under
+its sole responsibility, a warranty, that shall only be binding upon
+itself, for the redistribution of the Software and/or the Modified
+Software, under terms and conditions that it is free to decide. Said
+warranty, and the financial terms and conditions of its application,
+shall be subject of a separate instrument executed between the Licensor
+and the Licensee.
+
+
+    Article 8 - LIABILITY
+
+8.1 Subject to the provisions of Article 8.2, the Licensee shall be
+entitled to claim compensation for any direct loss it may have suffered
+from the Software as a result of a fault on the part of the relevant
+Licensor, subject to providing evidence thereof.
+
+8.2 The Licensor's liability is limited to the commitments made under
+this Agreement and shall not be incurred as a result of in particular:
+(i) loss due the Licensee's total or partial failure to fulfill its
+obligations, (ii) direct or consequential loss that is suffered by the
+Licensee due to the use or performance of the Software, and (iii) more
+generally, any consequential loss. In particular the Parties expressly
+agree that any or all pecuniary or business loss (i.e. loss of data,
+loss of profits, operating loss, loss of customers or orders,
+opportunity cost, any disturbance to business activities) or any or all
+legal proceedings instituted against the Licensee by a third party,
+shall constitute consequential loss and shall not provide entitlement to
+any or all compensation from the Licensor.
+
+
+    Article 9 - WARRANTY
+
+9.1 The Licensee acknowledges that the scientific and technical
+state-of-the-art when the Software was distributed did not enable all
+possible uses to be tested and verified, nor for the presence of
+possible defects to be detected. In this respect, the Licensee's
+attention has been drawn to the risks associated with loading, using,
+modifying and/or developing and reproducing the Software which are
+reserved for experienced users.
+
+The Licensee shall be responsible for verifying, by any or all means,
+the suitability of the product for its requirements, its good working
+order, and for ensuring that it shall not cause damage to either persons
+or properties.
+
+9.2 The Licensor hereby represents, in good faith, that it is entitled
+to grant all the rights over the Software (including in particular the
+rights set forth in Article 5 <#scope>).
+
+9.3 The Licensee acknowledges that the Software is supplied "as is" by
+the Licensor without any other express or tacit warranty, other than
+that provided for in Article 9.2 <#good-faith> and, in particular,
+without any warranty as to its commercial value, its secured, safe,
+innovative or relevant nature.
+
+Specifically, the Licensor does not warrant that the Software is free
+from any error, that it will operate without interruption, that it will
+be compatible with the Licensee's own equipment and software
+configuration, nor that it will meet the Licensee's requirements.
+
+9.4 The Licensor does not either expressly or tacitly warrant that the
+Software does not infringe any third party intellectual property right
+relating to a patent, software or any other property right. Therefore,
+the Licensor disclaims any and all liability towards the Licensee
+arising out of any or all proceedings for infringement that may be
+instituted in respect of the use, modification and redistribution of the
+Software. Nevertheless, should such proceedings be instituted against
+the Licensee, the Licensor shall provide it with technical and legal
+expertise for its defense. Such technical and legal expertise shall be
+decided on a case-by-case basis between the relevant Licensor and the
+Licensee pursuant to a memorandum of understanding. The Licensor
+disclaims any and all liability as regards the Licensee's use of the
+name of the Software. No warranty is given as regards the existence of
+prior rights over the name of the Software or as regards the existence
+of a trademark.
+
+
+    Article 10 - TERMINATION
+
+10.1 In the event of a breach by the Licensee of its obligations
+hereunder, the Licensor may automatically terminate this Agreement
+thirty (30) days after notice has been sent to the Licensee and has
+remained ineffective.
+
+10.2 A Licensee whose Agreement is terminated shall no longer be
+authorized to use, modify or distribute the Software. However, any
+licenses that it may have granted prior to termination of the Agreement
+shall remain valid subject to their having been granted in compliance
+with the terms and conditions hereof.
+
+
+    Article 11 - MISCELLANEOUS
+
+
+      11.1 EXCUSABLE EVENTS
+
+Neither Party shall be liable for any or all delay, or failure to
+perform the Agreement, that may be attributable to an event of force
+majeure, an act of God or an outside cause, such as defective
+functioning or interruptions of the electricity or telecommunications
+networks, network paralysis following a virus attack, intervention by
+government authorities, natural disasters, water damage, earthquakes,
+fire, explosions, strikes and labor unrest, war, etc.
+
+11.2 Any failure by either Party, on one or more occasions, to invoke
+one or more of the provisions hereof, shall under no circumstances be
+interpreted as being a waiver by the interested Party of its right to
+invoke said provision(s) subsequently.
+
+11.3 The Agreement cancels and replaces any or all previous agreements,
+whether written or oral, between the Parties and having the same
+purpose, and constitutes the entirety of the agreement between said
+Parties concerning said purpose. No supplement or modification to the
+terms and conditions hereof shall be effective as between the Parties
+unless it is made in writing and signed by their duly authorized
+representatives.
+
+11.4 In the event that one or more of the provisions hereof were to
+conflict with a current or future applicable act or legislative text,
+said act or legislative text shall prevail, and the Parties shall make
+the necessary amendments so as to comply with said act or legislative
+text. All other provisions shall remain effective. Similarly, invalidity
+of a provision of the Agreement, for any reason whatsoever, shall not
+cause the Agreement as a whole to be invalid.
+
+
+      11.5 LANGUAGE
+
+The Agreement is drafted in both French and English and both versions
+are deemed authentic.
+
+
+    Article 12 - NEW VERSIONS OF THE AGREEMENT
+
+12.1 Any person is authorized to duplicate and distribute copies of this
+Agreement.
+
+12.2 So as to ensure coherence, the wording of this Agreement is
+protected and may only be modified by the authors of the License, who
+reserve the right to periodically publish updates or new versions of the
+Agreement, each with a separate number. These subsequent versions may
+address new issues encountered by Free Software.
+
+12.3 Any Software distributed under a given version of the Agreement may
+only be subsequently distributed under the same version of the Agreement
+or a subsequent version, subject to the provisions of Article 5.3.4
+<#compatibility>.
+
+
+    Article 13 - GOVERNING LAW AND JURISDICTION
+
+13.1 The Agreement is governed by French law. The Parties agree to
+endeavor to seek an amicable solution to any disagreements or disputes
+that may arise during the performance of the Agreement.
+
+13.2 Failing an amicable solution within two (2) months as from their
+occurrence, and unless emergency proceedings are necessary, the
+disagreements or disputes shall be referred to the Paris Courts having
+jurisdiction, by the more diligent Party.

MANIFEST.in

@@ -1,11 +1,12 @@
 include setup.py
-recursive-include distutils.ext *.py *.c *.pem
-recursive-include python *.pyx *.pxd *.c *.h *.cfiles
+recursive-include python *.pyx *.pxd *.c *.h
 recursive-include src *.c *.h
+include src/CMakeLists.txt
 recursive-include doc/sphinx/source *.txt *.rst *.py
 recursive-include doc/sphinx/sphinxext *.py
 include doc/sphinx/Makefile
 include doc/sphinx/Doxyfile
 include README.txt
 include requirements.txt
+include scripts/obi
 

README.md

@@ -0,0 +1,41 @@
+The `OBITools3`: A package for the management of analyses and data in DNA metabarcoding   
+---------------------------------------------
+
+**Website: <https://metabarcoding.org/obitools3>**
+
+DNA metabarcoding offers new perspectives for biodiversity research [1]. This approach of ecosystem studies relies heavily on the use of Next-Generation Sequencing (NGS), and consequently requires the ability to to treat large volumes of data. The `OBITools` package  satisfies this requirement thanks to a set of programs specifically designed for analyzing NGS data in a DNA metabarcoding context [2] - <https://metabarcoding.org/obitools>. Their capacity to filter and edit sequences while taking into account taxonomic annotation helps to setup tailored-made analysis pipelines for a broad range of DNA metabarcoding applications, including biodiversity surveys or diet analyses.   
+
+
+
+**The `OBITools3`.** This new version of the `OBITools` looks to significantly improve the storage efficiency and the data processing speed. To this end, the `OBITools3` rely on an ad hoc database system, inside which all the data that a DNA metabarcoding experiment must consider is stored: the sequences, the metadata (describing for instance the samples), the database containing the reference sequences used for the taxonomic annotation, as well as the taxonomic databases. Besides the gain in efficiency, this new structure allows an easier access to all the data associated with an experiment.   
+
+
+
+**Column-oriented storage.** An analysis pipeline corresponds to a succession of commands, each computing one step of the analysis, and where the result of the command *n* is used by the command *n+1*. DNA metabarcoding data can easily be represented in the form of tables, and each command can be regarded as an operation transforming one or several 'input' tables into one or several 'output' tables, which can be used by the next command. Many of the basic operations in a pipeline copy without modification an important part of the input tables to the result tables, and use for their calculations only a small part of the input data. In the original `OBITools`, those tables are kept in the form of annotated sequence files in the FASTA or FASTQ format. This has two consequences: i) keeping the transitional results of the analysis pipeline means using disk space for an important volume of redundant data, ii) The coding and decoding of informations that are not actually used represent an important part of the treatment process. The new database system used by the `OBITools3` (called DMS for Data Management System) relies on column-oriented storage. The columns are immutable and can be assembled in views representing the data tables. This way, the data not modified by a command in an input table can easily be associated to the result table without duplicating any information ; and the data not used at all by a command can be associated with the result table without being read. This strategy results in a gain in disk space efficiency by limiting data redundancy, as well as a gain in execution time by limiting data reading, writing and conversion operations. Finally, as a mean to optimize data access, each column is stored in a binary file directly mapped in memory for reading and writing operations.   
+
+
+
+**Storage optimization.** DNA metabarcoding data is intrinsically very redundant. For example, the same sequence corresponding to a species will be present several thousand times across all samples. In order to limit the disk space used and make comparison operations more efficient, data in the form of character strings is stored in columns using a complex indexing structure, efficient on millions of values, coupling hash functions, Bloom filters and AVL trees. Finally, DNA sequences are compressed by encoding each nucleotide on two or four bits depending on whether the sequences contain only the four nucleotides (A, C, G, T) or use the IUPAC codes.   
+
+
+
+**Saving the data processing history.** The totality of the informations used by the `OBITools3` is stored in immutable data structures in the DMS. If a command has to modify a column used as input to produce its result, a new version of that column is created, leaving the initial version intact. This storage system enables to keep, at minimal cost, the totality of the transitional results produced by the pipeline. The storage of metadata describing all the operations that have produced a view (a result table) in the DMS makes possible the creation of an oriented hypergraph, where each node corresponds to a view and each arrow to an operation. By retracing the dependency relationships in this hypergraph, it is possible to rebuild *a posteriori* the entirety of the process that has produced a result table.   
+
+
+
+**Tools.** The `OBITools3` offer the same tools as the original `OBITools`, plus `ecoPCR` (*in silico* PCR) [4] and `Sumatra` (sequence alignment, not multithreaded yet) [5]. 
+Eventually, new versions of `ecoPrimers` (PCR primer design) [3], as well as `Sumaclust` (sequence alignment and clustering) [5] will be added, taking advantage of the database structure developed for the `OBITools3`.    
+
+
+
+**Implementation and disponibility.** The lower layers managing the DMS as well as all the compute-intensive functions are coded in `C99` for efficiency reasons. A `Cython` (<http://www.cython.org>) object layer allows for a simple but efficient implementation of the `OBITools3` commands in `Python 3`. The `OBITools3` are now being released, check the wiki for more information.
+
+
+
+**References.**
+
+1. Taberlet P, Coissac E, Hajibabaei M, Rieseberg LH: Environmental DNA. Mol Ecol 2012:1789–1793.
+2. Boyer F, Mercier C, Bonin A, Le Bras Y, Taberlet P, Coissac E: OBITools: a Unix-inspired software package for DNA metabarcoding. Mol Ecol Resour, 2016: 176-182.
+3. Riaz T, Shehzad W, Viari A, Pompanon F, Taberlet P, Coissac E: ecoPrimers: inference of new DNA barcode markers from whole genome sequence analysis. Nucleic Acids Res 2011, 39:e145.
+4. Ficetola GF, Coissac E, Zundel S, Riaz T, Shehzad W, Bessière J, Taberlet P, Pompanon F: An in silico approach for the evaluation of DNA barcodes. BMC Genomics 2010, 11:434.
+5. Mercier C, Boyer F, Bonin A, Coissac E (2013) SUMATRA and SUMACLUST: fast and exact comparison and clustering of sequences. Available: <http://metabarcoding.org/sumatra> and <http://metabarcoding.org/sumaclust>

c-sandbox/obicount/Makefile

@@ -1,18 +0,0 @@
-CC = gcc
-CFLAGS = -c -Wall
-LDFLAGS = 
-SOURCES = obicount.c ../obidmscolumn.c
-OBJECTS = $(SOURCES:.c=.o)
-EXECUTABLE = obicount
-
-all: $(SOURCES) $(EXECUTABLE)
-    
-$(EXECUTABLE): $(OBJECTS) 
-	$(CC) $(LDFLAGS) $(OBJECTS) -o $@
-
-.c.o:
-	$(CC) $(CFLAGS) $< -o $@
-
-clean:
-	rm *o
-	rm $(EXECUTABLE)

c-sandbox/obicount/obicount.c

@@ -1,87 +0,0 @@
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <sys/mman.h>	/* mmap() is defined in this header */
-#include <stdint.h>
-#include <fcntl.h>
-#include <sys/stat.h>
-
-#include "../obitypes.h"
-#include "../obidmscolumn.h"
-
-
-/**
- * @brief Computes the size to map.
- *
- * * @param OBIDMSColumn_file The file to map.
- * @return The size to map.
- */
-int get_size_to_map(int OBIDMSColumn_file)
-// compute size to map : file size minus size of the header
-{
-	int size;
-	struct stat s;
-
-	fstat(OBIDMSColumn_file, &s);
-	size = (s.st_size) - HEADER_SIZE;
-	return(size);
-}
-
-/**
- * @brief Computes and prints the total number of sequences by summing their counts.
- *
- * * @param The count file.
- */
-int main(int argc, char const *argv[])
-{
-	char* map;
-	int size;
-	int OBIDMSColumn_file;
-	int count;
-	char c;
-	char num_str[10] = "";
-	int num_int;
-	int i,j;
-
-	// initialize variables
-	OBIDMSColumn_file = open(argv[1], O_RDONLY);	//read only
-	count = 0;
-	j = 0;
-
-	// compute size to map
-	size = get_size_to_map(OBIDMSColumn_file);
-
-	// map the data
-	map = obi_map_read_only(OBIDMSColumn_file, HEADER_SIZE, size);
-
-	// sum the counts
-	for (i=0; i<size; i++)
-	{
-		c = map[i];
-
-		if (c != SEPARATOR)		// reading lines
-		{
-			num_str[j] = c;
-			j++;
-		}
-
-		else if (c == SEPARATOR)	// end of a line
-		{
-			num_int = atoi(num_str);	// turn number from character string to int
-			count = count + num_int;	// add the number to the sum
-			j = 0;
-			num_str[j] = '\0';
-		}
-	}
-
-	// print the final count of sequences
-	fprintf(stderr, "Sequence count = %d\n", count);
-
-	// unmap
-	obi_unmap(size);
-
-	// close file
-	close(OBIDMSColumn_file);
-
-	return(0);
-}

distutils.ext/obidistutils/command/build.py

@@ -1,38 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-from distutils.command.build import build as ori_build
-from obidistutils.serenity.checksystem import is_mac_system
-
-
-class build(ori_build):
-    
-    def has_ext_modules(self):
-        return self.distribution.has_ext_modules()
-    
-    def has_pidname(self):
-        return is_mac_system()
-
-    def has_doc(self):
-        return True
-    
-    def has_littlebigman(self):
-        return True
-    
-    try:
-        from obidistutils.command.build_sphinx import build_sphinx  # @UnusedImport
-
-        sub_commands = [("littlebigman",has_littlebigman),
-                         ('pidname',has_pidname)
-                       ] \
-                       + ori_build.sub_commands + \
-                       [('build_sphinx',has_doc)]
-    except ImportError:
-        sub_commands = [("littlebigman",has_littlebigman),
-                         ('pidname',has_pidname)
-                       ] \
-                       + ori_build.sub_commands
-        

distutils.ext/obidistutils/command/build_cexe.py

@@ -1,85 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-from .build_ctools import build_ctools
-from .build_exe import build_exe
-from distutils.errors import DistutilsSetupError
-from distutils import log
-import os
-
-class build_cexe(build_ctools):
-
-    description = "build C/C++ executable distributed with Python extensions"
-
-
-    def initialize_options(self):
-        build_ctools.initialize_options(self)
-        self.built_files = None
-
-
-    def finalize_options(self):
-        # This might be confusing: both build-cexe and build-temp default
-        # to build-temp as defined by the "build" command.  This is because
-        # I think that C libraries are really just temporary build
-        # by-products, at least from the point of view of building Python
-        # extensions -- but I want to keep my options open.
-
-        build_cexe_dir = self.build_cexe
-        build_ctools.finalize_options(self)
-
-        if build_cexe_dir is None:
-            self.build_cexe=None
-            
-        self.set_undefined_options('build',
-                                   ('build_scripts',  'build_cexe'))
-
-        self.set_undefined_options('build_files',
-                                   ('files',  'built_files'))
-                   
-        self.executables   = self.distribution.executables
-#         self.build_cexe = os.path.join(os.path.dirname(self.build_cexe),'cbinaries') 
-#         self.mkpath(self.build_cexe)
-
-        if self.executables:
-            self.check_executable_list(self.executables)
-                            
-
-        # XXX same as for build_ext -- what about 'self.define' and
-        # 'self.undef' ?
-
-    def substitute_sources(self,exe_name,sources):
-        """
-        Substitutes source file name starting by an @ by the actual
-        name of the built file (see --> build_files)
-        """
-        sources = list(sources)
-        for i in range(len(sources)):
-            message = "%s :-> %s" % (exe_name,sources[i])
-            if sources[i][0]=='@':
-                try:
-                    filename = self.built_files[sources[i][1:]]
-                except KeyError:
-                    raise DistutilsSetupError(
-                         'The %s filename declared in the source '
-                         'files of the program %s have not been '
-                         'built by the installation process' % (sources[i],
-                                                                exe_name))
-                sources[i]=filename
-                log.info("%s changed to %s",message,filename)
-            else:
-                log.info("%s ok",message)
-
-        return sources
- 
-    def run(self):
-
-        for cmd_name in self.get_sub_commands():
-            self.run_command(cmd_name)
-
-        build_exe.run(self)
-        
-
-   

distutils.ext/obidistutils/command/build_ctools.py

@@ -1,63 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-
-from .build_exe import build_exe
-from distutils import log
-
-class build_ctools(build_exe):
-    description = "build C/C++ executable not distributed with Python extensions"
-
-    def initialize_options(self):
-        build_exe.initialize_options(self)
-        
-        # List of built tools
-        self.ctools = None
-        self.littlebigman = None
-
-
-    def finalize_options(self):
-        # This might be confusing: both build-cexe and build-temp default
-        # to build-temp as defined by the "build" command.  This is because
-        # I think that C libraries are really just temporary build
-        # by-products, at least from the point of view of building Python
-        # extensions -- but I want to keep my options open.
-            
-        build_exe.finalize_options(self)
-        
-        
-        self.set_undefined_options('build',
-                                    ('build_temp', 'build_cexe'))
-
-        self.set_undefined_options('littlebigman',
-                                   ('littlebigman',  'littlebigman'))
-                   
-        self.executables = self.distribution.ctools
-        self.check_executable_list(self.executables)
-        
-
-        if self.littlebigman =='-DLITTLE_END':
-            if self.define is None:
-                self.define=[('LITTLE_END',None)]
-            else:
-                self.define.append('LITTLE_END',None)
-                
-        log.info('Look for CPU architecture... %s',self.define)
-
-        self.ctools = set()
-
-    def run(self):
-
-        for cmd_name in self.get_sub_commands():
-            self.run_command(cmd_name)
-
-        
-        build_exe.run(self)
-        
-        for e,p in self.executables:                                  # @UnusedVariable
-            self.ctools.add(e)
-            
-

distutils.ext/obidistutils/command/build_exe.py

@@ -1,211 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-import os
-
-from distutils.core import Command
-from distutils.sysconfig import customize_compiler
-from distutils.errors import DistutilsSetupError
-from distutils import log
-from distutils.ccompiler import show_compilers
-
-class build_exe(Command):
-    
-    description = "build an executable -- Abstract command "
-
-    user_options = [
-        ('build-cexe', 'x',
-         "directory to build C/C++ libraries to"),
-        ('build-temp', 't',
-         "directory to put temporary build by-products"),
-        ('debug', 'g',
-         "compile with debugging information"),
-        ('force', 'f',
-         "forcibly build everything (ignore file timestamps)"),
-        ('compiler=', 'c',
-         "specify the compiler type"),
-        ]
-
-    boolean_options = ['debug', 'force']
-
-    help_options = [
-        ('help-compiler', None,
-         "list available compilers", show_compilers),
-        ]
-
-    def initialize_options(self):
-        self.build_cexe = None
-        self.build_temp = None
-
-        # List of executables to build
-        self.executables = None
-
-        # Compilation options for all libraries
-        self.include_dirs = None
-        self.define = None
-        self.undef = None
-        self.extra_compile_args = None
-        self.debug = None
-        self.force = 0
-        self.compiler = None
-        self.sse = None
-        self.built_files=None
-
-    def finalize_options(self):
-        # This might be confusing: both build-cexe and build-temp default
-        # to build-temp as defined by the "build" command.  This is because
-        # I think that C libraries are really just temporary build
-        # by-products, at least from the point of view of building Python
-        # extensions -- but I want to keep my options open.
-        self.set_undefined_options('build',
-                                   ('build_temp', 'build_temp'),
-                                   ('compiler', 'compiler'),
-                                   ('debug', 'debug'),
-                                   ('force', 'force'))
-
-        if self.include_dirs is None:
-            self.include_dirs = self.distribution.include_dirs or []
-            
-        if isinstance(self.include_dirs, str):
-            self.include_dirs = self.include_dirs.split(os.pathsep)
-
-        self.sse = self.distribution.sse
-        
-        if self.sse is not None:
-            if self.extra_compile_args is None:
-                self.extra_compile_args=['-m%s' % self.sse]
-            else:
-                self.extra_compile_args.append('-m%s' % self.sse)
-
-        # XXX same as for build_ext -- what about 'self.define' and
-        # 'self.undef' ?
-
-    def run(self):
-
-        if not self.executables:
-            return
-
-        self.mkpath(self.build_cexe)
-
-        # Yech -- this is cut 'n pasted from build_ext.py!
-        from distutils.ccompiler import new_compiler
-        self.compiler = new_compiler(compiler=self.compiler,
-                                     dry_run=self.dry_run,
-                                     force=self.force)
-        customize_compiler(self.compiler)
-
-        if self.include_dirs is not None:
-            self.compiler.set_include_dirs(self.include_dirs)
-        if self.define is not None:
-            # 'define' option is a list of (name,value) tuples
-            for (name,value) in self.define:
-                self.compiler.define_macro(name, value)
-
-        if self.undef is not None:
-            for macro in self.undef:
-                self.compiler.undefine_macro(macro)
-                
-        self.build_executables(self.executables)
-
-
-    def check_executable_list(self, executables):
-        """Ensure that the list of executables is valid.
-
-        `executable` is presumably provided as a command option 'executables'.
-        This method checks that it is a list of 2-tuples, where the tuples
-        are (executable_name, build_info_dict).
-
-        Raise DistutilsSetupError if the structure is invalid anywhere;
-        just returns otherwise.
-        """
-        if not isinstance(executables, list):
-            raise DistutilsSetupError("'executables' option must be a list of tuples")
-
-        for exe in executables:
-            if not isinstance(exe, tuple) and len(exe) != 2:
-                raise DistutilsSetupError("each element of 'executables' must a 2-tuple")
-
-            name, build_info = exe
-
-            if not isinstance(name, str):
-                raise DistutilsSetupError(
-                      "first element of each tuple in 'executables' " 
-                      "must be a string (the executables name)")
-                
-            if '/' in name or (os.sep != '/' and os.sep in name):
-                raise DistutilsSetupError(
-                       "bad executable name '%s': " 
-                       "may not contain directory separators" % exe[0])
-
-            if not isinstance(build_info, dict):
-                raise DistutilsSetupError(
-                      "second element of each tuple in 'executables' " 
-                      "must be a dictionary (build info)")
-
-    def get_executable_names(self):
-        # Assume the executables list is valid -- 'check_executable_list()' is
-        # called from 'finalize_options()', so it should be!
-        if not self.executables:
-            return None
-
-        exe_names = []
-        for (exe_name, build_info) in self.executables:                     # @UnusedVariable
-            exe_names.append(exe_name)
-        return exe_names
-
-
-    def get_source_files(self):
-        self.check_executable_list(self.executables)
-        filenames = []
-        for (exe_name, build_info) in self.executables:                     # @UnusedVariable
-            sources = build_info.get('sources')
-            if sources is None or not isinstance(sources, (list, tuple)):
-                raise DistutilsSetupError(
-                       "in 'executables' option (library '%s'), "
-                       "'sources' must be present and must be "
-                       "a list of source filenames" % exe_name)
-
-            filenames.extend(sources)
-        return filenames
-    
-    def substitute_sources(self,exe_name,sources):
-        return list(sources)
-
-    def build_executables(self, executables):
-        for (exe_name, build_info) in executables:
-            sources = build_info.get('sources')
-            if sources is None or not isinstance(sources, (list, tuple)):
-                raise DistutilsSetupError(
-                       "in 'executables' option (library '%s'), " 
-                       "'sources' must be present and must be " 
-                       "a list of source filenames" % exe_name)
-                
-            sources = self.substitute_sources(exe_name,sources)
-
-            log.info("building '%s' program", exe_name)
-
-            # First, compile the source code to object files in the library
-            # directory.  (This should probably change to putting object
-            # files in a temporary build directory.)
-            macros = build_info.get('macros')
-            include_dirs = build_info.get('include_dirs')
-            extra_args = self.extra_compile_args or []
-            
-            objects = self.compiler.compile(sources,
-                                            output_dir=self.build_temp,
-                                            macros=macros,
-                                            include_dirs=include_dirs,
-                                            extra_postargs=extra_args,
-                                            debug=self.debug)
-
-            # Now "link" the object files together into a static library.
-            # (On Unix at least, this isn't really linking -- it just
-            # builds an archive.  Whatever.)
-            self.compiler.link_executable(objects, exe_name,
-                                            output_dir=self.build_cexe,
-                                            debug=self.debug)
-
-        

distutils.ext/obidistutils/command/build_ext.py

@@ -1,113 +0,0 @@
-'''
-Created on 13 fevr. 2014
-
-@author: coissac
-'''
-
-from distutils import log
-import os
-
-from Cython.Distutils import build_ext  as ori_build_ext  # @UnresolvedImport
-
-from Cython.Compiler import Options as cython_options  # @UnresolvedImport
-
-from distutils.errors import DistutilsSetupError
-
-class build_ext(ori_build_ext):
-
-    
-    def modifyDocScripts(self):
-        build_dir_file=open("doc/sphinx/build_dir.txt","w")
-        print(self.build_lib,file=build_dir_file)
-        build_dir_file.close()
-        
-    def initialize_options(self):
-        ori_build_ext.initialize_options(self)  # @UndefinedVariable
-        self.littlebigman = None
-        self.built_files = None
-
-    
-    def finalize_options(self):
-        ori_build_ext.finalize_options(self)  # @UndefinedVariable
-
-        self.set_undefined_options('littlebigman',
-                                   ('littlebigman',  'littlebigman'))
-        
-        self.set_undefined_options('build_files',
-                                   ('files',  'built_files'))
-
-        self.cython_c_in_temp = 1
-                   
-        if self.littlebigman =='-DLITTLE_END':
-            if self.define is None:
-                self.define=[('LITTLE_END',None)]
-            else:
-                self.define.append('LITTLE_END',None)
-        
-    def substitute_sources(self,exe_name,sources):
-        """
-        Substitutes source file name starting by an @ by the actual
-        name of the built file (see --> build_files)
-        """
-        sources = list(sources)
-        for i in range(len(sources)):
-            message = "%s :-> %s" % (exe_name,sources[i])
-            if sources[i][0]=='@':
-                try:
-                    filename = self.built_files[sources[i][1:]]
-                except KeyError:
-                    tmpfilename = os.path.join(self.build_temp,sources[i][1:])
-                    if os.path.isfile       (tmpfilename):
-                        filename = tmpfilename
-                    else:
-                        raise DistutilsSetupError(
-                             'The %s filename declared in the source '
-                             'files of the program %s have not been '
-                             'built by the installation process' % (sources[i],
-                                                                     exe_name))
-                sources[i]=filename
-                log.info("%s changed to %s",message,filename)
-            else:
-                log.info("%s ok",message)
-
-        return sources
-
-    def build_extensions(self):
-        # First, sanity-check the 'extensions' list
-        
-        for ext in self.extensions:
-            ext.sources = self.substitute_sources(ext.name,ext.sources)
-            
-        self.check_extensions_list(self.extensions)
-
-        for ext in self.extensions:
-            log.info("%s :-> %s",ext.name,ext.sources)
-            ext.sources = self.cython_sources(ext.sources, ext)
-            self.build_extension(ext)
-
-        
-    def run(self):
-        self.modifyDocScripts()
-
-        for cmd_name in self.get_sub_commands():
-            self.run_command(cmd_name)
-
-        cython_options.annotate = True
-        ori_build_ext.run(self)  # @UndefinedVariable
-        
-
-    def has_files(self):
-        return self.distribution.has_files()
-
-    def has_executables(self):
-        return self.distribution.has_executables()
-    
-    sub_commands = [('build_files',has_files),
-                    ('build_cexe', has_executables)
-                    ] + \
-                   ori_build_ext.sub_commands
-
-        
-
-
-        

distutils.ext/obidistutils/command/build_files.py

@@ -1,63 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-import os.path
-
-from distutils.core import Command
-from distutils import log
-
-class build_files(Command):
-            
-    def initialize_options(self):
-        self.files=None
-        self.ctools=None
-        self.build_temp=None
-        self.build_cexe=None
-
-    def finalize_options(self):
-        
-        self.set_undefined_options('build_ctools',
-                                   ('ctools',  'ctools'),
-                                   ('build_temp','build_temp'),
-                                   ('build_cexe','build_cexe'),
-                                   )
-        
-        self.files = {}
-        
-    def run(self):
-
-        for cmd_name in self.get_sub_commands():
-            self.run_command(cmd_name)
-
-        
-        for dest,prog,command in self.distribution.files:
-            destfile = os.path.join(self.build_temp,dest)
-            if prog in self.ctools:
-                progfile = os.path.join(self.build_cexe,prog)
-            else:
-                progfile = prog 
-                
-            log.info("Building file : %s" % dest)
-            
-            commandline = command % {'prog' : progfile,
-                                     'dest' : destfile}
-
-            log.info("    --> %s" % commandline)
-            
-            os.system(commandline)
-            self.files[dest]=destfile
-            
-            log.info("Done.\n")
-            
-    def has_ctools(self):
-        return self.distribution.has_ctools()
-
-
-    sub_commands = [('build_ctools', has_ctools)] + \
-                   Command.sub_commands
-            
-            
-        

distutils.ext/obidistutils/command/build_scripts.py

@@ -1,104 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-import os.path
-
-from distutils.command.build_scripts import build_scripts as ori_build_scripts
-from distutils.util import convert_path
-from distutils import log, sysconfig
-from distutils.dep_util import newer
-from stat import ST_MODE
-import re
-
-first_line_re = re.compile('^#!.*python[0-9.]*([ \t].*)?$')
-
-class build_scripts(ori_build_scripts):
-            
-    def copy_scripts (self):
-        """Copy each script listed in 'self.scripts'; if it's marked as a
-        Python script in the Unix way (first line matches 'first_line_re',
-        ie. starts with "\#!" and contains "python"), then adjust the first
-        line to refer to the current Python interpreter as we copy.
-        """        
-        self.mkpath(self.build_dir)
-        rawbuild_dir = os.path.join(os.path.dirname(self.build_dir),'raw_scripts')
-        self.mkpath(rawbuild_dir)
-        
-        outfiles = []
-        for script in self.scripts:
-            adjust = 0
-            script = convert_path(script)
-            outfile = os.path.join(self.build_dir, os.path.splitext(os.path.basename(script))[0])
-            rawoutfile = os.path.join(rawbuild_dir, os.path.basename(script))
-            outfiles.append(outfile)
-
-            if not self.force and not newer(script, outfile):
-                log.debug("not copying %s (up-to-date)", script)
-                continue
-
-            # Always open the file but ignore failures in dry-run mode --
-            # that way, we'll get accurate feedback if we can read the
-            # script.
-            try:
-                f = open(script, "r")
-            except IOError:
-                if not self.dry_run:
-                    raise
-                f = None
-            else:
-                first_line = f.readline()
-                if not first_line:
-                    self.warn("%s is an empty file (skipping)" % script)
-                    continue
-
-                match = first_line_re.match(first_line)
-                if match:
-                    adjust = 1
-                    post_interp = match.group(1) or ''
-            
-            log.info("Store the raw script %s -> %s", script,rawoutfile)        
-            self.copy_file(script, rawoutfile)
-
-
-            if adjust:
-                log.info("copying and adjusting %s -> %s", script,
-                         self.build_dir)
-                if not self.dry_run:
-                    outf = open(outfile, "w")
-                    if not sysconfig.python_build:
-                        outf.write("#!%s%s\n" %
-                                   (self.executable,
-                                    post_interp))
-                    else:
-                        outf.write("#!%s%s\n" %
-                                   (os.path.join(
-                            sysconfig.get_config_var("BINDIR"),
-                           "python%s%s" % (sysconfig.get_config_var("VERSION"),
-                                           sysconfig.get_config_var("EXE"))),
-                                    post_interp))
-                    outf.writelines(f.readlines())
-                    outf.close()
-                if f:
-                    f.close()
-            else:
-                if f:
-                    f.close()
-                self.copy_file(script, outfile)
-
-        if os.name == 'posix':
-            for F in outfiles:
-                if self.dry_run:
-                    log.info("changing mode of %s", F)
-                else:
-                    oldmode = os.stat(F)[ST_MODE]
-                    oldmode = oldmode & 0o7777
-                    
-                    newmode = (oldmode | 0o555) & 0o7777
-                    if newmode != oldmode:
-                        log.info("changing mode of %s from %o to %o",
-                                 F, oldmode, newmode)
-                        os.chmod(F, newmode)
-

distutils.ext/obidistutils/command/build_sphinx.py

@@ -1,27 +0,0 @@
-'''
-Created on 10 mars 2015
-
-@author: coissac
-'''
-
-try:
-    from sphinx.setup_command import BuildDoc as ori_build_sphinx  # @UnresolvedImport
-        
-    class build_sphinx(ori_build_sphinx):
-        '''Build Sphinx documentation in html, epub and man formats 
-        '''
-    
-        description = __doc__
-    
-        def run(self):
-            self.builder='html'
-            self.finalize_options()
-            ori_build_sphinx.run(self)
-            self.builder='epub'
-            self.finalize_options()
-            ori_build_sphinx.run(self)
-            self.builder='man'
-            self.finalize_options()
-            ori_build_sphinx.run(self)
-except ImportError:
-    pass  

distutils.ext/obidistutils/command/install.py

@@ -1,19 +0,0 @@
-'''
-Created on 6 oct. 2014
-
-@author: coissac
-'''
-
-# try:
-#     from setuptools.command.install import install as install_ori
-# except ImportError:
-#     from distutils.command.install import install as install_ori
-
-from distutils.command.install import install as install_ori
-
-class install(install_ori):
-    
-    def __init__(self,dist):
-        install_ori.__init__(self, dist)
-#        self.sub_commands.insert(0, ('build',lambda self: True))
-        self.sub_commands.append(('install_sphinx',lambda self: self.distribution.serenity))

distutils.ext/obidistutils/command/install_scripts.py

@@ -1,47 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-# try:
-#     from setuptools.command.install_scripts import install_scripts as ori_install_scripts
-# except ImportError:
-#     from distutils.command.install_scripts import install_scripts as ori_install_scripts
-
-from distutils.command.install_scripts import install_scripts as ori_install_scripts
-
-import os.path
-from distutils import log
-
-class install_scripts(ori_install_scripts):
-
-    def initialize_options(self):
-        ori_install_scripts.initialize_options(self)
-        self.public_dir = None
-                        
-                    
-    def install_public_link(self):
-        self.mkpath(self.public_dir)
-        for file in self.get_outputs():
-            log.info("exporting file %s -> %s", file,os.path.join(self.public_dir,
-                                    os.path.split(file)[1]
-                                    ))
-            if not self.dry_run:
-                dest = os.path.join(self.public_dir,
-                                    os.path.split(file)[1]
-                                   )
-                if os.path.exists(dest):
-                    os.unlink(dest)
-                os.symlink(file,dest)
-                    
-
-
-    def run(self):
-        ori_install_scripts.run(self)
-        if self.distribution.serenity:
-            self.public_dir=os.path.join(self.install_dir,"../export/bin")
-            self.public_dir=os.path.abspath(self.public_dir)
-            self.install_public_link()
-
-

distutils.ext/obidistutils/command/install_sphinx.py

@@ -1,61 +0,0 @@
-'''
-Created on 10 mars 2015
-
-@author: coissac
-'''
-from distutils.core import Command
-import os.path
-import glob
-
-class install_sphinx(Command):
-    '''
-    Install the sphinx documentation
-    '''
-    
-    description = "Install the sphinx documentation in serenity mode"
-
-    boolean_options = ['force', 'skip-build']
-
-
-    def initialize_options (self):
-        self.install_doc = None
-        self.build_dir = None
-
-    def finalize_options (self):
-        self.set_undefined_options('build_sphinx', ('build_dir', 'build_dir'))
-        self.set_undefined_options('install',
-                                   ('install_scripts', 'install_doc'))
-
-    def run (self):
-        if self.distribution.serenity:
-            self.install_doc = os.path.join(self.install_doc,"../export/share")
-            self.install_doc=os.path.abspath(self.install_doc)
-            self.mkpath(self.install_doc)
-            self.mkpath(os.path.join(self.install_doc,'html'))
-            outfiles = self.copy_tree(os.path.join(self.build_dir,'html'),  # @UnusedVariable
-                                      os.path.join(self.install_doc,'html'))
-                
-            self.mkpath(os.path.join(self.install_doc,'man','man1'))
-            outfiles = self.copy_tree(os.path.join(self.build_dir,'man'),  # @UnusedVariable
-                                      os.path.join(self.install_doc,'man','man1'))
-
-            for epub in glob.glob(os.path.join(self.build_dir,'epub/*.epub')):
-                self.copy_file(os.path.join(epub), 
-                               os.path.join(self.install_doc,os.path.split(epub)[1]))
-            
-    def get_outputs(self):
-        directory=os.path.join(self.install_doc,'html')
-        files = [os.path.join(self.install_doc,'html', f) 
-                 for dp, dn, filenames in os.walk(directory) for f in filenames]  # @UnusedVariable
-        
-        directory=os.path.join(self.build_dir,'man')
-        files.append(os.path.join(self.install_doc,'man','man1', f) 
-                 for dp, dn, filenames in os.walk(directory) for f in filenames)  # @UnusedVariable
-
-        directory=os.path.join(self.build_dir,'epub')
-        files.append(os.path.join(self.install_doc, f) 
-                 for dp, dn, filenames in os.walk(directory)  # @UnusedVariable
-                 for f in glob.glob(os.path.join(dp, '*.epub')) )
-        
-        return files
-        

distutils.ext/obidistutils/command/littlebigman.py

@@ -1,59 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-import os
-
-from obidistutils.command.build_exe import build_exe
-from distutils import log
-
-import subprocess
-
-class littlebigman(build_exe):
-    
-    description = "build the littlebigman executable testing endianness of the CPU"
-
-
-    def initialize_options(self):
-        build_exe.initialize_options(self)
-
-        self.littlebigman = None
-
-
-    def finalize_options(self):
-        # This might be confusing: both build-cexe and build-temp default
-        # to build-temp as defined by the "build" command.  This is because
-        # I think that C libraries are really just temporary build
-        # by-products, at least from the point of view of building Python
-        # extensions -- but I want to keep my options open.
-        
-        build_exe.finalize_options(self)
-        
-        self.set_undefined_options('build',
-                                   ('build_temp', 'build_cexe'))
-
-        # self.ctools = self.distribution.ctools
-        
-        if os.path.isfile("distutils.ext/src/littlebigman.c"):
-            self.executables = [('littlebigman',{"sources":["distutils.ext/src/littlebigman.c"]})]
-            self.check_executable_list(self.executables)
-        else:
-            self.executables = []
-
-
-    def run_littlebigman(self):
-        p = subprocess.Popen("'%s'" % os.path.join(self.build_temp,
-                                                   'littlebigman'), 
-                             shell=True, 
-                             stdout=subprocess.PIPE)
-        little = p.communicate()[0]
-        return little.decode('latin1')
-
-    def run(self):
-        build_exe.run(self)
-        self.littlebigman=self.run_littlebigman()
-        log.info("Your CPU is in mode : %s" % self.littlebigman)
-        
-        

distutils.ext/obidistutils/command/pidname.py

@@ -1,55 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-import os
-
-from obidistutils.command.build_exe import build_exe
-from obidistutils.serenity.checksystem import is_mac_system
-
-
-class pidname(build_exe):
-    
-    description = "build the pidname executable returning the executable path from a PID on a mac"
-
-
-    def initialize_options(self):
-        build_exe.initialize_options(self)
-
-        self.pidname = False
-
-
-    def finalize_options(self):
-        # This might be confusing: both build-cexe and build-temp default
-        # to build-temp as defined by the "build" command.  This is because
-        # I think that C libraries are really just temporary build
-        # by-products, at least from the point of view of building Python
-        # extensions -- but I want to keep my options open.
-        
-        build_exe.finalize_options(self)
-        
-        self.set_undefined_options('build',
-                                   ('build_scripts', 'build_cexe'))
-
-        # self.ctools = self.distribution.ctools
-        
-        if os.path.isfile("distutils.ext/src/pidname.c"):
-            self.executables = [('pidname',{"sources":["distutils.ext/src/pidname.c"]})]
-            self.check_executable_list(self.executables)
-        else:
-            self.executables = []
-
-#         self.build_cexe = os.path.join(os.path.dirname(self.build_cexe),'cbinaries') 
-#         self.mkpath(self.build_cexe)
-
-
-
-    def run(self):
-        if is_mac_system():
-            build_exe.run(self)
-            self.pidname=True
-        else:
-            self.pidname=False
-        

distutils.ext/obidistutils/command/sdist.py

@@ -1,42 +0,0 @@
-'''
-Created on 10 mars 2015
-
-@author: coissac
-'''
-
-import os.path
-
-from distutils.command.sdist import sdist as orig_sdist
-from distutils import dir_util
-
-class sdist(orig_sdist):
-
-    def make_distribution(self):
-        """Create the source distribution(s).  First, we create the release
-        tree with 'make_release_tree()'; then, we create all required
-        archive files (according to 'self.formats') from the release tree.
-        Finally, we clean up by blowing away the release tree (unless
-        'self.keep_temp' is true).  The list of archive files created is
-        stored so it can be retrieved later by 'get_archive_files()'.
-        """
-        # Don't warn about missing meta-data here -- should be (and is!)
-        # done elsewhere.
-        base_dir = self.distribution.get_fullname()
-        base_name = os.path.join(self.dist_dir,base_dir)
-
-        self.make_release_tree(os.path.join('tmp',base_dir), self.filelist.files)
-        archive_files = []              # remember names of files we create
-        # tar archive must be created last to avoid overwrite and remove
-        if 'tar' in self.formats:
-            self.formats.append(self.formats.pop(self.formats.index('tar')))
-
-        for fmt in self.formats:
-            file = self.make_archive(base_name, fmt, root_dir='tmp',base_dir=base_dir,
-                                     owner=self.owner, group=self.group)
-            archive_files.append(file)
-            self.distribution.dist_files.append(('sdist', '', file))
-
-        self.archive_files = archive_files
-
-        if not self.keep_temp:
-            dir_util.remove_tree(os.path.join('tmp',base_dir), dry_run=self.dry_run)

distutils.ext/obidistutils/core.py

@@ -1,226 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-from os import path
-import os.path
-import glob
-import sys
-
-# try:
-#     from setuptools.extension import Extension
-# except ImportError:
-#     from distutils.extension import Extension
-
-from distutils.extension import Extension
-
-from obidistutils.serenity.checkpackage import  install_requirements,\
-                                                check_requirements, \
-                                                RequirementError
-                                                
-from obidistutils.serenity.rerun import enforce_good_python
-from obidistutils.serenity.rerun import rerun_with_anothe_python
-from distutils import log
-
-from obidistutils.dist import Distribution
-from obidistutils.serenity import is_serenity
- 
- 
-def findPackage(root,base=None):
-    modules=[]
-    if base is None:
-        base=[]
-    for module in (path.basename(path.dirname(x)) 
-                   for x in glob.glob(path.join(root,'*','__init__.py'))):
-        modules.append('.'.join(base+[module]))
-        modules.extend(findPackage(path.join(root,module),base+[module]))
-    return modules
-    
-def findCython(root,base=None,pyrexs=None):
-    setupdir = os.path.dirname(sys.argv[0])
-    pyrexs=[]
-
-    if base is None:
-        base=[]
-    for module in (path.basename(path.dirname(x)) 
-                   for x in glob.glob(path.join(root,'*','__init__.py'))):
-                       
-                
-        for pyrex in glob.glob(path.join(root,module,'*.pyx')):
-            pyrexs.append(Extension('.'.join(base+[module,path.splitext(path.basename(pyrex))[0]]),
-                                    [pyrex]
-                                    )
-                          )
-            try:
-                cfiles = os.path.splitext(pyrex)[0]+".cfiles"
-                cfilesdir = os.path.dirname(cfiles)
-                cfiles = open(cfiles)
-                cfiles = [os.path.relpath(os.path.join(cfilesdir,y),setupdir).strip() 
-                          if y[0] !='@' else y.strip()
-                          for y in cfiles]
-                
-                log.info("Cython module : %s",cfiles)   
-                incdir = set(os.path.dirname(x) for x in cfiles if x[-2:]==".h")
-                cfiles = [x for x in cfiles if x[-2:]==".c"]                
-                pyrexs[-1].sources.extend(cfiles)
-                pyrexs[-1].include_dirs.extend(incdir)
-                pyrexs[-1].extra_compile_args.extend(['-msse2',
-                                                      '-Wno-unused-function',
-                                                      '-Wmissing-braces',
-                                                      '-Wchar-subscripts'])
-                
-            except IOError:
-                pass
-            
-        pyrexs.extend(findCython(path.join(root,module),base+[module]))
-    return pyrexs
-    
-
-def rootname(x):
-    return os.path.splitext(x.sources[0])[0]
-
-
-def prepare_commands():
-    from obidistutils.command.build import build
-    from obidistutils.command.littlebigman import littlebigman
-#    from obidistutils.command.serenity import serenity
-    from obidistutils.command.build_cexe import build_cexe
-    from obidistutils.command.build_ext import build_ext
-    from obidistutils.command.build_ctools import build_ctools
-    from obidistutils.command.build_files import build_files
-    from obidistutils.command.build_scripts import build_scripts
-    from obidistutils.command.install_scripts import install_scripts
-    from obidistutils.command.install_sphinx import install_sphinx
-    from obidistutils.command.install import install
-    from obidistutils.command.pidname import pidname
-    from obidistutils.command.sdist import sdist
-    
-        
-    
-    COMMANDS = {'build':build,
-#                'serenity':serenity,
-                'littlebigman':littlebigman,
-                'pidname':pidname,
-                'build_ctools':build_ctools, 
-                'build_files':build_files,
-                'build_cexe':build_cexe, 
-                'build_ext': build_ext,
-                'build_scripts':build_scripts, 
-                'install_scripts':install_scripts,
-                'install_sphinx':install_sphinx,
-                'install':install,
-                'sdist':sdist}
-    
-#     try:
-#         from setuptools.commands import egg_info
-#         COMMANDS['egg_info']=egg_info
-#     except ImportError:
-#         pass
-    try:
-        from obidistutils.command.build_sphinx import build_sphinx
-        COMMANDS['build_sphinx']=build_sphinx
-    except ImportError:
-        pass
-
-    return COMMANDS
-
-
-CTOOLS =[]
-CEXES  =[]
-FILES  =[]
-
-def setup(**attrs):
-    
-    log.set_threshold(log.INFO)
-    
-    minversion      = attrs.get("pythonmin",'3.4')
-    maxversion      = attrs.get('pythonmax',None)    
-    fork            = attrs.get('fork',False)
-    requirementfile = attrs.get('requirements','requirements.txt')
-
-    try:
-        del attrs['pythonmin']
-    except KeyError:
-        pass
-
-    try:
-        del attrs['pythonmax']
-    except KeyError:
-        pass
-
-    try:
-        del attrs['fork']
-    except KeyError:
-        pass
-
-    try:
-        del attrs['requirements']
-    except KeyError:
-        pass
-    
-    if is_serenity():
-    
-        
-        enforce_good_python(minversion, maxversion, fork)
-        
-        if (install_requirements(requirementfile)):
-            rerun_with_anothe_python(sys.executable,minversion,maxversion,fork)
-        
-    
-        try:
-            check_requirements(requirementfile)
-        except RequirementError as e :
-            log.error(e)                                   
-            sys.exit(1)
-        
-    if 'distclass' not in attrs:
-        attrs['distclass']=Distribution
-
-    if 'python_src' not in attrs:
-        SRC = 'python'
-    else:
-        SRC = attrs['python_src']
-        del(attrs['python_src'])
-    
-    if 'scripts' not in attrs:
-        attrs['scripts'] = glob.glob('%s/*.py' % SRC)
-
-    if 'package_dir' not in attrs:
-        attrs['package_dir'] = {'': SRC}
-
-    if 'packages' not in attrs:
-        attrs['packages'] = findPackage(SRC)
-    
-    if 'cmdclass' not in attrs:
-        attrs['cmdclass'] = prepare_commands()
-
-    if 'ctools' not in attrs:
-        attrs['ctools'] = CTOOLS
-    
-    if 'executables' not in attrs:
-        attrs['executables'] = CEXES
-        
-    if 'files' not in attrs:
-        attrs['files'] = FILES
-        
-    if 'sse' not in attrs:
-        attrs['sse']=None
-        
-    if 'serenity' not in attrs:
-        attrs['serenity']=False
-    
-    EXTENTION=findCython(SRC)
-    
-    if 'ext_modules' not in attrs:
-        attrs['ext_modules'] = EXTENTION
-        
-#     try:
-#         from setuptools.core import setup as ori_setup
-#     except ImportError:
-#         from distutils.core import setup as ori_setup
-
-    from distutils.core import setup as ori_setup
-    
-    ori_setup(**attrs)

distutils.ext/obidistutils/dist.py

@@ -1,58 +0,0 @@
-'''
-Created on 20 oct. 2012
-
-@author: coissac
-'''
-
-# try:
-#     from setuptools.dist import Distribution as ori_Distribution
-# except ImportError:
-#     from distutils.dist import Distribution as ori_Distribution
-
-from distutils.dist import Distribution as ori_Distribution
-
-class Distribution(ori_Distribution):
-    
-    def __init__(self,attrs=None):
-        self.executables = None
-        self.ctools = None
-        self.files = None
-        self.build_cexe  = None
-        self.deprecated_scripts = None
-        self.zip_safe=False
-        self.sse = None
-        self.serenity=attrs['serenity']
-        
-        ori_Distribution.__init__(self, attrs)
-        
-        self.global_options.insert(0,('serenity', None, "install or build the package in a python virtualenv "
-                                                       "without polluting the installed python and with many "
-                                                       "checks during the installation process"
-                                     ))
-        self.global_options.insert(0,('virtualenv', None, "if the installation is done using the serenity mode "
-                                                        "this option allows for specifying the virtualenv name. "
-                                                        "By default the name is PACKAGE-VERSION"
-                                     ))
-        
-    def run_commands(self):
-        """Run each command that was seen on the setup script command line.
-        Uses the list of commands found and cache of command objects
-        created by 'get_command_obj()'.
-        """
-#        self.run_command('littlebigman')
-        ori_Distribution.run_commands(self)
-        
-        
-    def has_executables(self):
-        return self.executables is not None and self.executables
-        
-    def has_ctools(self):
-        return self.ctools is not None and self.ctools
-        
-    def has_files(self):
-        return self.files is not None and self.files
-        
-    def has_deprecated_scripts(self):
-        return self.deprecated_scripts is not None and self.deprecated_scripts
-
-    

distutils.ext/obidistutils/serenity/__init__.py

@@ -1,112 +0,0 @@
-import sys
-
-from distutils import util
-from distutils import sysconfig
-from distutils import log
-from distutils.version import LooseVersion, StrictVersion
-import glob
-import os
-import subprocess
-import re 
-from distutils.errors import DistutilsError
-import tempfile
-
-from importlib.util import spec_from_file_location  # @UnresolvedImport
-import zipimport
-
-import argparse
-
-import base64
-
-from .checkpython import is_python_version
-                        
-                        
-from obidistutils.serenity.rerun import  enforce_good_python
-from obidistutils.serenity.rerun import rerun_with_anothe_python
-
-from obidistutils.serenity.virtual import serenity_virtualenv
-                        
-from obidistutils.serenity.checksystem import is_mac_system, \
-                                              is_windows_system
-                        
-from obidistutils.serenity.checkpackage import install_requirements
-from obidistutils.serenity.checkpackage import check_requirements
-
-from obidistutils.serenity.util import save_argv
-                        
-from obidistutils.serenity.snake import snake
-                            
-    
-def serenity_snake(envname,package,version):
-    old = log.set_threshold(log.INFO)
-
-    log.info("Installing %s (%s) in serenity mode" % (package,version))
-
-    enforce_good_python()
-
-    virtualpython=serenity_virtualenv(envname,package,version)
-    
-    if virtualpython!=os.path.realpath(sys.executable):
-        log.info("Restarting installation within the %s virtualenv" % (envname))
-        rerun_with_anothe_python(virtualpython)
-        
-    log.info("%s will be installed with python : %s" % (package,virtualpython))
-        
-    if install_requirements():    
-        log.info("Restarting installation with all dependencies ok")
-        rerun_with_anothe_python(virtualpython)
-    
-    log.set_threshold(old)
-    
-def serenity_assert(version):
-    check_requirements()
-
-
-def is_serenity():
-    from obidistutils.serenity.globals import local_serenity
-    return local_serenity and local_serenity[0]
-
-def serenity_mode(package,version):
-    
-    save_argv()
-
-    
-    from obidistutils.serenity.globals import saved_args
-    from obidistutils.serenity.globals import local_serenity
-    
-
-    old = log.set_threshold(log.INFO)
-    
-    argparser = argparse.ArgumentParser(add_help=False)
-    argparser.add_argument('--serenity',
-                           dest='serenity', 
-                           action='store_true',
-                           default=False, 
-                           help='Switch the installer in serenity mode. Everythings are installed in a virtualenv')
-
-    argparser.add_argument('--virtualenv',
-                           dest='virtual', 
-                           type=str,
-                           action='store',
-                           default="%s-%s" % (package,version), 
-                           help='Specify the name of the virtualenv used by the serenity mode [default: %s-%s]' % (package,version))    
-    
-    args, unknown = argparser.parse_known_args()
-    sys.argv = [sys.argv[0]] + unknown
-    
-    if args.serenity:
-        local_serenity.append(True)
-        serenity_snake(args.virtual,package,version)
-    else:
-        local_serenity.append(False)       
-    
-    log.set_threshold(old)
-    
-    return args.serenity
-    
-    
-def getVersion(source,main,version):
-    path  = os.path.join(source,main,'%s.py' % version)
-    spec = spec_from_file_location('version',path)
-    return spec.loader.load_module().version.strip()
-    

distutils.ext/obidistutils/serenity/checkpackage.py

@@ -1,160 +0,0 @@
-'''
-Created on 2 oct. 2014
-
-@author: coissac
-'''
-
-import re
-import os
-
-import pip                                              # @UnresolvedImport
-from pip.utils import get_installed_distributions       # @UnresolvedImport
-from distutils.version import StrictVersion             # @UnusedImport
-from distutils.errors import DistutilsError
-from distutils import log
-
-class RequirementError(Exception):
-    pass
-
-def is_installed(requirement):
-    
-    
-    requirement_project,requirement_relation,requirement_version = parse_package_requirement(requirement)
-    
-    package = [x for x in get_installed_distributions() if x.project_name==requirement_project]
-    
-    if len(package)==1:
-        if requirement_version is not None and requirement_relation is not None:    
-            rep = (len(package)==1) and eval("StrictVersion('%s') %s StrictVersion('%s')" % (package[0].version,
-                                                                                           requirement_relation,
-                                                                                           requirement_version)
-                                             )
-        else:
-            rep=True
-    else:
-        rep=False
-    
-    if rep:
-        if requirement_version is not None and requirement_relation is not None:        
-            log.info("Look for package %s (%s%s) : ok version %s installed" % (requirement_project,
-                                                                               requirement_relation,
-                                                                               requirement_version,
-                                                                               package[0].version))
-        else:
-            log.info("Look for package %s : ok version %s installed" % (requirement_project,
-                                                                        package[0].version))
-    else:
-        if len(package)!=1:
-            log.info("Look for package %s (%s%s) : not installed" % (requirement_project,
-                                                                     requirement_relation,
-                                                                     requirement_version))
-        else:
-            log.info("Look for package %s (%s%s) : failed only version %s installed" % (requirement_project,
-                                                                                        requirement_relation,
-                                                                                        requirement_version,
-                                                                                        package[0].version))
-        
-    return rep
-
-
-def get_requirements(requirementfile='requirements.txt'):
-    
-    try:
-        requirements = open(requirementfile).readlines()
-        requirements = [x.strip() for x in requirements]
-        requirements = [x for x in requirements if x[0]!='-']
-    
-    except IOError:
-        requirements = []
-        
-    return requirements
-    
-    
-def install_requirements(requirementfile='requirements.txt'):
-    
-    install_something=False
-
-    requirements = get_requirements(requirementfile)
-
-    log.info("Required packages for the installation :")
-    for x in requirements:
-        ok = is_installed(x)
-        if not ok:
-            log.info("  Installing requirement : %s" % x)
-            pip_install_package(x)
-            install_something=True
-            if x[0:3]=='pip':
-                return True
-                
-    return install_something
- 
-
-def check_requirements(requirementfile='requirements.txt'):
-    
-    requirements = get_requirements(requirementfile)
-    
-    log.info("Required packages for the installation :")
-    for x in requirements:
-        ok = is_installed(x)
-        if not ok:
-            raise RequirementError("  Missing requirement : %s -- Package installation stopped" % x)
-                
- 
-
-
-def parse_package_requirement(requirement):
-    
-    version_pattern = re.compile('[=><]+(.*)$')
-    project_pattern  = re.compile('[^=><]+')
-    relationship_pattern = re.compile('[=><]+')
-    
-    try:
-        requirement_project = project_pattern.search(requirement).group(0)
-        requirement_version = version_pattern.search(requirement)
-        if requirement_version is not None:
-            requirement_version=requirement_version.group(1)
-        requirement_relation= relationship_pattern.search(requirement)
-        if requirement_relation is not None:
-            requirement_relation=requirement_relation.group(0)
-    except:
-        raise DistutilsError("Requirement : %s not correctly formated" % requirement)
-    
-    return requirement_project,requirement_relation,requirement_version
-    
-
-def get_package_requirement(package,requirementfile='requirements.txt'):            
-    requirements = get_requirements(requirementfile)
-    req = [x for x in requirements
-             if x[0:len(package)]==package
-          ]
-    
-    if len(req)==1:
-        return req[0]
-    else:
-        return None
-        
-        
-def pip_install_package(package,directory=None,upgrade=True):
-
-    if directory is not None:
-        log.info('    installing %s in directory %s' % (package,str(directory)))
-        
-
-    if 'http_proxy' in os.environ and 'https_proxy' not in os.environ:
-        os.environ['https_proxy']=os.environ['http_proxy']
-
-    args = ['install']
-    
-    if upgrade:
-        args.append('--upgrade')
-    
-    if 'https_proxy' in os.environ:
-        args.append('--proxy=%s' % os.environ['https_proxy'])
-        
-    if directory is not None:
-        args.append('--target=%s' % directory)
-    
-    args.append(package)
-        
-    return pip.main(args)
-

distutils.ext/obidistutils/serenity/checkpython.py

@@ -1,138 +0,0 @@
-'''
-Created on 24 mai 2015
-
-@author: coissac
-'''
-from distutils.version import StrictVersion
-from distutils import sysconfig
-import subprocess
-import os
-import glob
-import re
-
-from obidistutils.serenity.checksystem import is_windows_system
-import sys
-
-
-def is_python_version(path=None,minversion='3.4',maxversion=None):
-    '''
-    Checks that the python version is in the range {minversion,maxversion[
-    
-        @param path: if None consider the running python
-                     otherwise the python pointed by the path
-        @param minversion: the minimum version to consider
-        @param maxversion: the maximum version to consider (strictly inferior to)
-                     
-        @return: True if the python version match
-        @rtype: bool
-    '''
-    if path is None:
-        pythonversion = StrictVersion(sysconfig.get_python_version())
-    else:
-        command = """'%s' -c 'from distutils import sysconfig; """ \
-                  """print(sysconfig.get_python_version())'""" % path
-                  
-        p = subprocess.Popen(command, 
-                             shell=True, 
-                             stdout=subprocess.PIPE)
-        pythonversion=str(p.communicate()[0],'utf8').strip()
-        pythonversion = StrictVersion(pythonversion)
-                        
-    return  (        pythonversion >=StrictVersion(minversion) 
-             and (   maxversion is None    
-                  or pythonversion < StrictVersion(maxversion))
-            )
-           
-
-def lookfor_good_python(minversion='3.4',maxversion=None,followLink=False):
-    '''
-    Look for all python interpreters present in the system path that
-    match the version constraints.
-    
-    @param minversion: the minimum version to consider
-    @param maxversion: the maximum version to consider (strictly inferior to)
-    @param followLink: a boolean value indicating if link must be substituted 
-                       by their real path.
-                       
-    @return: a list of path to interpreters
-    '''
-    exe = []
-    if not is_windows_system():
-        paths = os.environ['PATH'].split(os.pathsep)
-        for p in paths:
-            candidates = glob.glob(os.path.join(p,'python*')) 
-            pexe = []
-            pythonpat=re.compile('python([0-9]|[0-9]\.[0-9])?$')
-            for e in candidates:
-                print(e)
-                if pythonpat.search(e) is not None:
-                    if followLink and os.path.islink(e):
-                        e = os.path.realpath(e)
-                    if (os.path.isfile(e) and 
-                       os.access(e, os.X_OK) and 
-                       is_python_version(e,minversion,maxversion)):
-                        pexe.append(e)
-            exe.extend(set(pexe))
-        
-    return exe
-
-def is_a_virtualenv_python(path=None):
-    '''
-    Check if the python is belonging a virtualenv
-    
-        @param path: the path pointing to the python executable.
-                     if path is None then the running python is
-                     considered.
-        @param path: str or None 
-                     
-        @return: True if the python belongs a virtualenv
-                 False otherwise
-        @rtype: bool
-                 
-    '''
-    if path is None:
-        rep = sys.base_exec_prefix != sys.exec_prefix
-    else:
-        command = """'%s' -c 'import sys; print(sys.base_exec_prefix != sys.exec_prefix)'""" % path
-        p = subprocess.Popen(command, 
-                             shell=True, 
-                             stdout=subprocess.PIPE)
-        rep = eval(str(p.communicate()[0],'utf8'))
-        
-    return rep
-
-
-def which_virtualenv(path=None,full=False):
-    '''
-    Returns the name of the virtualenv.
-        @param path: the path to a python binary or None
-                     if you want to consider the running python
-        @type path: str or None
-                     
-        @param full: if set to True, returns the absolute path,
-                     otherwise only return a simple directory name
-        @type full: bool
-                 
-        @return: the virtual environment name or None if the
-                 path does not belong a virtualenv
-        @rtype: str or None
-    '''
-    if path is None:
-        path = sys.executable
-    
-    if is_a_virtualenv_python(path):
-        parts = path.split(os.sep)
-        try:
-            if full:
-                rep = os.sep.join(parts[0:parts.index('bin')])
-                rep = os.path.realpath(rep)
-            else:
-                rep = parts[parts.index('bin')-1]
-        except ValueError:
-            rep = None
-    else:
-        rep=None
-        
-    return rep
-        
-

distutils.ext/obidistutils/serenity/checksystem.py

@@ -1,18 +0,0 @@
-'''
-Created on 24 mai 2015
-
-@author: coissac
-'''
-
-from distutils import util
-
-def is_mac_system():
-    platform = util.get_platform().split('-')[0]
-    
-    return platform=='macosx'
-
-def is_windows_system():
-    platform = util.get_platform().split('-')[0]
-    
-    return platform=='Windows'
-        

distutils.ext/obidistutils/serenity/globals.py

@@ -1,14 +0,0 @@
-'''
-Created on 24 mai 2015
-
-@author: coissac
-'''
-
-
-saved_args=[]
-tmpdir=[]
-local_pip=[]
-local_virtualenv=[]
-local_cython=[]
-local_serenity=[]
-        

distutils.ext/obidistutils/serenity/rerun.py

@@ -1,61 +0,0 @@
-'''
-Created on 24 mai 2015
-
-@author: coissac
-'''
-
-import sys
-import os
-from distutils import log
-from distutils.errors import DistutilsError
-
-
-from obidistutils.serenity.globals import saved_args
-from obidistutils.serenity.checkpython import is_python_version,\
-    lookfor_good_python
-
-
-def rerun_with_anothe_python(path, minversion='3.4',maxversion=None, fork=False):
-        
-    if saved_args:
-        args = saved_args
-    else:
-        args = list(sys.argv)
-        
-          
-    assert is_python_version(path,minversion,maxversion), \
-           'the selected python is not adapted to the installation of this package'
-                   
-    args.insert(0, path)
-        
-    sys.stderr.flush()
-    sys.stdout.flush()
-    
-    if fork:
-        log.info('Forking a new install process')
-        os.system(' '.join(list(args)))
-        log.info('External process ended')
-        sys.exit(0)
-    else:
-        log.info('Install script restarting...')
-        os.execv(path,list(args))
-
-def enforce_good_python(minversion='3.4',maxversion=None, fork=False):
-    if is_python_version(minversion=minversion,maxversion=maxversion):
-        log.info('You are running the good python')
-        return True
-    
-    goodpython = lookfor_good_python(minversion,maxversion)
-    
-    if not goodpython:
-        raise DistutilsError('No good python identified on your system')
-
-    goodpython=goodpython[0]
-    
-    log.warn("========================================")    
-    log.warn("")
-    log.warn("    Switching to python : %s" % goodpython)
-    log.warn("")
-    log.warn("========================================")    
-
-    rerun_with_anothe_python(goodpython)

distutils.ext/obidistutils/serenity/snake.py

@@ -1,35 +0,0 @@
-'''
-Created on 2 oct. 2014
-
-@author: coissac
-'''
-
-snake ="""
-
-        ___
-      ,'._,`.
-     (-.___.-)
-     (-.___.-)
-     `-.___.-'
-      ((  @ @|              .            __
-       \   ` |         ,\   |`.    @|   |  |      _.-._
-      __`.`=-=mm===mm:: |   | |`.   |   |  |    ,'=` '=`.
-     (    `-'|:/  /:/  `/  @| | |   |, @| @|   /---)W(---\ 
-      \ \   / /  / /         @| |   '         (----| |----) ,~
-      |\ \ / /| / /            @|              \---| |---/  |
-      | \ V /||/ /                              `.-| |-,'   |
-      |  `-' |V /                                 \| |/    @'
-      |    , |-'                                 __| |__
-      |    .;: _,-.                         ,--""..| |..""--.
-      ;;:::' "    )                        (`--::__|_|__::--')
-    ,-"      _,  /                          \`--...___...--'/
-   (    -:--'/  /                           /`--...___...--'\  
-    "-._  `"'._/                           /`---...___...---'\  
-        "-._   "---.                      (`---....___....---')
-         .' ",._ ,' )                     |`---....___....---'|
-         /`._|  `|  |                     (`---....___....---')
-        (   \    |  /                      \`---...___...---'/
-         `.  `,  ^""                        `:--...___...--;'
-           `.,'               hh              `-._______.-'
-
-"""

distutils.ext/obidistutils/serenity/util.py

@@ -1,27 +0,0 @@
-'''
-Created on 2 oct. 2014
-
-@author: coissac
-'''
-
-import sys 
-import tempfile
-
-
-from obidistutils.serenity.globals import tmpdir         # @UnusedImport
-from obidistutils.serenity.globals import saved_args     # @UnusedImport
-
-def get_serenity_dir():
-    global tmpdir
-
-    if not tmpdir:
-        tmpdir.append(tempfile.mkdtemp())
-    return tmpdir[0]
-        
-def save_argv():
-    global saved_args
-
-    del saved_args[:]
-    saved_args.extend(list(sys.argv))
-
-           

distutils.ext/obidistutils/serenity/virtual.py

@@ -1,69 +0,0 @@
-'''
-Created on 2 oct. 2014
-
-@author: coissac
-'''
-
-import os
-import sys
-import venv
-
-from distutils.errors import DistutilsError
-from .globals import local_virtualenv  # @UnusedImport
-from .checkpython import   which_virtualenv,\
-                           is_python_version, \
-                           is_a_virtualenv_python
-                                                
-
-    
-    
-def serenity_virtualenv(envname,package,version,minversion='3.4',maxversion=None):
-        
-    #
-    # Checks if we are already running under the good virtualenv
-    #
-    ve = which_virtualenv(full=True)
-    if ve == os.path.realpath(envname) and is_python_version(minversion=minversion,maxversion=maxversion):
-        return sys.executable
-        
-    #
-    # Check if the virtualenv exist
-    # 
-        
-    python = None
-    
-    if os.path.isdir(envname):
-        python = os.path.join(envname,'bin','python')
-        ok = (is_python_version(python,
-                                minversion=minversion,
-                                maxversion=maxversion) and 
-              is_a_virtualenv_python(python))
-        
-        
-        #
-        # The virtualenv already exist but it is not ok
-        #
-        if not ok:
-            raise DistutilsError("A virtualenv %s already exists but not with the required python")
-                 
-    else:
-        ok = False
-                
-        
-    #
-    # Creates a new virtualenv
-    #
-    if not ok:
-        venv.create(envname, 
-                    system_site_packages=False, 
-                    clear=True, 
-                    symlinks=False, 
-                    with_pip=True)
-        
-        # check the newly created virtualenv
-        return serenity_virtualenv(envname,package,version)
-    
-    return os.path.realpath(python)
-    
-    
-    

distutils.ext/src/littlebigman.c

@@ -1,24 +0,0 @@
-/*
- * littlebigman.c
- *
- *  Created on: 11 juil. 2012
- *      Author: coissac
- */
-
-#include<stdio.h>
-
-int main(int argc, char *argv[])
-{
-    union { int entier;
-            char caractere[4] ;
-    } test;
-
-    test.entier=0x01020304;
-
-    if (test.caractere[3] == 1)
-       printf("-DLITTLE_END");
-    else
-        printf("-DBIG_END");
-
-	return 0;
-}

distutils.ext/src/pidname.c

@@ -1,24 +0,0 @@
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <errno.h>
-#include <libproc.h>
-
-int main (int argc, char* argv[])
-{
-	pid_t pid; int ret;
-	char pathbuf[PROC_PIDPATHINFO_MAXSIZE];
-
-	if ( argc > 1 ) {
-		pid = (pid_t) atoi(argv[1]);
-		ret = proc_pidpath (pid, pathbuf, sizeof(pathbuf));
-		if ( ret <= 0 ) {
-			fprintf(stderr, "PID %d: proc_pidpath ();\n", pid);
-			fprintf(stderr,	"    %s\n", strerror(errno));
-		} else {
-			printf("proc %d: %s\n", pid, pathbuf);
-		}
-	}
-
-	return 0;
-}

doc/.gitignore

@@ -1,5 +0,0 @@
-/build/
-/doxygen/
-/build_dir.txt
-/.DS_Store
-/.gitignore

doc/Makefile

@@ -1,203 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = build
-DOXYGENDIR    = doxygen
-
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
-
-help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html       to make standalone HTML files"
-	@echo "  dirhtml    to make HTML files named index.html in directories"
-	@echo "  singlehtml to make a single large HTML file"
-	@echo "  pickle     to make pickle files"
-	@echo "  json       to make JSON files"
-	@echo "  htmlhelp   to make HTML files and a HTML help project"
-	@echo "  qthelp     to make HTML files and a qthelp project"
-	@echo "  applehelp  to make an Apple Help Book"
-	@echo "  devhelp    to make HTML files and a Devhelp project"
-	@echo "  epub       to make an epub"
-	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
-	@echo "  text       to make text files"
-	@echo "  man        to make manual pages"
-	@echo "  texinfo    to make Texinfo files"
-	@echo "  info       to make Texinfo files and run them through makeinfo"
-	@echo "  gettext    to make PO message catalogs"
-	@echo "  changes    to make an overview of all changed/added/deprecated items"
-	@echo "  xml        to make Docutils-native XML files"
-	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
-	@echo "  linkcheck  to check all external links for integrity"
-	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
-	@echo "  coverage   to run coverage check of the documentation (if enabled)"
-
-clean:
-	rm -rf $(BUILDDIR)/*
-	rm -rf $(DOXYGENDIR)/*
-
-html:
-	@echo "Generating Doxygen documentation..."
-	doxygen Doxyfile
-	@echo "Doxygen documentation generated. \n"
-	$(SPHINXBUILD) -b html -c ./ $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OBITools-3.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OBITools-3.qhc"
-
-applehelp:
-	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
-	@echo
-	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
-	@echo "N.B. You won't be able to view it unless you put it in" \
-	      "~/Library/Documentation/Help or install it in your application" \
-	      "bundle."
-
-devhelp:
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/OBITools-3"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OBITools-3"
-	@echo "# devhelp"
-
-epub:
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
-	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
-	@echo "Generating Doxygen documentation..."
-	doxygen Doxyfile
-	@echo "Doxygen documentation generated. \n"
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
-	@echo "Generating Doxygen documentation..."
-	doxygen Doxyfile
-	@echo "Doxygen documentation generated. \n"
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-latexpdfja:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through platex and dvipdfmx..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo
-	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
-	@echo "Run \`make' in that directory to run these through makeinfo" \
-	      "(use \`make info' here to do that automatically)."
-
-info:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo "Running Texinfo files through makeinfo..."
-	make -C $(BUILDDIR)/texinfo info
-	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
-	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
-	@echo
-	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
-
-coverage:
-	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
-	@echo "Testing of coverage in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/coverage/python.txt."
-
-xml:
-	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
-	@echo
-	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
-	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
-	@echo
-	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

doc/conf.py

@@ -1,298 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# OBITools3 documentation build configuration file, created by
-# sphinx-quickstart on Mon May  4 14:36:57 2015.
-#
-# 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
-import os
-import shlex
-
-# 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.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.pngmath',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode',
-#    'breathe',
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'source/index'
-
-# General information about the project.
-project = u'OBITools3'
-copyright = u'2015, Céline Mercier, Eric Coissac, Frédéric Boyer'
-author = u'Céline Mercier, Eric Coissac, Frédéric Boyer'
-
-# 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 = '0.0'
-# The full version, including alpha/beta/rc tags.
-release = '0.0.0'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-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 = []
-
-# 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 = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
-
-
-# -- 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 = 'bizstyle'
-
-# 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
-
-# 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']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-
-# 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
-
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
-#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
-#html_search_language = 'en'
-
-# A dictionary with options for the search language support, empty by default.
-# Now only 'ja' uses this config value
-#html_search_options = {'type': 'default'}
-
-# The name of a javascript file (relative to the configuration directory) that
-# implements a search results scorer. If empty, the default will be used.
-#html_search_scorer = 'scorer.js'
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'OBITools3doc'
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-
-# Latex figure (float) alignment
-#'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-  (master_doc, 'OBITools3.tex', u'OBITools3 Documentation',
-   u'Céline Mercier, Eric Coissac, Frédéric Boyer', '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
-
-# 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 = [
-    (master_doc, 'obitools3', u'OBITools3 Documentation',
-     [author], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-  (master_doc, 'OBITools3', u'OBITools3 Documentation',
-   author, 'OBITools3', 'One line description of project.',
-   'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
-
-#Breathe configuration
-sys.path.append( "breathe/" )
-breathe_projects = { "OBITools3": "doxygen/xml/" }
-breathe_default_project = "OBITools3"
-

doc/source/DMS.rst

@@ -1,160 +0,0 @@
-*********************************************
-The OBItools3 Data Management System (OBIDMS)
-*********************************************
-
-A complete DNA metabarcoding experiment relies on several kinds of data.
-
-	- The sequence data resulting from the sequencing of the PCR products,
-	- The description of the samples including all their metadata,
-	- One or several reference databases used for the taxonomic annotation,
-	- One or several taxonomy databases.
-
-Up to now, each of these categories of data were stored in separate
-files, and nothing made it mandatory to keep them together.
-
-
-The `Data Management System` (DMS) of OBITools3 can be viewed like a basic 
-database system.
-
-
-OBIDMS UML
-==========
-
-.. image:: ./UML/OBIDMS_UML.png
-
-:download:`html version of the OBIDMS UML file <UML/ObiDMS_UML.class.violet.html>`
-
-
-An OBIDMS directory contains :
-  * one `OBIDMS history file <#obidms-history-files>`_
-  * OBIDMS column directories
-
-
-OBIDMS column directories
-=========================
-
-OBIDMS column directories contain :
-    * all the different versions of one OBIDMS column, under the form of different files (`OBIDMS column files <#obidms-column-files>`_)
-    * one `OBIDMS version file <#obidms-version-files>`_
-
-The directory name is the column attribute with the extension ``.obicol``.
-
-Example: ``count.obicol``
-
-
-OBIDMS column files
-===================
-
-Each OBIDMS column file contains :
-	* a header of a size equal to a multiple of PAGESIZE (PAGESIZE being equal to 4096 bytes
-	  on most systems) containing metadata
-	* Lines of data with the same `OBIType <types.html#obitypes>`_
-
-
-Header
-------
-
-The header of an OBIDMS column contains :
-
-	* Endian byte order
-	* Header size (PAGESIZE multiple)
-	* Number of lines of data
-	* Number of lines of data used
-	* `OBIType <types.html#obitypes>`_ (type of the data)
-	* Date of creation of the file
-	* Version of the OBIDMS column
-	* The column name
-	* Eventual comments
-
-
-Data
-----
-
-A line of data corresponds to a vector of elements. Each element is associated with an element name. 
-Elements names are stored in the header. The correspondance between an element and its name is done 
-using their order in the lists of elements and elements names.  This structure allows the storage of 
-dictionary-like data.
-
-Example: In the header, the attribute ``elements_names`` will be associated with the value ``"sample_1;
-sample_2;sample_3"``, and a line of data with the type ``OBInt_t`` will be stored as an ``OBInt_t`` vector 
-of size three e.g. ``5|8|4``.
-
-
-Mandatory columns
------------------
-
-Some columns must exist in an OBIDMS directory :
-    * sequence identifiers column (type ``OBIStr_t``)
-
-
-File name
----------
-
-Each file is named with the attribute associated to the data it contains, and the number of
-its version, separated by an ``@``, and with the extension ``.odc``.
-
-Example : ``count@3.odc``
-
-
-Modifications
--------------
-
-An OBIDMS column file can only be modified by the process that created it, and while its status is set to Open. 
-
-When a process wants to modify an OBIDMS column file that is closed, it must first clone it. Cloning creates a new version of the
-file that belongs to the process, i.e., only that process can modify that file, as long as its status is set to Open. Once the process
-has finished writing the new version of the column file, it sets the column file's status to Closed, and the file can never be modified
-again.
-
-That means that one column is stored in one file (if there is only one version)
-or more (if there are several versions), and that there is one file per version.
-
-All the versions of one column are stored in one directory.
-
-
-Versioning
-----------
-
-The first version of a column file is numbered 0, and each new version increments that
-number by 1.
-
-The number of the latest version of an OBIDMS column is stored in the `OBIDMS version file <#obidms-version-files>`_ of its directory.
-
-
-OBIDMS version files
-====================
-
-Each OBIDMS column is associated with an OBIDMS version file in its directory, that contains the number of the latest
-version of the column.
-
-File name
----------
-
-OBIDMS version files are named with the attribute associated to the data contained in the column, and
-have the extension ``.odv``.
-
-Example : ``count.odv``
-
-
-OBIDMS views
-============
-
-An OBIDMS view consists of a list of OBIDMS columns and lines. A view includes one version
-of each mandatory column. Only one version of each column is included. All the columns of
-one view contain the same number of lines in the same order.
-
-
-OBIDMS history file
-===================
-
-An OBIDMS history file consists of an ordered list of views and commands, those commands leading
-from one view to the next one.
-
-This history can be represented in the form of a ?? showing all the
-operations ever done in the OBIDMS directory and the views in between them :
-
-.. image:: ./images/history.png
-    :width: 150 px
-    :align: center
-
-

doc/source/UML/OBITypes_UML.class.violet.html

@@ -1,832 +0,0 @@
-<HTML>
-<HEAD>
-<META name="description"
-	content="Violet UML Editor cross format document" />
-<META name="keywords" content="Violet, UML" />
-<META charset="UTF-8" />
-<SCRIPT type="text/javascript">
-	function switchVisibility() {
-		var obj = document.getElementById("content");
-		obj.style.display = (obj.style.display == "block") ? "none" : "block";
-	}
-</SCRIPT>
-</HEAD>
-<BODY>
-	This file was generated with Violet UML Editor 2.1.0.
-	&nbsp;&nbsp;(&nbsp;<A href=# onclick="switchVisibility()">View Source</A>&nbsp;/&nbsp;<A href="http://sourceforge.net/projects/violet/files/violetumleditor/" target="_blank">Download Violet</A>&nbsp;)
-	<BR />
-	<BR />
-	<SCRIPT id="content" type="text/xml"><![CDATA[<ClassDiagramGraph id="1">
-  <nodes id="2">
-    <ClassNode id="3">
-      <children id="4"/>
-      <location class="Point2D.Double" id="5" x="520.0" y="30.0"/>
-      <id id="6" value="a6688f6e-9346-46c6-9cf5-4fa6148f613f"/>
-      <revision>1</revision>
-      <backgroundColor id="7">
-        <red>255</red>
-        <green>255</green>
-        <blue>255</blue>
-        <alpha>255</alpha>
-      </backgroundColor>
-      <borderColor id="8">
-        <red>0</red>
-        <green>0</green>
-        <blue>0</blue>
-        <alpha>255</alpha>
-      </borderColor>
-      <textColor reference="8"/>
-      <name id="9" justification="1" size="3" underlined="false">
-        <text>OBIType_t
-</text>
-      </name>
-      <attributes id="10" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="11" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="12">
-      <children id="13"/>
-      <location class="Point2D.Double" id="14" x="780.0" y="100.0"/>
-      <id id="15" value="7edd4f08-c5e5-4e41-bc05-8b357cb5e629"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="16" justification="1" size="3" underlined="false">
-        <text>OBIContainer_t</text>
-      </name>
-      <attributes id="17" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="18" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="19">
-      <children id="20"/>
-      <location class="Point2D.Double" id="21" x="330.0" y="110.0"/>
-      <id id="22" value="dbb15831-2f0b-4e97-83e7-5ecdda6d6075"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="23" justification="1" size="3" underlined="false">
-        <text>OBIElementary_t</text>
-      </name>
-      <attributes id="24" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="25" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="26">
-      <children id="27"/>
-      <location class="Point2D.Double" id="28" x="670.0" y="240.0"/>
-      <id id="29" value="9693da23-1b47-4bf3-9544-86390a533713"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="30" justification="1" size="3" underlined="false">
-        <text>OBIList_t</text>
-      </name>
-      <attributes id="31" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="32" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="33">
-      <children id="34"/>
-      <location class="Point2D.Double" id="35" x="780.0" y="240.0"/>
-      <id id="36" value="b2f4d561-0c10-4443-b8f6-d3628ab9bcfe"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="37" justification="1" size="3" underlined="false">
-        <text>OBISet_t</text>
-      </name>
-      <attributes id="38" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="39" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="40">
-      <children id="41"/>
-      <location class="Point2D.Double" id="42" x="890.0" y="240.0"/>
-      <id id="43" value="8cc209c6-18c7-4a90-a5d4-ab7246638b2f"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="44" justification="1" size="3" underlined="false">
-        <text>OBIDictionnary_t</text>
-      </name>
-      <attributes id="45" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="46" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="47">
-      <children id="48"/>
-      <location class="Point2D.Double" id="49" x="170.0" y="220.0"/>
-      <id id="50" value="cb77086b-7535-49dc-ab33-b58d16eec496"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="51" justification="1" size="3" underlined="false">
-        <text>OBIAtomic_t</text>
-      </name>
-      <attributes id="52" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="53" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="54">
-      <children id="55"/>
-      <location class="Point2D.Double" id="56" x="500.0" y="240.0"/>
-      <id id="57" value="5a32037d-eaf1-4bbc-977e-06589f1d2ca5"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="58" justification="1" size="3" underlined="false">
-        <text>OBIComposite_t
-</text>
-      </name>
-      <attributes id="59" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="60" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="61">
-      <children id="62"/>
-      <location class="Point2D.Double" id="63" x="560.0" y="400.0"/>
-      <id id="64" value="84fa636d-0c5a-4df8-bac7-79df8e546c12"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="65" justification="1" size="3" underlined="false">
-        <text>OBIString_t</text>
-      </name>
-      <attributes id="66" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="67" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="68">
-      <children id="69"/>
-      <location class="Point2D.Double" id="70" x="450.0" y="400.0"/>
-      <id id="71" value="752b5f9b-0ece-4902-8de5-e2c465d281dd"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="72" justification="1" size="3" underlined="false">
-        <text>OBITaxid_t
-</text>
-      </name>
-      <attributes id="73" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="74" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="75">
-      <children id="76"/>
-      <location class="Point2D.Double" id="77" x="220.0" y="400.0"/>
-      <id id="78" value="9b89f530-cedc-4b33-a36f-371ccfb2ffae"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="79" justification="1" size="3" underlined="false">
-        <text>OBIInteger_t
-</text>
-      </name>
-      <attributes id="80" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="81" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="82">
-      <children id="83"/>
-      <location class="Point2D.Double" id="84" x="0.0" y="400.0"/>
-      <id id="85" value="01da8ca2-da98-4fde-9ffe-9753a3f202bf"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="86" justification="1" size="3" underlined="false">
-        <text>OBIFloat_t</text>
-      </name>
-      <attributes id="87" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="88" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="89">
-      <children id="90"/>
-      <location class="Point2D.Double" id="91" x="110.0" y="400.0"/>
-      <id id="92" value="1134dbf0-087e-4c9b-be7a-6157bb10ebf0"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="93" justification="1" size="3" underlined="false">
-        <text>OBIBool_t
-</text>
-      </name>
-      <attributes id="94" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="95" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-    <ClassNode id="96">
-      <children id="97"/>
-      <location class="Point2D.Double" id="98" x="330.0" y="400.0"/>
-      <id id="99" value="a78dbab0-8879-4149-b5c9-aed41e7da0bb"/>
-      <revision>1</revision>
-      <backgroundColor reference="7"/>
-      <borderColor reference="8"/>
-      <textColor reference="8"/>
-      <name id="100" justification="1" size="3" underlined="false">
-        <text>OBIChar_t</text>
-      </name>
-      <attributes id="101" justification="0" size="4" underlined="false">
-        <text></text>
-      </attributes>
-      <methods id="102" justification="0" size="4" underlined="false">
-        <text></text>
-      </methods>
-    </ClassNode>
-  </nodes>
-  <edges id="103">
-    <InheritanceEdge id="104">
-      <start class="ClassNode" reference="12"/>
-      <end class="ClassNode" reference="3"/>
-      <startLocation class="Point2D.Double" id="105" x="50.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="106" x="70.0" y="40.0"/>
-      <transitionPoints id="107"/>
-      <id id="108" value="debdd86e-d072-4413-9d4c-dcabf70e44f9"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="109">
-      <start class="ClassNode" reference="19"/>
-      <end class="ClassNode" reference="3"/>
-      <startLocation class="Point2D.Double" id="110" x="90.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="111" x="20.0" y="50.0"/>
-      <transitionPoints id="112"/>
-      <id id="113" value="1491704a-dd29-47dc-92e4-2b53c62fd634"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="114">
-      <start class="ClassNode" reference="47"/>
-      <end class="ClassNode" reference="19"/>
-      <startLocation class="Point2D.Double" id="115" x="70.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="116" x="40.0" y="40.0"/>
-      <transitionPoints id="117"/>
-      <id id="118" value="8475a565-b6dd-404b-8dd3-07f89b3a2853"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="119">
-      <start class="ClassNode" reference="54"/>
-      <end class="ClassNode" reference="19"/>
-      <startLocation class="Point2D.Double" id="120" x="60.0" y="20.0"/>
-      <endLocation class="Point2D.Double" id="121" x="80.0" y="40.0"/>
-      <transitionPoints id="122"/>
-      <id id="123" value="a8696d02-b718-4800-bacb-d076aa2ed3ce"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="124">
-      <start class="ClassNode" reference="68"/>
-      <end class="ClassNode" reference="54"/>
-      <startLocation class="Point2D.Double" id="125" x="50.0" y="20.0"/>
-      <endLocation class="Point2D.Double" id="126" x="40.0" y="30.0"/>
-      <transitionPoints id="127"/>
-      <id id="128" value="4c4010cd-e981-4051-8cf6-a28ebc154bc7"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="129">
-      <start class="ClassNode" reference="61"/>
-      <end class="ClassNode" reference="54"/>
-      <startLocation class="Point2D.Double" id="130" x="50.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="131" x="80.0" y="50.0"/>
-      <transitionPoints id="132"/>
-      <id id="133" value="b99845fa-28f7-4625-9228-313aa4a9cd17"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="134">
-      <start class="ClassNode" reference="26"/>
-      <end class="ClassNode" reference="12"/>
-      <startLocation class="Point2D.Double" id="135" x="50.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="136" x="50.0" y="50.0"/>
-      <transitionPoints id="137"/>
-      <id id="138" value="3410cc22-8aee-4667-9dcf-8f24edfe9ce2"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="139">
-      <start class="ClassNode" reference="33"/>
-      <end class="ClassNode" reference="12"/>
-      <startLocation class="Point2D.Double" id="140" x="60.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="141" x="70.0" y="50.0"/>
-      <transitionPoints id="142"/>
-      <id id="143" value="0316447c-b7b7-480a-80cd-87d66ab6452b"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="144">
-      <start class="ClassNode" reference="40"/>
-      <end class="ClassNode" reference="12"/>
-      <startLocation class="Point2D.Double" id="145" x="50.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="146" x="90.0" y="50.0"/>
-      <transitionPoints id="147"/>
-      <id id="148" value="d995fa9f-7a1d-4340-b519-d29256c972ce"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="149">
-      <start class="ClassNode" reference="82"/>
-      <end class="ClassNode" reference="47"/>
-      <startLocation class="Point2D.Double" id="150" x="60.0" y="20.0"/>
-      <endLocation class="Point2D.Double" id="151" x="30.0" y="20.0"/>
-      <transitionPoints id="152"/>
-      <id id="153" value="cdf54d62-5b64-46ab-8fdc-ee0184ea9a43"/>
-      <revision>1</revision>
-      <bentStyle name="STRAIGHT"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="154">
-      <start class="ClassNode" reference="89"/>
-      <end class="ClassNode" reference="47"/>
-      <startLocation class="Point2D.Double" id="155" x="80.0" y="20.0"/>
-      <endLocation class="Point2D.Double" id="156" x="20.0" y="30.0"/>
-      <transitionPoints id="157"/>
-      <id id="158" value="9d2d9603-b709-499b-8357-4d844bfa227d"/>
-      <revision>1</revision>
-      <bentStyle name="STRAIGHT"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="159">
-      <start class="ClassNode" reference="75"/>
-      <end class="ClassNode" reference="47"/>
-      <startLocation class="Point2D.Double" id="160" x="50.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="161" x="70.0" y="50.0"/>
-      <transitionPoints id="162"/>
-      <id id="163" value="4c3e06c4-c978-410f-8925-32a64eea92f8"/>
-      <revision>1</revision>
-      <bentStyle name="STRAIGHT"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <InheritanceEdge id="164">
-      <start class="ClassNode" reference="96"/>
-      <end class="ClassNode" reference="47"/>
-      <startLocation class="Point2D.Double" id="165" x="20.0" y="10.0"/>
-      <endLocation class="Point2D.Double" id="166" x="90.0" y="50.0"/>
-      <transitionPoints id="167"/>
-      <id id="168" value="37c12090-8ace-4fbe-b7f9-e86eb9bf2805"/>
-      <revision>1</revision>
-      <bentStyle name="STRAIGHT"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </InheritanceEdge>
-    <CompositionEdge id="169">
-      <start class="ClassNode" reference="12"/>
-      <end class="ClassNode" reference="19"/>
-      <startLocation class="Point2D.Double" id="170" x="10.0" y="50.0"/>
-      <endLocation class="Point2D.Double" id="171" x="70.0" y="20.0"/>
-      <transitionPoints id="172"/>
-      <id id="173" value="7df9ed88-49f1-4828-9f45-b9d693d877aa"/>
-      <revision>1</revision>
-      <bentStyle name="AUTO"/>
-      <startLabel></startLabel>
-      <middleLabel></middleLabel>
-      <endLabel></endLabel>
-    </CompositionEdge>
-  </edges>
-</ClassDiagramGraph>]]></SCRIPT>
-	<BR />
-	<BR />
-	<IMG alt="embedded diagram image" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA/cAAAGzCAIAAADlsnDLAABO0UlEQVR42u29f1SUdd7/n4g/CtQR
-JyNFIJt0TFI0LNab7tDo3HTfbk1F5+akJpvUsh02qWilo7u2sa4VZ6PiVjY5yWlpmy1W2RZbtjwt
-3WFZsbtkeKvBETbxNCIp50gL6Yh+Xuv7eH3nO78YmBnm1+PxB2fm4vr5vF7X+/24Zq65rssuAAAA
-2HAZDAcKBgCCtDEnAgAAsLN8QiArAMDyAQAAcyUrAAAsHwAAMFeyAgDA8gEAAHMNzqy+uARpAACW
-DwAAWD6WDwCA5QMAAJaP5QMAYPkAAIDlY/kAgOUDAABg+Vg+AGD5AACA5WP5WD4AYPkAAIDlY/kA
-AFg+AABg+Vg+AACWDwAAWD6WDwA0UEQAAABYPpYPAFg+AABg+YDlAwCWDwAAWD6WDwCA5QMAAJaP
-5QMAYPkAAIDlY/kAAFg+AABg+Vg+AGD5AACA5QOWDwBYPgAAYPlYPgAAlg8AAFg+lg8AgOUDAACW
-j+UDAGD5AACA5WP5AIDlAwBA2NHV1eUnyz9//nxHR4eb+UeC5VssFmoMALB8AAAIgJ6WlZUNDAz4
-0PLPnDmzadOmmJiYqKgomUlcXNzLL788ODio/nvllVdedpFZs2atXr36m2++0YYnJCTIi2uuueYy
-Z3z55Zd+CuHs2bP+sPyamhq+DwEALB8AAAJj+UVFRQaDwWw2W61Wn1j+I488ItOWlJScPn365MmT
-a9askbfPPvusZvMLFy5sbm5+7LHHZPiGDRvsLL+jo+PwRRYvXiwjtLS0qLfeu7hTli5dOmPGDN9a
-fnt7e1ZWlslkwvIBAMsHAIDAWL6yUlHS9PT0pqYmLy3/yJEjUVFRkydPPnfunBrS09MzZsyYK664
-oq+vT9n8zTffLC/eeecdWcRzzz1nZ/kaGRkZMsK3336r3q5bt85oNB48eFC9ffLJJ+X8RGn6XXfd
-tWPHjqSkpOTk5D/84Q9qhAMHDtx6662xsbELFiz4+OOPna6tnHuMHz8+Ojpa5rx3716fWH5paamc
-NdXV1V3gtw0AgOUDAEAALV8hip+Wlia6L9I/YkPdtWuXTHjnnXfaDly0aJEMbG5uVjY/e/bszZs3
-y9+cnJxTp055aPlvvPGGvP3pT38qr3t7e+W0Yc+ePWrCKVOmyClKfn7+uHHjrr76ahkoU82YMeP6
-66/fvXt3ampqYmKidsmQLa2trbNmzZo6daqsdnd3tzcxyqxkJvPnz5dzD1k9b86UAACwfAAA8Jnl
-K2pqagwGg6jqyAx169at6nId24H333+/DKyvr1dSPmHChJiYGL1ebzabz58/76Hlywsx++uuu05e
-v/TSS+LT2oQzZ85Uo6kFHThw4M0335QXzzzzTE9Pz4YNG+T1/v37na6wnAmoEwNvkFXNy8uTMw11
-JuMmXgAALB8AAJx7uW9xXIQI8eTJk+VfnZ2dw109dR3OsmXLbAfOnj1bfdp94dIVOwMDAy+88IIM
-XLdunYeWL+Tm5qrvBIxG4yuvvKJNuGDBAvW6tLRURvjd7373/PPPy4tx48ZNuIT64N8fli8pybLm
-zJnj+CPmy8IXjkQALB8AAHxs+X6dW0NDQ0pKyqpVq0a2IIvFoqxaU96vvvpKZjVt2jQ1RLsuf3Bw
-cMqUKXFxcerjfE8s/+2335YhMrlM1d/f72j5q1evlhGOHj2qLu8pLi4ecoXF8qdPn+59jMuXL7/p
-ppsOHDjgv50VrkUIAFg+AAD40fJbWlqys7OzsrLkhTcLeuqpp2TalStXdnV1tbW13X777fJ227Zt
-mpQbjca33npr3bp1So614UNa/pkzZ6ZOnSoD169frw2UCSdNmlRdXf3hhx/K67lz58rAkydPynmF
-nAy8/vrrHR0ddXV1siZO11bWU2bY1NSknTaMLMYvvvjixRdfTExM3Lhxo3aGg+UDAJYPAAABs3zR
-8fz8/NTU1Pr6eu1+miNe0Llz5zZv3hwTE6Mu7RDbrqqqspVyNVx8/d577/3ss888t3xB1jM6Ovro
-0aO2M5w5c+aSJUtkZJ1Op67+F0T65XRCLWv69Onvv/++07Xdu3evnBjIONu3b/fS8oVPPvmkqKhI
-lqsuEMLyAQDLBwCAwFj+xo0bDQZDZWWlr+6XrxgcHGxra/P5s2+XLVt233332Q7Rrtjp7u7Wbt+p
-cerUKe2ON26QabXfAXtj+ep++c3NzWlpaSO+6gnLBwAsHwAAy/d2biUlJU49OAhNbseOHbJWdje2
-t70u3z1zHfBhjHbPvpVTpvLyciwfALB8AAAIgGC5+aw9CE3ugw8+2L17t93AP/3pT3/5y188mdzi
-gP8sX1siRQgAWD4AAASRYGFy3ls+RQgAWD4AAGD5WD5FCABYPgAAlo/JYflYPgBg+QAACBYmh+VT
-GwBYPgAAYPmA5VMbAFg+AABg+Vg+RQgAWD4AAGD5WD5FCABYPgAAlo/JYflYPgBg+QAACBYmh+VT
-GwBYPgAAIFiYHJZPbQBg+QAAgOVj+Vg+AGD5AACA5WP5FCEAYPkAAIDlY/lYPgBg+QAACBYmh+VT
-GwBYPgAAIFiYHJZPbQBg+QAAgOUDlg8AWD4AAGD5WD5FCABYPgAAYPlYPpYPAFg+AACChclh+dQG
-AGD5AAAIFiaH5VMbAFg+AABg+YDlAwCWDwAAWD6WTxECAJYPAABYPpaP5QMAlg8AgGD5dEHgOVg+
-AGD5AAAQYoL1BXgMRQgAWD4AAGD5WD5FCABYPgAA7TWWj+Vj+QCA5QMAIFgAFCEAlg8AAAgWAEUI
-gOUDAACCBRQhAGD5AACAYAFFCABYPgAAIFhAEQIAlg8AgGABUIQAHLBEAACAYAFQhE63FzyHAwTL
-BwAABAsoQraXrADLBwAAOlGgCNlesgIsHwCAThSAImR7yQrLBwAAOlEAipCDbuRZfXEJ0sDyAQAA
-4QCKkO3F8gHLBwBAsAAoQrYXywcsHwAA4QCgCNleLB/LBwAAhAOAIuSgw/KxfAAAQDiAImR7sXws
-H8sHgFFrcyGcnviIcADWy/Zi+YDlAwD9U7jlzA4FWhW2F8sHLB8A6J+wfACKkO3F8rF8AKB/Aiwf
-gCLkoMPysXwAoH+C0ezb2KFAq8L20hIClg8A9E9YPgBFyPZi+Vg+ANA/AZYPQBFy0GH5WD4A0D8B
-lg+0KmwvYPlYPgDQP9G3sUOBVoXtpSUELB8A6J/o29ihQKvC9tISApYPAPRPWD6A/4qQJ1sDlo/l
-AwCWT9/GDgWgFaUlBCwfAOif6NvYoQC0orSEgOUDAP0Tlg8AHHRYPmD5APRPgOUDwAgPuvPnz3d0
-dHR1dY14njKHY8eOHTx48PTp035d+cbGxo8//hjLx/IBAMsHLB8AXB50Z86c2bRpU0xMTFRUlAyP
-i4t7+eWXBwcH1X+vvPJK9WvdWbNmrV69+ptvvtGGJyQkqNf9/f0/+9nPJk2aJKONHTtW/ur1+hGv
-29mzZ92PIItesGCBn5JxXDqWj+UDAJaP5bNDAUKvFX3kkUfkbUlJyenTp0+ePLlmzRp5++yzz2pK
-vXDhwubm5scee0yGb9iwwdHy165dK/+S+Rw/ftxqte7fv/+1114b2YotXbp0xowZ7sc5duzY119/
-7Y9YnC4dy8fyAQDLx/LZoQAh1ooeOXIkKipq8uTJ586dU0N6enrGjBlzxRVX9PX1KZu/+eab5cU7
-77wjUz333HN2lt/W1ibjz58///z5844Lkv9mZ2dPmTIlMTGxuLh4YGBA8+m77rpr165dc+bMWbJk
-yWeffSYD5dRi/Pjx0dHRRqNx7969MuSHP/zhDTfcMHXq1LvvvltriNS0buYjHDhw4NZbb42NjV2w
-YIF2eY8a+dVXX501a9bnn39ut6qOS8fysXwAwPKxfHYoQEi2ouLH8vrOO++0/e+iRYtkYHNzs7L5
-2bNnb968Wf7m5OScOnXKzvJ37twpIz/66KOOS+nv7xe5j4uLq66uLiwslNHkrza5TqdLSUkpKCiQ
-4bm5uTKwtbVV/FucXtaqu7v7wsXvGeT1u+++e/nll99///3atNoVO07n8+23386YMeP666/fvXt3
-amqqrIO6AElGlvMN2ZC1a9d2dHTYra3j0rF8LB8AsHwsnx0KEJKt6NatW9XlOrb/FZ+WgfX19cqM
-J0yYEBMTo9frzWaz9oG9ZvlO56Cora2Vf4l/X7j421zR/fHjx6svDWRyeasuvLnqqquuvfZaNYmo
-+dVXX203H3FukXXtWho7y3ecz5tvvinLfeaZZ3p6ejZs2CCv9+/fr0aWrbBYLK5icbp0LB/LBwAs
-Pwxz5jGcAOHdiqrrcJYtW2b739mzZ8vA1tbWC5eu2BkYGHjhhRdk4Lp16+wsf/fu3TJ88eLFjkt5
-/vnn5V+VlZXqbWZmprw9evSonanPvoijZw8ODq5fv37evHmXX375uHHjtOF2lu84H7VcmWTCJfbs
-2XPBg5/tYvlYPgBg+ZGSM30bQHi3ohaLRXmwdsX8V199Jf+dNm2aGqJdly/OPWXKlLi4OPVxvmb5
-x44dE5+WSRzvwllTUyPDn3jiCfU2KSkpKirqu+++c2/506dPV69/+9vfql8CWK3WjIwMzy3/jTfe
-kAmLi4vt1scTy9eWTkuI5QMAlo/lA0AIt6JPPfWUvF25cqVoeltb2+233y5vt23bppmx0Wh86623
-1q1bJ8OXL1+uDdfusSMeL/+68cYb33//fTlJkJEffvjhb7/9tru7W10HL22I2WyWcbRfzbqyfFkN