{"id":28614642,"url":"https://github.com/angelo-peronio/gsffile","last_synced_at":"2025-10-05T03:58:04.292Z","repository":{"id":246873449,"uuid":"821387178","full_name":"angelo-peronio/gsffile","owner":"angelo-peronio","description":"A Python module to read and write Gwyddion Simple Field files","archived":false,"fork":false,"pushed_at":"2025-09-29T19:27:55.000Z","size":323,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-29T21:32:48.097Z","etag":null,"topics":["gsf","gwyddion","gwyddion-simple-field","numpy","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/angelo-peronio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"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":"2024-06-28T12:29:32.000Z","updated_at":"2025-09-29T19:27:59.000Z","dependencies_parsed_at":"2024-10-28T13:55:43.551Z","dependency_job_id":"7331f4ce-71a2-45e5-9eef-256806caaff5","html_url":"https://github.com/angelo-peronio/gsffile","commit_stats":null,"previous_names":["angelo-peronio/gsffile"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/angelo-peronio/gsffile","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angelo-peronio%2Fgsffile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angelo-peronio%2Fgsffile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angelo-peronio%2Fgsffile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angelo-peronio%2Fgsffile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/angelo-peronio","download_url":"https://codeload.github.com/angelo-peronio/gsffile/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angelo-peronio%2Fgsffile/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278406561,"owners_count":25981657,"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-10-05T02:00:06.059Z","response_time":54,"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":["gsf","gwyddion","gwyddion-simple-field","numpy","python"],"created_at":"2025-06-12T02:00:45.644Z","updated_at":"2025-10-05T03:58:04.222Z","avatar_url":"https://github.com/angelo-peronio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Read and write Gwyddion Simple Field files\n\n[![pypi](https://img.shields.io/pypi/v/gsffile)](https://pypi.org/project/gsffile/)\n[![conda-forge](https://img.shields.io/conda/vn/conda-forge/gsffile)](https://anaconda.org/conda-forge/gsffile)\n[![pypi downloads](https://img.shields.io/pypi/dm/gsffile)](https://pypistats.org/packages/gsffile)\n[![license](https://img.shields.io/github/license/angelo-peronio/gsffile?color=4CC71E)](https://github.com/angelo-peronio/gsffile/blob/master/LICENSE)\n[![python](https://img.shields.io/pypi/pyversions/gsffile)](https://pypi.org/project/gsffile/)\n[![ci](https://github.com/angelo-peronio/gsffile/actions/workflows/ci.yaml/badge.svg)](https://github.com/angelo-peronio/gsffile/actions/workflows/ci.yaml)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/angelo-peronio/gsffile/master.svg)](https://results.pre-commit.ci/latest/github/angelo-peronio/gsffile/master)\n[![codecov](https://codecov.io/github/angelo-peronio/gsffile/graph/badge.svg)](https://codecov.io/github/angelo-peronio/gsffile)\n[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json)](https://docs.astral.sh/ruff/)\n[![DOI](https://zenodo.org/badge/821387178.svg)](https://doi.org/10.5281/zenodo.16998022)\n\n`gsffile` is a Python module to:\n\n* read image and metadata from [Gwyddion Simple Field](http://gwyddion.net/documentation/user-guide-en/gsf.html) (.gsf) files, and\n* store NumPy arrays in Gwyddion Simple Field files.\n\nIt features type annotations, minimal logging, and an overgrown test suite.\n\n## Setup\n\nInstall with `pip`\n\n```bash\npython -m pip install gsffile\n```\n\nor with `conda`\n\n```bash\nconda install gsffile\n```\n\n## Quickstart\n\n```python\n\u003e\u003e\u003e from gsffile import read_gsf, write_gsf\n\u003e\u003e\u003e import numpy as np\n\n# The Gwyddion Simple Field format supports only 32-bit floating point data.\n\u003e\u003e\u003e data = np.eye(100, dtype=np.float32)\n\n# Optional metadata.\n\u003e\u003e\u003e metadata = {\n...    \"XReal\": 5e-05,\n...    \"YReal\": 5e-05,\n...    \"XYUnits\": \"m\",\n...    \"ZUnits\": \"V\",\n...    \"CustomKey\": 33,\n...    }\n\n\u003e\u003e\u003e write_gsf(\"example.gsf\", data, metadata)\n\n\u003e\u003e\u003e data, metadata = read_gsf(\"example.gsf\")\n\n```\n\n## Documentation\n\n`gsffile` is documented via docstrings:\n\n```bash\npython -c \"import gsffile; help(gsffile)\"\n```\n\n## How to cite\n\nCite `gsffile` in your published work using the metadata in [`CITATION.cff`](CITATION.cff).\nSpecific DOIs and BibTeX entries for each released version can be found on [Zenodo](https://doi.org/10.5281/zenodo.16998022).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangelo-peronio%2Fgsffile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fangelo-peronio%2Fgsffile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangelo-peronio%2Fgsffile/lists"}