summaryrefslogtreecommitdiff
path: root/base_geoengine/doc/build/_sources
diff options
context:
space:
mode:
authorRichard Sassine <richardsassine@tutanota.com>2021-05-31 19:22:23 +0300
committerRichard Sassine <richardsassine@tutanota.com>2021-05-31 19:22:23 +0300
commit3a8776ee0342f47a57bcc9365499ebd5d3d7ee1c (patch)
tree9515fcef8e53992a9bbbcdc7950e1dd596983166 /base_geoengine/doc/build/_sources
parent9d3eeeb5c7d4055b34bc0768387952850ed78668 (diff)
added geoengine
Diffstat (limited to 'base_geoengine/doc/build/_sources')
-rw-r--r--base_geoengine/doc/build/_sources/_templates/prerequisite.txt3
-rw-r--r--base_geoengine/doc/build/_sources/api_doc.txt63
-rw-r--r--base_geoengine/doc/build/_sources/index.txt31
-rw-r--r--base_geoengine/doc/build/_sources/installation.txt39
-rw-r--r--base_geoengine/doc/build/_sources/postgisify.txt13
-rw-r--r--base_geoengine/doc/build/_sources/prerequisite.txt30
-rw-r--r--base_geoengine/doc/build/_sources/what_is_geoengine.txt16
7 files changed, 195 insertions, 0 deletions
diff --git a/base_geoengine/doc/build/_sources/_templates/prerequisite.txt b/base_geoengine/doc/build/_sources/_templates/prerequisite.txt
new file mode 100644
index 0000000..96775bb
--- /dev/null
+++ b/base_geoengine/doc/build/_sources/_templates/prerequisite.txt
@@ -0,0 +1,3 @@
+=================
+Prerequisite
+=================
diff --git a/base_geoengine/doc/build/_sources/api_doc.txt b/base_geoengine/doc/build/_sources/api_doc.txt
new file mode 100644
index 0000000..56c5af9
--- /dev/null
+++ b/base_geoengine/doc/build/_sources/api_doc.txt
@@ -0,0 +1,63 @@
+======
+API
+======
+
+***********
+GeoColumns
+***********
+.. automodule:: base_geoengine.geo_field
+ :members:
+
+.. automodule:: base_geoengine.geo_point
+ :members:
+
+.. automodule:: base_geoengine.geo_line
+ :members:
+
+.. automodule:: base_geoengine.geo_multiline
+ :members:
+
+.. automodule:: base_geoengine.geo_polygon
+ :members:
+
+.. automodule:: base_geoengine.geo_multipolygon
+ :members:
+
+****************
+View Management
+****************
+
+.. automodule:: base_geoengine.geo_view
+ :members:
+
+.. automodule:: base_geoengine.geo_view.geo_raster_layer
+ :members:
+
+.. automodule:: base_geoengine.geo_view.geo_vector_layer
+ :members:
+
+.. automodule:: base_geoengine.geo_view.ir_view
+ :members:
+
+**************
+GEO ORM MODEL
+**************
+.. autoclass:: base_geoengine.geo_model.GeoModel
+ :members:
+
+******************
+GEO ORM OPERATORS
+******************
+
+.. automodule:: base_geoengine.geo_operators
+ :members:
+
+.. autoclass:: base_geoengine.geo_operators.GeoOperator
+ :members:
+
+***********
+GEO helper
+***********
+
+.. automodule:: base_geoengine.geo_helper.geo_convertion_helper
+ :members:
diff --git a/base_geoengine/doc/build/_sources/index.txt b/base_geoengine/doc/build/_sources/index.txt
new file mode 100644
index 0000000..5d7683b
--- /dev/null
+++ b/base_geoengine/doc/build/_sources/index.txt
@@ -0,0 +1,31 @@
+.. OpenERP GeoEngine documentation master file, created by
+ sphinx-quickstart on Mon Mar 5 09:15:25 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to OpenERP GeoEngine's documentation!
+=============================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ what_is_geoengine
+ prerequisite
+ installation
+ postgisify
+ api_doc
+
+ How to use GeoEngine
+ Modules presentations
+ API presentation
+ Manage your layer from client
+ Create a geocolumn from client
+
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/base_geoengine/doc/build/_sources/installation.txt b/base_geoengine/doc/build/_sources/installation.txt
new file mode 100644
index 0000000..d96eea0
--- /dev/null
+++ b/base_geoengine/doc/build/_sources/installation.txt
@@ -0,0 +1,39 @@
+=================
+Installation
+=================
+
+
+***************************
+PostGIS database template
+***************************
+
+In order to create databases from the OpenERP client, you have to create a PostGis database template.
+Under windows, this template is already available in installer.
+
+On other *NIX, system you simply have to launch the create_postgis_template.sh script available in the base_geoengine module in the scripts folder.
+This should be done by a PostgreSQL superuser.
+
+In order to test the success::
+
+ psql -l
+ template_postgis | owner | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
+
+
+If you want to install GeoEngine on an exisiting database, please refer to the Postgisify section.
+
+***************
+OpenERP
+***************
+
+Add the template as an argument to OpenERP server::
+
+ --db-template=template_postgis
+
+or in config file::
+
+ db_template = template_postgis
+
+
+Do not forget to add the GeoEngine modules to your addons path.
+
+Then install (eventually update module list) the base GeoEngine module form the OpenERP client.
diff --git a/base_geoengine/doc/build/_sources/postgisify.txt b/base_geoengine/doc/build/_sources/postgisify.txt
new file mode 100644
index 0000000..a54afe1
--- /dev/null
+++ b/base_geoengine/doc/build/_sources/postgisify.txt
@@ -0,0 +1,13 @@
+*********************************
+Postgisify an exisiting database
+*********************************
+
+If you want to install the GeoEngine on an existing database, you have to run the sql commands available in the base_geoengine module under the postgis_sql folder using a PostgreSQL super user::
+
+ psql -U superuser my database -f postgis.sql
+ psql -U superuser my database -f spatial_ref_sys.sql
+
+In order to test if the installation is sucessfull log into you database and::
+
+ SELECT * from GEOMETRY_COLUMNS;
+ SELECT * from spatial_ref_sys;
diff --git a/base_geoengine/doc/build/_sources/prerequisite.txt b/base_geoengine/doc/build/_sources/prerequisite.txt
new file mode 100644
index 0000000..8001d0a
--- /dev/null
+++ b/base_geoengine/doc/build/_sources/prerequisite.txt
@@ -0,0 +1,30 @@
+=================
+Prerequisites
+=================
+***************
+Python
+***************
+geojson:
+
+::
+
+ pip install geojson
+
+Shapely:
+
+::
+
+ pip install Shapely==1.2.13
+
+For Mac user: do not forget the following directive:
+
+::
+
+ ARCHFLAGS="-arch i386 -arch x86_64"
+
+
+***************
+PostGIS 1.5
+***************
+
+Please refer to `PostGIS installation directive <http://postgis.refractions.net/docs/>`_ or to your OS package system.
diff --git a/base_geoengine/doc/build/_sources/what_is_geoengine.txt b/base_geoengine/doc/build/_sources/what_is_geoengine.txt
new file mode 100644
index 0000000..cb64b8c
--- /dev/null
+++ b/base_geoengine/doc/build/_sources/what_is_geoengine.txt
@@ -0,0 +1,16 @@
+===================
+What is GeoEngine ?
+===================
+
+GeoEngine is an OpenERP module that adds spatial/GIS capabilites to OpenERP. It will allow you to :
+
+* Visualize and query your business information on map
+* Perform GeoBI and spatial query
+* Configure your spatial layers and spatial datasources
+* Extend OpenERP models with spatial columns
+
+GeoEngine relies on `OpenLayers <http://openlayers.org>`_ and `PostgGIS <http://postgis.refractions.net/>`_ technologies.
+
+Postgis is used to store spatial information in databases. OpenLayer is used to represent spatial data in other words to show maps. The GeoEngine module acts as a data provider and as an OpenLayers configurator. It also provides a complete extension to OpenERP ORM.
+
+.. image:: _static/_images/core_architecture.jpg