tonik 0.1.9__tar.gz → 0.1.11__tar.gz

{tonik-0.1.9 → tonik-0.1.11}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: tonik
-Version: 0.1.9
+Version: 0.1.11
 Summary: Store time series data as HDF5 files and access them through an API.
 Project-URL: Homepage, https://tsc-tools.github.io/tonik
 Project-URL: Issues, https://github.com/tsc-tools/tonik/issues
@@ -10,8 +10,9 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.7
+Requires-Dist: dask<=2024.10.0
 Requires-Dist: datashader>=0.14
-Requires-Dist: fastapi>=0.95
+Requires-Dist: fastapi>=0.112
 Requires-Dist: h5netcdf>=1.1
 Requires-Dist: h5py>=3.8
 Requires-Dist: matplotlib
@@ -30,8 +31,8 @@ Description-Content-Type: text/markdown
 
 # Tonik
 
-Tonik provides you with a solution to store and retrieve scientific data as well as serving it through an API.
-For visualisations, the API can serve large requests very quickly by downsampling the data to the requested resolution on demand.
+Tonik provides you with a solution to store and retrieve scientific time-series data as well as serving it through an API.
+For visualisations, the API can serve large requests very quickly by downsampling the data to the requested resolution on demand. The API was optimised to visualise time-series and data labels with [Grafana](https://grafana.com/oss/grafana/).
 
 ## Requirements
 * h5py
@@ -54,10 +55,6 @@ pip install -U tonik
 
 Learn more about tonik in its official [documentation](https://tsc-tools.github.io/tonik)
 
-## Contributing
-
-You can find information about contributing to tonik at our [Contributing page]
-
 ## Get in touch
 
-Report bugs, suggest features, view the source code, and ask questions [on GitHub](https://github.com/tsc-tools/tonik).
+Report bugs, suggest features, view the source code, and ask questions [on GitHub](https://github.com/tsc-tools/tonik/issues).

{tonik-0.1.9 → tonik-0.1.11}/README.md

@@ -1,7 +1,7 @@
 # Tonik
 
-Tonik provides you with a solution to store and retrieve scientific data as well as serving it through an API.
-For visualisations, the API can serve large requests very quickly by downsampling the data to the requested resolution on demand.
+Tonik provides you with a solution to store and retrieve scientific time-series data as well as serving it through an API.
+For visualisations, the API can serve large requests very quickly by downsampling the data to the requested resolution on demand. The API was optimised to visualise time-series and data labels with [Grafana](https://grafana.com/oss/grafana/).
 
 ## Requirements
 * h5py
@@ -24,10 +24,6 @@ pip install -U tonik
 
 Learn more about tonik in its official [documentation](https://tsc-tools.github.io/tonik)
 
-## Contributing
-
-You can find information about contributing to tonik at our [Contributing page]
-
 ## Get in touch
 
-Report bugs, suggest features, view the source code, and ask questions [on GitHub](https://github.com/tsc-tools/tonik).
+Report bugs, suggest features, view the source code, and ask questions [on GitHub](https://github.com/tsc-tools/tonik/issues).

tonik-0.1.11/docs/grafana_integration.md

@@ -0,0 +1,35 @@
+# Grafana integration
+
+Tonik's API was written to work well with [Grafana](https://grafana.com/oss/grafana/) for visualising data and data labels.
+
+The [repo](https://github.com/tsc-tools/tonik) contains a Grafana 
+[example](https://github.com/tsc-tools/tonik/tree/main/grafana_example) that demonstrates
+an example setup using [docker-compose](https://docs.docker.com/compose/).
+
+To run the example you first have to install [docker](https://docs.docker.com/get-started/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/). Then get a local copy of the repository by running:
+
+```
+git clone --depth=1 https://github.com/tsc-tools/tonik.git
+```
+
+and finally start the example by running the following commands:
+```
+cd tonik/grafana_example
+docker-compose up --build
+```
+
+This will build and start the necessary docker containers and then start Grafana on port `11223` of your host machine. Should this port not be available you can change the port in the `docker-compose.yml` file under the `ports` section.
+
+Navigating to [http://localhost:11223](http://localhost:11223) will show the following login screen:
+
+![login screen](./grafana_login_screenshot.png)
+
+Entering the shown details will then load the following demo dashboard:
+
+![demo dashboard](./grafana_dashboard_screenshot.png)
+
+To shut down the grafana instance first stop docker-compose using Ctrl-c and then clean up by running
+
+```
+docker-compose down
+```

{tonik-0.1.9 → tonik-0.1.11}/docs/index.md

@@ -1,7 +1,7 @@
 # Tonik
 
-Tonik provides you with a solution to store and retrieve scientific data as well as serving it through an API.
-For visualisations, the API can serve large requests very quickly by downsampling the data to the requested resolution on demand.
+Tonik provides you with a solution to store and retrieve scientific time-series data as well as serving it through an API.
+For visualisations, the API can serve large requests very quickly by downsampling the data to the requested resolution on demand. The API was optimised to visualise time-series and data labels with [Grafana](https://grafana.com/oss/grafana/).
 
 ## Requirements
 * h5py
@@ -13,6 +13,7 @@ For visualisations, the API can serve large requests very quickly by downsamplin
 * python-json-logger
 * uvicorn
 * fastapi
+* matplotlib (only needed to reproduce the examples in the user guide)
 
 ## Installation
 ```
@@ -22,12 +23,8 @@ pip install -U tonik
 ## Documentation
 
 Learn more about tonik in its official [documentation](https://tsc-tools.github.io/tonik.github.io/)
-Try out an [interactive Jupyter notebook](https://github.com/tsc-tools/tonik/tree/main/examples)
-
-## Contributing
-
-You can find information about contributing to tonik at our [Contributing page]
+Try out a [Jupyter notebook](https://github.com/tsc-tools/tonik/blob/main/docs/tonik_example.ipynb)
 
 ## Get in touch
 
-Report bugs, suggest features, view the source code, and ask questions [on GitHub](https://github.com/tsc-tools/tonik).
+Report bugs, suggest features, view the source code, and ask questions [on GitHub](https://github.com/tsc-tools/tonik/issues).