Skip to content

Commit 5dd75ab

Browse files
committed
update documentation #59
1 parent 2d279b8 commit 5dd75ab

File tree

2 files changed

+26
-12
lines changed

2 files changed

+26
-12
lines changed

README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,10 @@ Extensive documentation is available at http://pythonhosted.org/WOFpy/
1414

1515
Installation
1616
------------
17+
In general, the easiest method is to utilize the anaconda package:
18+
https://conda.anaconda.org/odm2
1719

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

20-
1. Install **Python 2.7**. The 32-bit installer is recommended.
21-
2. Add the **Python** folder to your **Path** environment variable.
22-
3. Install **setuptools**. This allows the setup script to be run.
23-
4. Add the **Python/scripts** folder to your **Path** environment variable.
24-
5. Open a command window (run cmd), navigate to the WOFpy folder (with setup.py
25-
in it), and enter this command: ``python setup.py install``
26-
27-
The wof package (in the subfolder named wof) is now accessible from any directory.
28-
29-
Note: If you edit code in the **wof** folder, you may need to run setup.py again to apply the changes to your system.
3021

3122
ODM2 and ODM1 Instructions
3223
--------------------------

docs/Sphinx/GettingStarted.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Follow the steps below to run this example.
128128
#. In your command window you should see a message indicating that the service
129129
is running along with instructions for accessing the service.
130130

131-
ODM SQL Server Example
131+
ODM 1.1 SQL Server Example
132132
----------------------
133133

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

162+
ODM1Services
163+
164+
ODM 2 SQL Server Example
165+
----------------------
166+
167+
This example is located in the **examples/flask/odm2** folder.
168+
169+
These examples show how to access Observations Data Model (ODM2) databases in PostgreSQL/Mysql Server.
170+
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.
171+
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.
172+
173+
Follow the steps below to run this example.
174+
175+
#. Install PostgreSQL or Mysql Server based on the data use cases.
176+
#. Download ODM2 database from the ODM2 github at above URLs.
177+
#. Download the ODM2API (https://github.com/ODM2/ODM2PythonAPI/tree/setup). At **src** folder, enter this command: ``python setup.py install``.
178+
#. Determine the database connection string. **odm2_connection_string** set to a SQLAlchemy-compatible
179+
database connection string for the ODM2 database, e.g.,
180+
'postgresql+psycopg2://username:passowkr@hostname:port/db_name' or, 'mysql+mysqldb://username:password/db_name'
181+
#. In the **examples/flask/odm2/{measurement|timeseries}** folder, edit the value of the **openPort**
182+
variable in **runserver_multiple.py|runserver_odm2_measurement.py|runserver_odm2_timeseries.py** to match an open port on your computer,
183+
184+
ODM2Services
162185

163186
CBI External Service Example
164187
----------------------------

0 commit comments

Comments
 (0)