# AtriumDB
AtriumDB is a comprehensive solution for the management and analysis of physiological waveform data. It includes a powerful SDK for data compression, storage and retrieval.
## Installation
From PyPI (recommended)
```console
$ pip install atriumdb
```
This will install the base version of AtriumDB, allowing the reading and writing to local datasets, supported by sqlite3 only.
For more installation options including support to MariaDB datasets see the [documentation](https://docs.atriumdb.io/installation.html).
To install from source see GitHub readme [here](https://github.com/LaussenLabs/atriumdb).
## Quick Start
### Creating a new dataset
To create a new dataset, you can use the `create_dataset` method. This method allows you to specify the type of metadata database to use and where the data will be stored.
```python
from atriumdb import AtriumSDK
# Create a new local dataset using SQLite
sdk = AtriumSDK.create_dataset(dataset_location="./new_dataset", database_type="sqlite")
# OR create a new local dataset using MariaDB
connection_params = {
'host': "localhost",
'user': "user",
'password': "pass",
'database': "new_dataset",
'port': 3306
}
sdk = AtriumSDK.create_dataset(dataset_location="./new_dataset", database_type="mysql", connection_params=connection_params)
```
The sdk object is how you will interact with the dataset including retrieving data, saving data and any of the other methods defined in the [documentation](https://docs.atriumdb.io/contents.html).
### Connecting to an existing dataset
To connect to an already created dataset, you will need to specify a local path where the dataset is stored if it's a sqlite database.
If it's a MariaDB dataset you will also have to specify the connection parameters.
```python
# Import AtriumSDK python object
from atriumdb import AtriumSDK
# Define a directory path where the dataset is stored (always needed)
dataset_location = "./example_dataset"
# Create AtriumSDK python object (sqlite)
sdk = AtriumSDK(dataset_location=dataset_location)
# OR Connect to a dataset supported by mariadb
connection_params = {
'host': "localhost",
'user': "user",
'password': "pass",
'database': "new_dataset",
'port': 3306
}
sdk = AtriumSDK(dataset_location=dataset_location, metadata_connection_type="mysql", connection_params=connection_params)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "atriumdb",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "\"William Dixon, Spencer Vecile\" <laussen.labs@sickkids.ca>, William Dixon <will.dixon@sickkids.ca>, Spencer Vecile <spencer.vecile@sickkids.ca>",
"keywords": "atriumdb, timeseries, database, waveform, medical data, machine learning, data, data science",
"author": "Robert Greer, William Dixon, Spencer Vecile",
"author_email": "Robert Greer <robert.greer@sickkids.ca>, William Dixon <will.dixon@sickkids.ca>, Spencer Vecile <spencer.vecile@sickkids.ca>",
"download_url": null,
"platform": null,
"description": "# AtriumDB\nAtriumDB is a comprehensive solution for the management and analysis of physiological waveform data. It includes a powerful SDK for data compression, storage and retrieval.\n\n## Installation\nFrom PyPI (recommended)\n```console\n$ pip install atriumdb\n```\nThis will install the base version of AtriumDB, allowing the reading and writing to local datasets, supported by sqlite3 only.\nFor more installation options including support to MariaDB datasets see the [documentation](https://docs.atriumdb.io/installation.html).\nTo install from source see GitHub readme [here](https://github.com/LaussenLabs/atriumdb).\n\n## Quick Start\n\n### Creating a new dataset\nTo create a new dataset, you can use the `create_dataset` method. This method allows you to specify the type of metadata database to use and where the data will be stored.\n```python\nfrom atriumdb import AtriumSDK\n\n# Create a new local dataset using SQLite\nsdk = AtriumSDK.create_dataset(dataset_location=\"./new_dataset\", database_type=\"sqlite\")\n\n# OR create a new local dataset using MariaDB\nconnection_params = {\n 'host': \"localhost\",\n 'user': \"user\",\n 'password': \"pass\",\n 'database': \"new_dataset\",\n 'port': 3306\n}\n\nsdk = AtriumSDK.create_dataset(dataset_location=\"./new_dataset\", database_type=\"mysql\", connection_params=connection_params)\n```\nThe sdk object is how you will interact with the dataset including retrieving data, saving data and any of the other methods defined in the [documentation](https://docs.atriumdb.io/contents.html).\n\n### Connecting to an existing dataset\nTo connect to an already created dataset, you will need to specify a local path where the dataset is stored if it's a sqlite database. \nIf it's a MariaDB dataset you will also have to specify the connection parameters.\n\n```python\n# Import AtriumSDK python object\nfrom atriumdb import AtriumSDK\n\n# Define a directory path where the dataset is stored (always needed)\ndataset_location = \"./example_dataset\"\n\n# Create AtriumSDK python object (sqlite)\nsdk = AtriumSDK(dataset_location=dataset_location)\n\n# OR Connect to a dataset supported by mariadb\nconnection_params = {\n 'host': \"localhost\",\n 'user': \"user\",\n 'password': \"pass\",\n 'database': \"new_dataset\",\n 'port': 3306\n}\n\nsdk = AtriumSDK(dataset_location=dataset_location, metadata_connection_type=\"mysql\", connection_params=connection_params)\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Timeseries Database",
"version": "2.2.3",
"project_urls": {
"Documentation": "https://docs.atriumdb.io/",
"Homepage": "https://atriumdb.io"
},
"split_keywords": [
"atriumdb",
" timeseries",
" database",
" waveform",
" medical data",
" machine learning",
" data",
" data science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e0e0ab02e507be81c9fbc7af5a71a874f978c5c5defe1abefc3fc31c05257ad",
"md5": "dc2c94a835474b7fc178cb5f883a68e3",
"sha256": "1bbf51e3edb06ba4cb7ece33256e7444aefb579499e1fbed1f2bf883efa64640"
},
"downloads": -1,
"filename": "atriumdb-2.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc2c94a835474b7fc178cb5f883a68e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 982318,
"upload_time": "2024-03-28T15:16:17",
"upload_time_iso_8601": "2024-03-28T15:16:17.529933Z",
"url": "https://files.pythonhosted.org/packages/2e/0e/0ab02e507be81c9fbc7af5a71a874f978c5c5defe1abefc3fc31c05257ad/atriumdb-2.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 15:16:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "atriumdb"
}
JSON