Move things for release v0.2

CNR-Engineering · Oct 13, 2017 · 3a35618 · 3a35618
1 parent 051e3e9
commit 3a35618
Show file tree

Hide file tree

Showing 67 changed files with 35 additions and 13 deletions.
diff --git a/LICENSE → LICENSE.txt b/LICENSE → LICENSE.txt
diff --git a/conf/settings.py → PyTelTools/conf/settings.py b/conf/settings.py → PyTelTools/conf/settings.py
diff --git a/conf/settings_sample.py → PyTelTools/conf/settings_sample.py b/conf/settings_sample.py → PyTelTools/conf/settings_sample.py
diff --git a/geom/BlueKenue.py → PyTelTools/geom/BlueKenue.py b/geom/BlueKenue.py → PyTelTools/geom/BlueKenue.py
diff --git a/geom/Shapefile.py → PyTelTools/geom/Shapefile.py b/geom/Shapefile.py → PyTelTools/geom/Shapefile.py
diff --git a/geom/__init__.py → PyTelTools/geom/__init__.py b/geom/__init__.py → PyTelTools/geom/__init__.py
diff --git a/geom/conversion.py → PyTelTools/geom/conversion.py b/geom/conversion.py → PyTelTools/geom/conversion.py
diff --git a/geom/geometry.py → PyTelTools/geom/geometry.py b/geom/geometry.py → PyTelTools/geom/geometry.py
diff --git a/geom/transformation.py → PyTelTools/geom/transformation.py b/geom/transformation.py → PyTelTools/geom/transformation.py
diff --git a/gui/CalculatorGUI.py → PyTelTools/gui/CalculatorGUI.py b/gui/CalculatorGUI.py → PyTelTools/gui/CalculatorGUI.py
diff --git a/gui/CompareResultsGUI.py → PyTelTools/gui/CompareResultsGUI.py b/gui/CompareResultsGUI.py → PyTelTools/gui/CompareResultsGUI.py
diff --git a/gui/ComputeFluxGUI.py → PyTelTools/gui/ComputeFluxGUI.py b/gui/ComputeFluxGUI.py → PyTelTools/gui/ComputeFluxGUI.py
diff --git a/gui/ComputeVolumeGUI.py → PyTelTools/gui/ComputeVolumeGUI.py b/gui/ComputeVolumeGUI.py → PyTelTools/gui/ComputeVolumeGUI.py
diff --git a/gui/ConfigTransformation.py → PyTelTools/gui/ConfigTransformation.py b/gui/ConfigTransformation.py → PyTelTools/gui/ConfigTransformation.py
diff --git a/gui/ExtractVariablesGUI.py → PyTelTools/gui/ExtractVariablesGUI.py b/gui/ExtractVariablesGUI.py → PyTelTools/gui/ExtractVariablesGUI.py
diff --git a/gui/GeometryConverterGUI.py → PyTelTools/gui/GeometryConverterGUI.py b/gui/GeometryConverterGUI.py → PyTelTools/gui/GeometryConverterGUI.py
diff --git a/gui/LinesGUI.py → PyTelTools/gui/LinesGUI.py b/gui/LinesGUI.py → PyTelTools/gui/LinesGUI.py
diff --git a/gui/MainWindow.py → PyTelTools/gui/MainWindow.py b/gui/MainWindow.py → PyTelTools/gui/MainWindow.py
diff --git a/gui/MaxMinMeanGUI.py → PyTelTools/gui/MaxMinMeanGUI.py b/gui/MaxMinMeanGUI.py → PyTelTools/gui/MaxMinMeanGUI.py
diff --git a/gui/PointsGUI.py → PyTelTools/gui/PointsGUI.py b/gui/PointsGUI.py → PyTelTools/gui/PointsGUI.py
diff --git a/gui/ProjectLinesGUI.py → PyTelTools/gui/ProjectLinesGUI.py b/gui/ProjectLinesGUI.py → PyTelTools/gui/ProjectLinesGUI.py
diff --git a/gui/ProjectMeshGUI.py → PyTelTools/gui/ProjectMeshGUI.py b/gui/ProjectMeshGUI.py → PyTelTools/gui/ProjectMeshGUI.py
diff --git a/gui/__init__.py → PyTelTools/gui/__init__.py b/gui/__init__.py → PyTelTools/gui/__init__.py
diff --git a/gui/util.py → PyTelTools/gui/util.py b/gui/util.py → PyTelTools/gui/util.py
diff --git a/main_interface.py → PyTelTools/main_interface.py b/main_interface.py → PyTelTools/main_interface.py
diff --git a/outil_carto.py → PyTelTools/outil_carto.py b/outil_carto.py → PyTelTools/outil_carto.py
diff --git a/slf/Serafin.py → PyTelTools/slf/Serafin.py b/slf/Serafin.py → PyTelTools/slf/Serafin.py
diff --git a/slf/__init__.py → PyTelTools/slf/__init__.py b/slf/__init__.py → PyTelTools/slf/__init__.py
diff --git a/slf/comparison.py → PyTelTools/slf/comparison.py b/slf/comparison.py → PyTelTools/slf/comparison.py
diff --git a/slf/data/Serafin_var2D.csv → PyTelTools/slf/data/Serafin_var2D.csv b/slf/data/Serafin_var2D.csv → PyTelTools/slf/data/Serafin_var2D.csv
diff --git a/slf/data/Serafin_var3D.csv → PyTelTools/slf/data/Serafin_var3D.csv b/slf/data/Serafin_var3D.csv → PyTelTools/slf/data/Serafin_var3D.csv
diff --git a/slf/data/landxml_to_tin.py → PyTelTools/slf/data/landxml_to_tin.py b/slf/data/landxml_to_tin.py → PyTelTools/slf/data/landxml_to_tin.py
diff --git a/slf/data/mxd_to_png.py → PyTelTools/slf/data/mxd_to_png.py b/slf/data/mxd_to_png.py → PyTelTools/slf/data/mxd_to_png.py
diff --git a/slf/datatypes.py → PyTelTools/slf/datatypes.py b/slf/datatypes.py → PyTelTools/slf/datatypes.py
diff --git a/slf/expression/__init__.py → PyTelTools/slf/expression/__init__.py b/slf/expression/__init__.py → PyTelTools/slf/expression/__init__.py
diff --git a/slf/expression/condition.py → PyTelTools/slf/expression/condition.py b/slf/expression/condition.py → PyTelTools/slf/expression/condition.py
diff --git a/slf/expression/expression.py → PyTelTools/slf/expression/expression.py b/slf/expression/expression.py → PyTelTools/slf/expression/expression.py
diff --git a/slf/expression/pool.py → PyTelTools/slf/expression/pool.py b/slf/expression/pool.py → PyTelTools/slf/expression/pool.py
diff --git a/slf/flux.py → PyTelTools/slf/flux.py b/slf/flux.py → PyTelTools/slf/flux.py
diff --git a/slf/interpolation.py → PyTelTools/slf/interpolation.py b/slf/interpolation.py → PyTelTools/slf/interpolation.py
diff --git a/slf/mesh2D.py → PyTelTools/slf/mesh2D.py b/slf/mesh2D.py → PyTelTools/slf/mesh2D.py
diff --git a/slf/misc.py → PyTelTools/slf/misc.py b/slf/misc.py → PyTelTools/slf/misc.py
diff --git a/slf/variable/__init__.py → PyTelTools/slf/variable/__init__.py b/slf/variable/__init__.py → PyTelTools/slf/variable/__init__.py
diff --git a/slf/variable/variables_2d.py → PyTelTools/slf/variable/variables_2d.py b/slf/variable/variables_2d.py → PyTelTools/slf/variable/variables_2d.py
diff --git a/slf/variable/variables_3d.py → PyTelTools/slf/variable/variables_3d.py b/slf/variable/variables_3d.py → PyTelTools/slf/variable/variables_3d.py
diff --git a/slf/variable/variables_utils.py → PyTelTools/slf/variable/variables_utils.py b/slf/variable/variables_utils.py → PyTelTools/slf/variable/variables_utils.py
diff --git a/slf/variables.py → PyTelTools/slf/variables.py b/slf/variables.py → PyTelTools/slf/variables.py
diff --git a/slf/volume.py → PyTelTools/slf/volume.py b/slf/volume.py → PyTelTools/slf/volume.py
diff --git a/tests/__init__.py → PyTelTools/tests/__init__.py b/tests/__init__.py → PyTelTools/tests/__init__.py
diff --git a/tests/test_flux.py → PyTelTools/tests/test_flux.py b/tests/test_flux.py → PyTelTools/tests/test_flux.py
diff --git a/tests/test_variables.py → PyTelTools/tests/test_variables.py b/tests/test_variables.py → PyTelTools/tests/test_variables.py
diff --git a/tests/test_volume.py → PyTelTools/tests/test_volume.py b/tests/test_volume.py → PyTelTools/tests/test_volume.py
diff --git a/workflow/MultiNode.py → PyTelTools/workflow/MultiNode.py b/workflow/MultiNode.py → PyTelTools/workflow/MultiNode.py
diff --git a/workflow/Node.py → PyTelTools/workflow/Node.py b/workflow/Node.py → PyTelTools/workflow/Node.py
diff --git a/workflow/__init__.py → PyTelTools/workflow/__init__.py b/workflow/__init__.py → PyTelTools/workflow/__init__.py
diff --git a/workflow/interface.py → PyTelTools/workflow/interface.py b/workflow/interface.py → PyTelTools/workflow/interface.py
diff --git a/workflow/mono_gui.py → PyTelTools/workflow/mono_gui.py b/workflow/mono_gui.py → PyTelTools/workflow/mono_gui.py
diff --git a/workflow/multi_func.py → PyTelTools/workflow/multi_func.py b/workflow/multi_func.py → PyTelTools/workflow/multi_func.py
diff --git a/workflow/multi_gui.py → PyTelTools/workflow/multi_gui.py b/workflow/multi_gui.py → PyTelTools/workflow/multi_gui.py
diff --git a/workflow/multi_nodes.py → PyTelTools/workflow/multi_nodes.py b/workflow/multi_nodes.py → PyTelTools/workflow/multi_nodes.py
diff --git a/workflow/nodes_calc.py → PyTelTools/workflow/nodes_calc.py b/workflow/nodes_calc.py → PyTelTools/workflow/nodes_calc.py
diff --git a/workflow/nodes_io.py → PyTelTools/workflow/nodes_io.py b/workflow/nodes_io.py → PyTelTools/workflow/nodes_io.py
diff --git a/workflow/nodes_op.py → PyTelTools/workflow/nodes_op.py b/workflow/nodes_op.py → PyTelTools/workflow/nodes_op.py
diff --git a/workflow/nodes_vis.py → PyTelTools/workflow/nodes_vis.py b/workflow/nodes_vis.py → PyTelTools/workflow/nodes_vis.py
diff --git a/workflow/util.py → PyTelTools/workflow/util.py b/workflow/util.py → PyTelTools/workflow/util.py
diff --git a/README.md b/README.md
@@ -5,49 +5,53 @@ Python Telemac Tools
 * [Developer documentation](https://cnr-engineering.github.io/PyTelTools) ([repository with static files](https://github.com/CNR-Engineering/CNR-Engineering.github.io))
 
 ## Installation and requirements
-It relies on Python3 and requires packages which are listed in [requirements.txt](https://github.com/CNR-Engineering/PyTelTools/blob/master/requirements.txt).
+PyTelTools relies on Python3 and requires packages which are listed in [requirements.txt](https://github.com/CNR-Engineering/PyTelTools/blob/master/requirements.txt).
 
-Packages installation can be done with pip:
+### Installation via pip
+Packages installation can be done with **pip**:
 ```bash
-$ pip install -r requirements.txt
+# user install
+$ pip install -e git://github.com/CNR-Engineering/PyTelTools.git#egg=PyTelTools --user
+# default install (needs to be root)
+# pip install -e git://github.com/CNR-Engineering/PyTelTools.git#egg=PyTelTools
 ```
 
-### Virtualenv
-The use of isolated Python environments is possible through virtualenv:
+### Installation in a virtual environnement
+The use of isolated Python environments is possible through **virtualenv**:
 ```bash
 $ virtualenv venv --python=python3
 $ source venv/bin/activate
-(venv) $ pip install -r requirements.txt --upgrade
+(venv) $ pip install -e git://github.com/CNR-Engineering/PyTelTools.git#egg=PyTelTools
 ```
 
 ## Usage
 
 ### Open interface
 ```bash
-$ python main_interface.py
-$ python outil_carto.py
+$ python PyTelTools/main_interface.py
+$ python PyTelTools/outil_carto.py
 ```
 
 ### Use command line for workflow
 **Load** a workflow project file in the **GUI** (in mono tab):
 ```bash
-$ python workflow/interface.py -i path_to_workflow_project_file.txt
+$ python PyTelTools/workflow/interface.py -i path_to_workflow_project_file.txt
 ```
 
 **Load** and **run** a workflow project from the **command line**:
 ```bash
-$ python workflow/mono_gui.py -i path_to_workflow_project_file.txt
-$ python workflow/multi_gui.py -i path_to_workflow_project_file.txt
+$ python PyTelTools/workflow/mono_gui.py -i path_to_workflow_project_file.txt
+$ python PyTelTools/workflow/multi_gui.py -i path_to_workflow_project_file.txt
 ```
 
 The argument `-h` provides a **help** message for the corresponding script and specify its **usage**.
 Output **verbosity** can be increased (debug mode) with `-v` argument.
 
 ## Configure
-Modify `conf/settings.py` to change default parameters.
+Modify `PyTelTools/conf/settings.py` to change default parameters.
 
 For example to change default Serafin language (for variable detection)
-and to change increase verbosity write this in `conf/settings.py`:
+and to change increase verbosity write this in `PyTelTools/conf/settings.py`:
 ```python
 from conf.settings_sample import *
 

diff --git a/setup.py b/setup.py
@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+
+from setuptools import setup
+
+
+with open('requirements.txt') as f:
+    requirements = f.read().splitlines()
+
+setup(
+    name='PyTelTools',
+    version='0.2',
+    author='Luc Duron',
+    author_email='[email protected]',
+    py_modules=['PyTelTools'],
+    install_requires=requirements,
+    description='Python library for Telemac post-processing tasks',
+    url='https://github.com/CNR-Engineering/PyTelTools',
+)