Skip to content

Commit

Permalink
Merge branch 'dev' into v0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
amacd31 committed Nov 11, 2016
2 parents 15560b0 + 856caa0 commit b3288f6
Show file tree
Hide file tree
Showing 19 changed files with 779 additions and 831 deletions.
19 changes: 15 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PhilDB project
==============

|DOI| |PYPI Version| |PYPI Python versions| |PYPI License| |Build Status| |Code Coverage|
|DOI| |PYPI Version| |PYPI Status| |PYPI Python versions| |PYPI License| |Build Status| |Code Coverage|

Timeseries database project: For storing potentially changing timeseries
data. For example hydrological data, like streamflow data, where the
Expand All @@ -12,6 +12,12 @@ PhilDB should be capable of storing data at any frequency supported by
Pandas. At this time only daily data has been extensively tested with
some limited sub-daily usage.

Further information about the design of PhilDB can be found in the paper:
`PhilDB: the time series database with built-in change logging <https://peerj.com/articles/cs-52/>`_.
That paper explores existing time series database solutions, discusses the
motivation for PhilDB, describes the architecture and philosophy of the PhilDB
software, and includes an evaluation between InfluxDB, PhilDB, and SciDB.

Dependencies
------------

Expand Down Expand Up @@ -104,7 +110,7 @@ bom\_observations, and hrs.
ACORN-SAT
---------

Located in examples/acorn-sat this example demonstrates loading minimum
`ACORN-SAT Example.ipynb <https://github.com/amacd31/phildb/blob/dev/examples/acorn-sat/ACORN-SAT%20Example.ipynb>`_ located in examples/acorn-sat demonstrates loading minimum
and maximum daily temperature records for 112 stations around Australia.

The dataset used in this example is the Australian Climate Observations
Expand All @@ -115,7 +121,8 @@ Australian Bureau of Meteorology website
BOM Observations
----------------

Located in examples/bom\_observations this example demonstrates loading
`Bureau of Meterology observations example.ipynb <https://github.com/amacd31/phildb/blob/dev/examples/bom_observations/Bureau%20of%20Meterology%20observations%20example.ipynb>`_
located in examples/bom\_observations demonstrates loading
half hourly air temperature data from a 72 hour observations JSON file.

The data used in this example is a 72 hour observations JSON file from
Expand All @@ -126,7 +133,8 @@ observations <http://www.bom.gov.au/products/IDN60901/IDN60901.94767.shtml#other
HRS
---

Located in examples/hrs this example demonstrates loading daily
`HRS Example.ipynb <https://github.com/amacd31/phildb/blob/dev/examples/hrs/HRS%20Example.ipynb>`_
located in examples/hrs demonstrates loading daily
streamflow data for 221 streamflow stations around Australia.

The dataset used in this example is the Hydrologic Reference Stations
Expand All @@ -139,6 +147,9 @@ for all the streamflow timeseries in the HRS dataset.
.. |PYPI Version| image:: https://img.shields.io/pypi/v/phildb.svg
:target: https://pypi.python.org/pypi/PhilDB

.. |PYPI Status| image:: https://img.shields.io/pypi/status/phildb.svg
:target: https://pypi.python.org/pypi/PhilDB

.. |PYPI Python versions| image:: https://img.shields.io/pypi/pyversions/phildb.svg
:target: https://pypi.python.org/pypi/PhilDB

Expand Down
2 changes: 1 addition & 1 deletion ci
Submodule ci updated 1 files
+2 −2 travis/install.sh
Loading

0 comments on commit b3288f6

Please sign in to comment.