{"id":18404486,"url":"https://github.com/durandtibo/arctix","last_synced_at":"2025-09-09T05:45:14.479Z","repository":{"id":175940683,"uuid":"654741997","full_name":"durandtibo/arctix","owner":"durandtibo","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-07T07:21:07.000Z","size":4575,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-07T09:17:58.034Z","etag":null,"topics":["asynchronous","polars-dataframe","python3","time-series"],"latest_commit_sha":null,"homepage":"https://durandtibo.github.io/arctix/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/durandtibo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-16T20:52:29.000Z","updated_at":"2025-09-07T07:21:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"871bf333-9180-4c98-aa17-6a60bdec1153","html_url":"https://github.com/durandtibo/arctix","commit_stats":null,"previous_names":["durandtibo/arctix"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/durandtibo/arctix","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/durandtibo%2Farctix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/durandtibo%2Farctix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/durandtibo%2Farctix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/durandtibo%2Farctix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/durandtibo","download_url":"https://codeload.github.com/durandtibo/arctix/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/durandtibo%2Farctix/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274101756,"owners_count":25222446,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asynchronous","polars-dataframe","python3","time-series"],"created_at":"2024-11-06T02:52:08.072Z","updated_at":"2025-09-09T05:45:14.468Z","avatar_url":"https://github.com/durandtibo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# arctix\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/durandtibo/arctix/actions\"\u003e\n        \u003cimg alt=\"CI\" src=\"https://github.com/durandtibo/arctix/workflows/CI/badge.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/durandtibo/arctix/actions\"\u003e\n        \u003cimg alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/arctix/workflows/Nightly%20Tests/badge.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/durandtibo/arctix/actions\"\u003e\n        \u003cimg alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/arctix/workflows/Nightly%20Package%20Tests/badge.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://codecov.io/gh/durandtibo/arctix\"\u003e\n        \u003cimg alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/arctix/branch/main/graph/badge.svg\"\u003e\n    \u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://durandtibo.github.io/arctix/\"\u003e\n        \u003cimg alt=\"Documentation\" src=\"https://github.com/durandtibo/arctix/workflows/Documentation%20(stable)/badge.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://durandtibo.github.io/arctix/\"\u003e\n        \u003cimg alt=\"Documentation\" src=\"https://github.com/durandtibo/arctix/workflows/Documentation%20(unstable)/badge.svg\"\u003e\n    \u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://github.com/psf/black\"\u003e\n        \u003cimg  alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings\"\u003e\n        \u003cimg  alt=\"Doc style: google\" src=\"https://img.shields.io/badge/%20style-google-3666d6.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/astral-sh/ruff\"\u003e\n        \u003cimg 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%;\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/guilatrova/tryceratops\"\u003e\n        \u003cimg  alt=\"Doc style: google\" src=\"https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black\"\u003e\n    \u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://pypi.org/project/arctix/\"\u003e\n        \u003cimg alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/arctix\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/arctix/\"\u003e\n        \u003cimg alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/arctix.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://opensource.org/licenses/BSD-3-Clause\"\u003e\n        \u003cimg alt=\"BSD-3-Clause\" src=\"https://img.shields.io/pypi/l/arctix\"\u003e\n    \u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://pepy.tech/project/arctix\"\u003e\n        \u003cimg  alt=\"Downloads\" src=\"https://static.pepy.tech/badge/arctix\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://pepy.tech/project/arctix\"\u003e\n        \u003cimg  alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/arctix/month\"\u003e\n    \u003c/a\u003e\n    \u003cbr/\u003e\n\u003c/p\u003e\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\u003e\u003e\u003e from pathlib import Path\n\u003e\u003e\u003e from arctix.dataset.multithumos import fetch_data, prepare_data, to_array\n\u003e\u003e\u003e dataset_path = Path(\"/path/to/dataset/multithumos\")\n\u003e\u003e\u003e data_raw = fetch_data(dataset_path)  # doctest: +SKIP\n\u003e\u003e\u003e data, metadata = prepare_data(data_raw)  # doctest: +SKIP\n\u003e\u003e\u003e 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`       | `\u003e=0.1,\u003c1.0`   | `\u003e=0.8.4,\u003c1.0` | `\"\u003e=0.1,\u003c1.0\"`   | `\u003e=1.22,\u003c3.0` | `\u003e=1.0,\u003c2.0`    | `\u003e=3.9,\u003c3.14` |\n| `0.0.8`      | `\u003e=0.1,\u003c1.0`   | `\u003e=0.8.4,\u003c1.0` | `\"\u003e=0.1,\u003c1.0\"`   | `\u003e=1.22,\u003c3.0` | `\u003e=1.0,\u003c2.0`    | `\u003e=3.9,\u003c3.14` |\n| `0.0.7`      | `\u003e=0.0.2,\u003c1.0` | `\u003e=0.3,\u003c1.0`   | `\"\u003e=0.0.3,\u003c1.0\"` | `\u003e=1.22,\u003c3.0` | `\u003e=1.0,\u003c2.0`    | `\u003e=3.9,\u003c3.13` |\n| `0.0.6`      | `\u003e=0.0.2,\u003c0.1` | `\u003e=0.3,\u003c1.0`   | `\"\u003e=0.0.3,\u003c1.0\"` | `\u003e=1.22,\u003c2.0` | `\u003e=0.20.0,\u003c1.0` | `\u003e=3.9,\u003c3.13` |\n| `0.0.5`      | `\u003e=0.0.2,\u003c0.1` | `\u003e=0.3,\u003c1.0`   | `\"\u003e=0.0.3,\u003c1.0\"` | `\u003e=1.22,\u003c2.0` | `\u003e=0.20.0,\u003c1.0` | `\u003e=3.9,\u003c3.13` |\n| `0.0.4`      | `\u003e=0.0.2,\u003c0.1` | `\u003e=0.3,\u003c1.0`   | `\"\u003e=0.0.3,\u003c1.0\"` | `\u003e=1.22,\u003c2.0` | `\u003e=0.20.0,\u003c1.0` | `\u003e=3.9,\u003c3.13` |\n| `0.0.3`      | `\u003e=0.0.2,\u003c0.1` | `\u003e=0.3,\u003c1.0`   | `\"\u003e=0.0.3,\u003c1.0\"` | `\u003e=1.22,\u003c2.0` | `\u003e=0.20.0,\u003c1.0` | `\u003e=3.9,\u003c3.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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdurandtibo%2Farctix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdurandtibo%2Farctix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdurandtibo%2Farctix/lists"}