{"id":13869690,"url":"https://github.com/glotzerlab/signac","last_synced_at":"2025-04-08T06:32:59.722Z","repository":{"id":37548384,"uuid":"168432220","full_name":"glotzerlab/signac","owner":"glotzerlab","description":"Manage large and heterogeneous data spaces on the file system.","archived":false,"fork":false,"pushed_at":"2025-03-10T20:45:52.000Z","size":7602,"stargazers_count":132,"open_issues_count":11,"forks_count":36,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-04-01T04:51:41.373Z","etag":null,"topics":["data","data-management","database","reproducibility"],"latest_commit_sha":null,"homepage":"https://signac.io/","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/glotzerlab.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.txt","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":"governance.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-30T23:37:23.000Z","updated_at":"2025-03-10T20:45:55.000Z","dependencies_parsed_at":"2023-11-14T16:38:40.089Z","dependency_job_id":"8b403dd5-d72e-45f9-8321-0133b8a5b510","html_url":"https://github.com/glotzerlab/signac","commit_stats":{"total_commits":2349,"total_committers":44,"mean_commits":53.38636363636363,"dds":0.3299276287782035,"last_synced_commit":"0ce8797f5b3e0b8a7e5685c622a690be5cb8762d"},"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fsignac","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fsignac/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fsignac/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glotzerlab%2Fsignac/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glotzerlab","download_url":"https://codeload.github.com/glotzerlab/signac/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247791946,"owners_count":20996870,"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","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":["data","data-management","database","reproducibility"],"created_at":"2024-08-05T20:01:12.061Z","updated_at":"2025-04-08T06:32:59.695Z","avatar_url":"https://github.com/glotzerlab.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# \u003cimg src=\"https://raw.githubusercontent.com/glotzerlab/signac/main/doc/images/palette-header.png\" width=\"75\" height=\"58\"\u003e signac - simple data management\r\n\r\n[![Affiliated with NumFOCUS](https://img.shields.io/badge/NumFOCUS-affiliated%20project-orange.svg?style=flat\u0026colorA=E1523D\u0026colorB=007D8A)](https://numfocus.org/sponsored-projects/affiliated-projects)\r\n[![PyPI](https://img.shields.io/pypi/v/signac.svg)](https://pypi.org/project/signac/)\r\n[![conda-forge](https://img.shields.io/conda/vn/conda-forge/signac.svg?style=flat)](https://anaconda.org/conda-forge/signac)\r\n[![GitHub Actions](https://github.com/glotzerlab/signac/actions/workflows/run-pytest.yml/badge.svg)](https://github.com/glotzerlab/signac/actions)\r\n[![RTD](https://img.shields.io/readthedocs/signac.svg?style=flat)](https://signac.readthedocs.io/)\r\n[![License](https://img.shields.io/github/license/glotzerlab/signac.svg)](https://github.com/glotzerlab/signac/blob/main/LICENSE.txt)\r\n[![PyPI-downloads](https://img.shields.io/pypi/dm/signac.svg?style=flat)](https://pypistats.org/packages/signac)\r\n[![Slack](https://img.shields.io/badge/Slack-chat%20support-brightgreen.svg?style=flat\u0026logo=slack)](https://signac.readthedocs.io/slack-invite/)\r\n[![Twitter](https://img.shields.io/twitter/follow/signacdata?style=social)](https://twitter.com/signacdata)\r\n[![GitHub Stars](https://img.shields.io/github/stars/glotzerlab/signac?style=social)](https://github.com/glotzerlab/signac/)\r\n\r\nThe [**signac** framework](https://signac.readthedocs.io/) helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility.\r\n\r\nIt provides a simple and robust data model to create a well-defined indexable storage layout for data and metadata.\r\nThis makes it easier to operate on large data spaces, streamlines post-processing and analysis and makes data collectively accessible.\r\n\r\n## Resources\r\n\r\n- [Framework documentation](https://signac.readthedocs.io/):\r\n  Examples, tutorials, topic guides, and package Python APIs.\r\n- [Package documentation](https://signac.readthedocs.io/projects/core/):\r\n  API reference for the **signac** package.\r\n- [Discussion board](https://github.com/glotzerlab/signac/discussions/):\r\n  Ask the **signac** user community for help.\r\n\r\n## Installation\r\n\r\nThe recommended installation method for **signac** is through **conda** or **pip**.\r\nThe software is tested for Python 3.8+ and is built for all major platforms.\r\n\r\nTo install **signac** *via* the [conda-forge](https://conda-forge.github.io/) channel, execute:\r\n\r\n```bash\r\nconda install -c conda-forge signac\r\n```\r\n\r\nTo install **signac** *via* **pip**, execute:\r\n\r\n```bash\r\npip install signac\r\n```\r\n\r\n**Detailed information about alternative installation methods can be found in the [documentation](https://signac.readthedocs.io/en/latest/installation.html).**\r\n\r\n## Quickstart\r\n\r\nThe framework facilitates a project-based workflow.\r\nSet up a new project:\r\n\r\n```bash\r\n$ mkdir my_project\r\n$ cd my_project\r\n$ signac init\r\n```\r\n\r\nand access the project handle:\r\n\r\n```python\r\n\u003e\u003e\u003e project = signac.get_project()\r\n```\r\n\r\n## Testing\r\n\r\nYou can test this package by executing:\r\n\r\n```bash\r\n$ python -m pytest tests/\r\n```\r\n\r\n## Acknowledgment\r\n\r\nWhen using **signac** as part of your work towards a publication, we would really appreciate that you acknowledge **signac** appropriately.\r\nWe have prepared examples on how to do that [here](https://signac.readthedocs.io/en/latest/acknowledge.html).\r\n**Thank you very much!**\r\n\r\nThe signac framework is a [NumFOCUS Affiliated Project](https://numfocus.org/sponsored-projects/affiliated-projects).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglotzerlab%2Fsignac","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglotzerlab%2Fsignac","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglotzerlab%2Fsignac/lists"}