Skip to content

Commit

Permalink
update documentation #59
Browse files Browse the repository at this point in the history
  • Loading branch information
valentinedwv committed Aug 12, 2016
1 parent 2d279b8 commit 5dd75ab
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 12 deletions.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,10 @@ Extensive documentation is available at http://pythonhosted.org/WOFpy/

Installation
------------
In general, the easiest method is to utilize the anaconda package:
https://conda.anaconda.org/odm2

Follow the steps below for Basic installation on a Windows computer.

1. Install **Python 2.7**. The 32-bit installer is recommended.
2. Add the **Python** folder to your **Path** environment variable.
3. Install **setuptools**. This allows the setup script to be run.
4. Add the **Python/scripts** folder to your **Path** environment variable.
5. Open a command window (run cmd), navigate to the WOFpy folder (with setup.py
in it), and enter this command: ``python setup.py install``

The wof package (in the subfolder named wof) is now accessible from any directory.

Note: If you edit code in the **wof** folder, you may need to run setup.py again to apply the changes to your system.

ODM2 and ODM1 Instructions
--------------------------
Expand Down
25 changes: 24 additions & 1 deletion docs/Sphinx/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Follow the steps below to run this example.
#. In your command window you should see a message indicating that the service
is running along with instructions for accessing the service.

ODM SQL Server Example
ODM 1.1 SQL Server Example
----------------------

This example is located in the **examples/flask/odm_1_1** folder.
Expand Down Expand Up @@ -159,6 +159,29 @@ Follow the steps below to run this example.
#. In your command window you should see a message indicating that the service
is running along with instructions for accessing the service.

ODM1Services

ODM 2 SQL Server Example
----------------------

This example is located in the **examples/flask/odm2** folder.

These examples show how to access Observations Data Model (ODM2) databases in PostgreSQL/Mysql Server.
The example for ODM2 measurement data uses the Marchantaria Time Series ODM2 PostgreSQL database from the ODM2 github at https://github.com/ODM2/ODM2/tree/master/usecases/marchantariats.
And the example for ODM2 timeseries uses Little Bear River Test ODM2 Mysql Database from ODM2 github at https://github.com/ODM2/ODM2/tree/master/usecases/littlebearriver/sampledatabases.

Follow the steps below to run this example.

#. Install PostgreSQL or Mysql Server based on the data use cases.
#. Download ODM2 database from the ODM2 github at above URLs.
#. Download the ODM2API (https://github.com/ODM2/ODM2PythonAPI/tree/setup). At **src** folder, enter this command: ``python setup.py install``.
#. Determine the database connection string. **odm2_connection_string** set to a SQLAlchemy-compatible
database connection string for the ODM2 database, e.g.,
'postgresql+psycopg2://username:passowkr@hostname:port/db_name' or, 'mysql+mysqldb://username:password/db_name'
#. In the **examples/flask/odm2/{measurement|timeseries}** folder, edit the value of the **openPort**
variable in **runserver_multiple.py|runserver_odm2_measurement.py|runserver_odm2_timeseries.py** to match an open port on your computer,

ODM2Services

CBI External Service Example
----------------------------
Expand Down

0 comments on commit 5dd75ab

Please sign in to comment.