# arctix
<p align="center">
<a href="https://github.com/durandtibo/arctix/actions">
<img alt="CI" src="https://github.com/durandtibo/arctix/workflows/CI/badge.svg">
</a>
<a href="https://github.com/durandtibo/arctix/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/arctix/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/arctix/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/arctix/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://durandtibo.github.io/arctix/">
<img alt="Documentation" src="https://github.com/durandtibo/arctix/workflows/Documentation%20(stable)/badge.svg">
</a>
<a href="https://durandtibo.github.io/arctix/">
<img alt="Documentation" src="https://github.com/durandtibo/arctix/workflows/Documentation%20(unstable)/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/arctix">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/arctix/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/arctix/maintainability">
<img src="https://api.codeclimate.com/v1/badges/61b8574ea18ecf106dce/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/arctix/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/61b8574ea18ecf106dce/test_coverage" />
</a>
<br/>
<a href="https://github.com/psf/black">
<img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</a>
<a href="https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings">
<img alt="Doc style: google" src="https://img.shields.io/badge/%20style-google-3666d6.svg">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href="https://github.com/guilatrova/tryceratops">
<img alt="Doc style: google" src="https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black">
</a>
<br/>
<a href="https://pypi.org/project/arctix/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/arctix">
</a>
<a href="https://pypi.org/project/arctix/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/arctix.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/arctix">
</a>
<br/>
<a href="https://pepy.tech/project/arctix">
<img alt="Downloads" src="https://static.pepy.tech/badge/arctix">
</a>
<a href="https://pepy.tech/project/arctix">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/arctix/month">
</a>
<br/>
</p>
## Overview
The `arctix` package consists of functionalities to prepare dataset of asynchronous time series.
It is design to make dataset preparation reusable and reproducible.
For each dataset, `arctix` provides 3 main functions:
- `fetch_data` to load the raw data are loaded in
a [`polars.DataFrame`](https://docs.pola.rs/py-polars/html/reference/dataframe/index.html). When
possible, it downloads automatically the data.
- `prepare_data` to prepare the data. It outputs the prepared data
in [`polars.DataFrame`](https://docs.pola.rs/py-polars/html/reference/dataframe/index.html), and
the metadata.
- `to_array` to convert the prepared data to a dictionary of numpy arrays.
For example, it is possible to use the following lines to download and prepare the MultiTHUMOS data.
```pycon
>>> from pathlib import Path
>>> from arctix.dataset.multithumos import fetch_data, prepare_data, to_array
>>> dataset_path = Path("/path/to/dataset/multithumos")
>>> data_raw = fetch_data(dataset_path) # doctest: +SKIP
>>> data, metadata = prepare_data(data_raw) # doctest: +SKIP
>>> arrays = to_array(data) # doctest: +SKIP
```
- [Documentation](https://durandtibo.github.io/arctix/)
- [Installation](#installation)
- [Contributing](#contributing)
- [API stability](#api-stability)
- [License](#license)
## Documentation
- [latest (stable)](https://durandtibo.github.io/arctix/): documentation from the latest stable
release.
- [main (unstable)](https://durandtibo.github.io/arctix/main/): documentation associated to the
main branch of the repo. This documentation may contain a lot of work-in-progress/outdated/missing
parts.
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`arctix` can be installed from pip using the following command:
```shell
pip install arctix
```
To make the package as slim as possible, only the minimal packages required to use `arctix` are
installed.
To include all the packages, you can use the following command:
```shell
pip install arctix[all]
```
Please check the [get started page](https://durandtibo.github.io/arctix/get_started) to see how to
install only some specific packages or other alternatives to install the library.
The following is the corresponding `karbonn` versions and dependencies.
| `batcharray` | `batcharray` | `coola` | `iden` | `numpy` | `polars` | `python` |
|--------------|----------------|--------------|------------------|---------------|-----------------|---------------|
| `main` | `>=0.0.2,<0.1` | `>=0.3,<1.0` | `">=0.0.3,<1.0"` | `>=1.22,<2.0` | `>=0.20.0,<1.0` | `>=3.9,<3.13` |
| `0.0.5` | `>=0.0.2,<0.1` | `>=0.3,<1.0` | `">=0.0.3,<1.0"` | `>=1.22,<2.0` | `>=0.20.0,<1.0` | `>=3.9,<3.13` |
| `0.0.4` | `>=0.0.2,<0.1` | `>=0.3,<1.0` | `">=0.0.3,<1.0"` | `>=1.22,<2.0` | `>=0.20.0,<1.0` | `>=3.9,<3.13` |
| `0.0.3` | `>=0.0.2,<0.1` | `>=0.3,<1.0` | `">=0.0.3,<1.0"` | `>=1.22,<2.0` | `>=0.20.0,<1.0` | `>=3.9,<3.13` |
## Contributing
Please check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).
## API stability
:warning: While `arctix` is in development stage, no API is guaranteed to be stable from one
release to the next.
In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release.
In practice, this means that upgrading `arctix` to a new version will possibly break any code that
was using the old version of `arctix`.
## License
`arctix` is licensed under BSD 3-Clause "New" or "Revised" license available in [LICENSE](LICENSE)
file.
Raw data
{
"_id": null,
"home_page": "https://github.com/durandtibo/arctix",
"name": "arctix",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "asynchronous time-series, dataset, preprocessing",
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4d/2a/9ab4ad06f5b0797abfac470547b0e662c273e2a8c93397787eee17522ffe/arctix-0.0.6.tar.gz",
"platform": null,
"description": "# arctix\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/arctix/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/arctix/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/arctix/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/arctix/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/arctix/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/arctix/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://durandtibo.github.io/arctix/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/arctix/workflows/Documentation%20(stable)/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/arctix/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/arctix/workflows/Documentation%20(unstable)/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/arctix\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/arctix/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/arctix/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/61b8574ea18ecf106dce/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/arctix/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/61b8574ea18ecf106dce/test_coverage\" />\n </a>\n <br/>\n <a href=\"https://github.com/psf/black\">\n <img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\">\n </a>\n <a href=\"https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings\">\n <img alt=\"Doc style: google\" src=\"https://img.shields.io/badge/%20style-google-3666d6.svg\">\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href=\"https://github.com/guilatrova/tryceratops\">\n <img alt=\"Doc style: google\" src=\"https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black\">\n </a>\n <br/>\n <a href=\"https://pypi.org/project/arctix/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/arctix\">\n </a>\n <a href=\"https://pypi.org/project/arctix/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/arctix.svg\">\n </a>\n <a href=\"https://opensource.org/licenses/BSD-3-Clause\">\n <img alt=\"BSD-3-Clause\" src=\"https://img.shields.io/pypi/l/arctix\">\n </a>\n <br/>\n <a href=\"https://pepy.tech/project/arctix\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/arctix\">\n </a>\n <a href=\"https://pepy.tech/project/arctix\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/arctix/month\">\n </a>\n <br/>\n</p>\n\n## Overview\n\nThe `arctix` package consists of functionalities to prepare dataset of asynchronous time series.\nIt is design to make dataset preparation reusable and reproducible.\nFor each dataset, `arctix` provides 3 main functions:\n\n- `fetch_data` to load the raw data are loaded in\n a [`polars.DataFrame`](https://docs.pola.rs/py-polars/html/reference/dataframe/index.html). When\n possible, it downloads automatically the data.\n- `prepare_data` to prepare the data. It outputs the prepared data\n in [`polars.DataFrame`](https://docs.pola.rs/py-polars/html/reference/dataframe/index.html), and\n the metadata.\n- `to_array` to convert the prepared data to a dictionary of numpy arrays.\n\nFor example, it is possible to use the following lines to download and prepare the MultiTHUMOS data.\n\n```pycon\n\n>>> from pathlib import Path\n>>> from arctix.dataset.multithumos import fetch_data, prepare_data, to_array\n>>> dataset_path = Path(\"/path/to/dataset/multithumos\")\n>>> data_raw = fetch_data(dataset_path) # doctest: +SKIP\n>>> data, metadata = prepare_data(data_raw) # doctest: +SKIP\n>>> arrays = to_array(data) # doctest: +SKIP\n\n```\n\n- [Documentation](https://durandtibo.github.io/arctix/)\n- [Installation](#installation)\n- [Contributing](#contributing)\n- [API stability](#api-stability)\n- [License](#license)\n\n## Documentation\n\n- [latest (stable)](https://durandtibo.github.io/arctix/): documentation from the latest stable\n release.\n- [main (unstable)](https://durandtibo.github.io/arctix/main/): documentation associated to the\n main branch of the repo. This documentation may contain a lot of work-in-progress/outdated/missing\n parts.\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`arctix` can be installed from pip using the following command:\n\n```shell\npip install arctix\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `arctix` are\ninstalled.\nTo include all the packages, you can use the following command:\n\n```shell\npip install arctix[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/arctix/get_started) to see how to\ninstall only some specific packages or other alternatives to install the library.\nThe following is the corresponding `karbonn` versions and dependencies.\n\n| `batcharray` | `batcharray` | `coola` | `iden` | `numpy` | `polars` | `python` |\n|--------------|----------------|--------------|------------------|---------------|-----------------|---------------|\n| `main` | `>=0.0.2,<0.1` | `>=0.3,<1.0` | `\">=0.0.3,<1.0\"` | `>=1.22,<2.0` | `>=0.20.0,<1.0` | `>=3.9,<3.13` |\n| `0.0.5` | `>=0.0.2,<0.1` | `>=0.3,<1.0` | `\">=0.0.3,<1.0\"` | `>=1.22,<2.0` | `>=0.20.0,<1.0` | `>=3.9,<3.13` |\n| `0.0.4` | `>=0.0.2,<0.1` | `>=0.3,<1.0` | `\">=0.0.3,<1.0\"` | `>=1.22,<2.0` | `>=0.20.0,<1.0` | `>=3.9,<3.13` |\n| `0.0.3` | `>=0.0.2,<0.1` | `>=0.3,<1.0` | `\">=0.0.3,<1.0\"` | `>=1.22,<2.0` | `>=0.20.0,<1.0` | `>=3.9,<3.13` |\n\n## Contributing\n\nPlease check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n\n## API stability\n\n:warning: While `arctix` is in development stage, no API is guaranteed to be stable from one\nrelease to the next.\nIn fact, it is very likely that the API will change multiple times before a stable 1.0.0 release.\nIn practice, this means that upgrading `arctix` to a new version will possibly break any code that\nwas using the old version of `arctix`.\n\n## License\n\n`arctix` is licensed under BSD 3-Clause \"New\" or \"Revised\" license available in [LICENSE](LICENSE)\nfile.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": null,
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/durandtibo/arctix",
"Repository": "https://github.com/durandtibo/arctix"
},
"split_keywords": [
"asynchronous time-series",
" dataset",
" preprocessing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0009c58ea4dab3490bdc00dcda410c32bce4f2c66627e38451438d0dfab7d844",
"md5": "3ee21a7b8c5e3a1d77182ba6f46bac26",
"sha256": "4795cf14333253c9b5b4cd956f04b6613f8ea386356dec87b2abbdb7368dbd11"
},
"downloads": -1,
"filename": "arctix-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ee21a7b8c5e3a1d77182ba6f46bac26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 52960,
"upload_time": "2024-05-19T20:22:33",
"upload_time_iso_8601": "2024-05-19T20:22:33.917114Z",
"url": "https://files.pythonhosted.org/packages/00/09/c58ea4dab3490bdc00dcda410c32bce4f2c66627e38451438d0dfab7d844/arctix-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4d2a9ab4ad06f5b0797abfac470547b0e662c273e2a8c93397787eee17522ffe",
"md5": "ab6328334dce0fb39962e0cb659a20d5",
"sha256": "4fea7a1068aaeb99538ef4986b65ecccf362b5a8126135838e102500bb430ba0"
},
"downloads": -1,
"filename": "arctix-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "ab6328334dce0fb39962e0cb659a20d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 39099,
"upload_time": "2024-05-19T20:22:35",
"upload_time_iso_8601": "2024-05-19T20:22:35.748682Z",
"url": "https://files.pythonhosted.org/packages/4d/2a/9ab4ad06f5b0797abfac470547b0e662c273e2a8c93397787eee17522ffe/arctix-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-19 20:22:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "arctix",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "arctix"
}
JSON
