# 📦 Welcome to TStore
| | |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Deployment | [](https://pypi.org/project/ts-store/) [](https://anaconda.org/conda-forge/ts-store) |
| Activity | [](https://pypi.org/project/ts-store/) [](https://anaconda.org/conda-forge/ts-store) |
| Python Versions | [](https://www.python.org/downloads/) |
| Supported Systems | [](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [](https://github.com/ltelab/tstore/actions/workflows/tests_windows.yml) |
| Project Status | [](https://www.repostatus.org/#active) |
| Build Status | [](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [](https://github.com/ltelab/tstore/actions/workflows/lint.yml) [](https://ts-store.readthedocs.io/en/latest/) |
| Linting | [](https://github.com/psf/black) [](https://github.com/astral-sh/ruff) [](https://github.com/codespell-project/codespell) |
| Code Coverage | [](https://coveralls.io/github/ltelab/tstore?branch=main) [](https://codecov.io/gh/ltelab/tstore) |
| Code Quality | [](https://www.codefactor.io/repository/github/ltelab/tstore) [](https://codebeat.co/projects/github-com-ltelab-tstore-main) [](https://app.codacy.com/gh/ltelab/tstore/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://codescene.io/projects/41868) |
| License | [](https://github.com/ltelab/tstore/blob/main/LICENSE) |
| Community | [](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q) [](https://github.com/ltelab/tstore/discussions) |
| Citation | [](https://doi.org/10.5281/zenodo.7753488) |
[**Slack**](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q) | [**Docs**](https://ts-store.readthedocs.io/en/latest/)
## 🚀 Quick start
Flexible storage for time series
TODO
______________________________________________________________________
#### 📖 Explore the TStore documentation
To discover all TStore download, manipulation, analysis and plotting utilities, or how to contribute your custom retrieval to TStore:
- please read the software documentation available at [https://ts-store.readthedocs.io/en/latest/](https://ts-store.readthedocs.io/en/latest/).
- dive into the Jupyter Notebooks [Tutorials](https://github.com/ltelab/tstore/tree/main/tutorials).
## 🛠️ Installation
### conda
TStore can be installed via [conda][conda_link] on Linux, Mac, and Windows.
Install the package by typing the following command in the terminal:
```bash
conda install ts-store
```
In case conda-forge is not set up for your system yet, see the easy to follow instructions on [conda-forge][conda_forge_link].
### pip
TStore can be installed also via [pip][pip_link] on Linux, Mac, and Windows.
On Windows you can install [WinPython][winpy_link] to get Python and pip running.
Install the TStore package by typing the following command in the terminal:
```bash
pip install ts-store
```
To install the latest development version via pip, see the [documentation][dev_install_link].
## 💭 Feedback and Contributing Guidelines
If you aim to contribute your data or discuss the future development of TStore,
we highly suggest to join the [**TStore Slack Workspace**](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q)
Feel free to also open a [GitHub Issue](https://github.com/ltelab/tstore/issues) or a [GitHub Discussion](https://github.com/ltelab/tstore/discussions) specific to your questions or ideas.
## Citation
If you are using TStore in your publication please cite our Zenodo repository:
> Ghiggi Gionata. ltelab/tstore. Zenodo. [](https://doi.org/10.5281/zenodo.7753488)
If you want to cite a specific software version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7753488).
## License
The content of this repository is released under the terms of the [MIT license](LICENSE).
# OUTDATED HERE BELOW
## Requirements
- [mamba](https://github.com/mamba-org/mamba), which can be installed using conda or [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) (see [the official installation instructions](https://github.com/mamba-org/mamba#installation))
- [snakemake](https://snakemake.github.io), which can be installed using [conda or mamba](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html)
## Instructions
1. Create a conda environment:
```bash
snakemake -c1 create_environment
```
2. Activate it (if using conda, replace `mamba` for `conda`):
```bash
mamba activate tstore
```
3. Register the IPython kernel for Jupyter:
```bash
snakemake -c1 register_ipykernel
```
4. Activate pre-commit for the git repository:
```bash
pre-commit install
pre-commit install --hook-type commit-msg
```
## Acknowledgments
- Based on the [cookiecutter-data-snake :snake:](https://github.com/martibosch/cookiecutter-data-snake) template for reproducible data science.
[conda_forge_link]: https://github.com/conda-forge/ts-store-feedstock#installing-ts-store
[conda_link]: https://docs.conda.io/en/latest/miniconda.html
[dev_install_link]: https://ts-store.readthedocs.io/en/latest/02_installation.html#installation-for-contributors
[pip_link]: https://pypi.org/project/ts-store
[winpy_link]: https://winpython.github.io/
Raw data
{
"_id": null,
"home_page": null,
"name": "ts-store",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "python, time series, storage, parquet, database",
"author": null,
"author_email": "Mart\u00ed Bosch <marti.bosch@protonmail.com>, Gionata Ghiggi <gionata.ghiggi@epfl.ch>",
"download_url": "https://files.pythonhosted.org/packages/56/6b/b55b68840dfe4175727b3abe13acaa79ff1038e39c4d30195da15bd5b312/ts-store-0.0.1.tar.gz",
"platform": null,
"description": "# \ud83d\udce6 Welcome to TStore\n\n| | |\n| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Deployment | [](https://pypi.org/project/ts-store/) [](https://anaconda.org/conda-forge/ts-store) |\n| Activity | [](https://pypi.org/project/ts-store/) [](https://anaconda.org/conda-forge/ts-store) |\n| Python Versions | [](https://www.python.org/downloads/) |\n| Supported Systems | [](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [](https://github.com/ltelab/tstore/actions/workflows/tests_windows.yml) |\n| Project Status | [](https://www.repostatus.org/#active) |\n| Build Status | [](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [](https://github.com/ltelab/tstore/actions/workflows/lint.yml) [](https://ts-store.readthedocs.io/en/latest/) |\n| Linting | [](https://github.com/psf/black) [](https://github.com/astral-sh/ruff) [](https://github.com/codespell-project/codespell) |\n| Code Coverage | [](https://coveralls.io/github/ltelab/tstore?branch=main) [](https://codecov.io/gh/ltelab/tstore) |\n| Code Quality | [](https://www.codefactor.io/repository/github/ltelab/tstore) [](https://codebeat.co/projects/github-com-ltelab-tstore-main) [](https://app.codacy.com/gh/ltelab/tstore/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://codescene.io/projects/41868) |\n| License | [](https://github.com/ltelab/tstore/blob/main/LICENSE) |\n| Community | [](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q) [](https://github.com/ltelab/tstore/discussions) |\n| Citation | [](https://doi.org/10.5281/zenodo.7753488) |\n\n[**Slack**](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q) | [**Docs**](https://ts-store.readthedocs.io/en/latest/)\n\n## \ud83d\ude80 Quick start\n\nFlexible storage for time series\n\nTODO\n\n______________________________________________________________________\n\n#### \ud83d\udcd6 Explore the TStore documentation\n\nTo discover all TStore download, manipulation, analysis and plotting utilities, or how to contribute your custom retrieval to TStore:\n\n- please read the software documentation available at [https://ts-store.readthedocs.io/en/latest/](https://ts-store.readthedocs.io/en/latest/).\n- dive into the Jupyter Notebooks [Tutorials](https://github.com/ltelab/tstore/tree/main/tutorials).\n\n## \ud83d\udee0\ufe0f Installation\n\n### conda\n\nTStore can be installed via [conda][conda_link] on Linux, Mac, and Windows.\nInstall the package by typing the following command in the terminal:\n\n```bash\nconda install ts-store\n```\n\nIn case conda-forge is not set up for your system yet, see the easy to follow instructions on [conda-forge][conda_forge_link].\n\n### pip\n\nTStore can be installed also via [pip][pip_link] on Linux, Mac, and Windows.\nOn Windows you can install [WinPython][winpy_link] to get Python and pip running.\n\nInstall the TStore package by typing the following command in the terminal:\n\n```bash\npip install ts-store\n```\n\nTo install the latest development version via pip, see the [documentation][dev_install_link].\n\n## \ud83d\udcad Feedback and Contributing Guidelines\n\nIf you aim to contribute your data or discuss the future development of TStore,\nwe highly suggest to join the [**TStore Slack Workspace**](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q)\n\nFeel free to also open a [GitHub Issue](https://github.com/ltelab/tstore/issues) or a [GitHub Discussion](https://github.com/ltelab/tstore/discussions) specific to your questions or ideas.\n\n## Citation\n\nIf you are using TStore in your publication please cite our Zenodo repository:\n\n> Ghiggi Gionata. ltelab/tstore. Zenodo. [](https://doi.org/10.5281/zenodo.7753488)\n\nIf you want to cite a specific software version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7753488).\n\n## License\n\nThe content of this repository is released under the terms of the [MIT license](LICENSE).\n\n\n# OUTDATED HERE BELOW\n\n## Requirements\n\n- [mamba](https://github.com/mamba-org/mamba), which can be installed using conda or [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) (see [the official installation instructions](https://github.com/mamba-org/mamba#installation))\n- [snakemake](https://snakemake.github.io), which can be installed using [conda or mamba](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html)\n\n## Instructions\n\n1. Create a conda environment:\n\n```bash\nsnakemake -c1 create_environment\n```\n\n2. Activate it (if using conda, replace `mamba` for `conda`):\n\n```bash\nmamba activate tstore\n```\n\n3. Register the IPython kernel for Jupyter:\n\n```bash\nsnakemake -c1 register_ipykernel\n```\n\n4. Activate pre-commit for the git repository:\n\n```bash\npre-commit install\npre-commit install --hook-type commit-msg\n```\n\n## Acknowledgments\n\n- Based on the [cookiecutter-data-snake :snake:](https://github.com/martibosch/cookiecutter-data-snake) template for reproducible data science.\n\n[conda_forge_link]: https://github.com/conda-forge/ts-store-feedstock#installing-ts-store\n[conda_link]: https://docs.conda.io/en/latest/miniconda.html\n[dev_install_link]: https://ts-store.readthedocs.io/en/latest/02_installation.html#installation-for-contributors\n[pip_link]: https://pypi.org/project/ts-store\n[winpy_link]: https://winpython.github.io/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flexible storage for time series.",
"version": "0.0.1",
"project_urls": {
"Repository": "https://github.com/ltelab/tstore",
"changelog": "https://github.com/ltelab/tstore/blob/main/CHANGELOG.md",
"documentation": "https://tstore.readthedocs.io",
"homepage": "https://github.com/ltelab/tstore",
"repository": "https://github.com/ltelab/tstore",
"source": "https://github.com/ltelab/tstore",
"tracker": "https://github.com/ltelab/tstore/issues"
},
"split_keywords": [
"python",
" time series",
" storage",
" parquet",
" database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c2006ac799b7f870a63cc02462264240e34eb7dc00651e202993f64cdcb892e",
"md5": "1b2dea01fe717106e357c7cc068b01ad",
"sha256": "0c8123e5828ed20c1d214aacb2185eb9b1ba18ce021a70e9205ddd8cb988ac1a"
},
"downloads": -1,
"filename": "ts_store-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b2dea01fe717106e357c7cc068b01ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 25303,
"upload_time": "2024-04-07T09:37:59",
"upload_time_iso_8601": "2024-04-07T09:37:59.389454Z",
"url": "https://files.pythonhosted.org/packages/6c/20/06ac799b7f870a63cc02462264240e34eb7dc00651e202993f64cdcb892e/ts_store-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "566bb55b68840dfe4175727b3abe13acaa79ff1038e39c4d30195da15bd5b312",
"md5": "2c4aadc337e6c8648ca2d055a7f96ba6",
"sha256": "d8354c03f66f3d855df909fa0de5b3fe72448137c0e46ef3163a958e2a35b5c0"
},
"downloads": -1,
"filename": "ts-store-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2c4aadc337e6c8648ca2d055a7f96ba6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 27462,
"upload_time": "2024-04-07T09:38:07",
"upload_time_iso_8601": "2024-04-07T09:38:07.993575Z",
"url": "https://files.pythonhosted.org/packages/56/6b/b55b68840dfe4175727b3abe13acaa79ff1038e39c4d30195da15bd5b312/ts-store-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 09:38:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ltelab",
"github_project": "tstore",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ts-store"
}
JSON
