Skip to content

Commit

Permalink
Various fix
Browse files Browse the repository at this point in the history
  • Loading branch information
@ghiggi
ghiggi committed Apr 7, 2024
1 parent 33c74ac commit e7fda77
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 28 deletions.
87 changes: 83 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,84 @@
[![lint](https://github.com/ltelab/tstore/actions/workflows/lint.yaml/badge.svg)](https://github.com/ltelab/tstore/actions/workflows/lint.yaml)
[![ci](https://github.com/ltelab/tstore/actions/workflows/ci.yaml/badge.svg)](https://github.com/ltelab/tstore/actions/workflows/ci.yaml)
[![GitHub license](https://img.shields.io/github/license/ltelab/tstore.svg)](https://github.com/ltelab/tstore/blob/main/LICENSE)
# 📦 Welcome to TStore

# TStore
| | |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Deployment | [![PyPI](https://badge.fury.io/py/ts-store.svg?style=flat)](https://pypi.org/project/ts-store/) [![Conda](https://img.shields.io/conda/vn/conda-forge/ts-store.svg?logo=conda-forge&logoColor=white&style=flat)](https://anaconda.org/conda-forge/ts-store) |
| Activity | [![PyPI Downloads](https://img.shields.io/pypi/dm/ts-store.svg?label=PyPI%20downloads&style=flat)](https://pypi.org/project/ts-store/) [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/ts-store.svg?label=Conda%20downloads&style=flat)](https://anaconda.org/conda-forge/ts-store) |
| Python Versions | [![Python Versions](https://img.shields.io/badge/Python-3.9%20%203.10%20%203.11%20%203.12-blue?style=flat)](https://www.python.org/downloads/) |
| Supported Systems | [![Linux](https://img.shields.io/github/actions/workflow/status/ltelab/tstore/.github/workflows/tests.yml?label=Linux&style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [![macOS](https://img.shields.io/github/actions/workflow/status/ltelab/tstore/.github/workflows/tests.yml?label=macOS&style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [![Windows](https://img.shields.io/github/actions/workflow/status/ltelab/tstore/.github/workflows/tests_windows.yml?label=Windows&style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests_windows.yml) |
| Project Status | [![Project Status](https://www.repostatus.org/badges/latest/active.svg?style=flat)](https://www.repostatus.org/#active) |
| Build Status | [![Tests](https://github.com/ltelab/tstore/actions/workflows/tests.yml/badge.svg?style=flat)](https://github.com/ltelab/tstore/actions/workflows/tests.yml) [![Lint](https://github.com/ltelab/tstore/actions/workflows/lint.yml/badge.svg?style=flat)](https://github.com/ltelab/tstore/actions/workflows/lint.yml) [![Docs](https://readthedocs.org/projects/ts-store/badge/?version=latest&style=flat)](https://ts-store.readthedocs.io/en/latest/) |
| Linting | [![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat)](https://github.com/astral-sh/ruff) [![Codespell](https://img.shields.io/badge/Codespell-enabled-brightgreen?style=flat)](https://github.com/codespell-project/codespell) |
| Code Coverage | [![Coveralls](https://coveralls.io/repos/github/ltelab/tstore/badge.svg?branch=main&style=flat)](https://coveralls.io/github/ltelab/tstore?branch=main) [![Codecov](https://codecov.io/gh/ltelab/tstore/branch/main/graph/badge.svg?style=flat)](https://codecov.io/gh/ltelab/tstore) |
| Code Quality | [![Codefactor](https://www.codefactor.io/repository/github/ltelab/tstore/badge?style=flat)](https://www.codefactor.io/repository/github/ltelab/tstore) [![Codebeat](https://codebeat.co/badges/236abcf2-cbae-4ca9-8a2d-3b70495bb16b?style=flat)](https://codebeat.co/projects/github-com-ltelab-ts_store-main) [![Codacy](https://app.codacy.com/project/badge/Grade/bee842cb10004ad8bb9288256f2fc8af?style=flat)](https://app.codacy.com/gh/ltelab/tstore/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Codescene](https://codescene.io/projects/36767/status-badges/code-health?style=flat)](https://codescene.io/projects/36767) |
| License | [![License](https://img.shields.io/github/license/ltelab/tstore?style=flat)](https://github.com/ltelab/tstore/blob/main/LICENSE) |
| Community | [![Slack](https://img.shields.io/badge/Slack-tstore-green.svg?logo=slack&style=flat)](https://join.slack.com/t/tstore-workspace/shared_invite/zt-2g8uanpgm-dYrL6rxk5pEpAKCYn~QQ5Q) [![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-green?logo=github&style=flat)](https://github.com/ltelab/tstore/discussions) |
| Citation | [![DOI](https://zenodo.org/badge/286664485.svg?style=flat)](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](https://zenodo.org/badge/286664485.svg?style=flat)](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))
Expand Down Expand Up @@ -41,3 +114,9 @@ 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/
7 changes: 2 additions & 5 deletions pyproject.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "tstore"
version = "0.1.0"
version = "0.0.1"
description = "Flexible storage for time series."
authors = [{ name = "Martí Bosch", email = "[email protected]" },
{ name = "Gionata Ghiggi", email = "[email protected]" }]
Expand All @@ -30,7 +30,7 @@ dependencies = [
"geopandas",
"pyyaml",
]
dynamic = ["version"]
# dynamic = ["version"]

[project.optional-dependencies]
dev = [
Expand Down Expand Up @@ -209,9 +209,6 @@ convention = "numpy"
"setup.py" = ["D100"]
"*__init__.py" = ["D104"]

[tool.ruff.isort]
known-first-party = ["tstore"]

[tool.codespell]
ignore-words-list = "nd,mis"

Expand Down
17 changes: 0 additions & 17 deletions tstore/_version.py
View file

This file was deleted.

3 changes: 1 addition & 2 deletions tstore/tsdf/extensions/array.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
@author: ghiggi
"""
from typing import Any

import dask.dataframe as dd
import numpy as np
Expand Down Expand Up @@ -77,7 +76,7 @@ def __repr__(self):
return f"TSArray composed of {n} TS objects."

# Required for all ExtensionArray subclasses
def __getitem__(self, index: int) -> "TSArray" | Any:
def __getitem__(self, index: int):
"""Select a subset of self."""
if isinstance(index, int):
return self._data[index]
Expand Down

0 comments on commit e7fda77

Please sign in to comment.