{"id":16806143,"url":"https://github.com/pkgw/rubbl-rxpackage","last_synced_at":"2025-08-27T01:45:35.522Z","repository":{"id":53099729,"uuid":"192822596","full_name":"pkgw/rubbl-rxpackage","owner":"pkgw","description":"Radio astronomy reduction utilities written in Rust, using the Rubbl framework","archived":false,"fork":false,"pushed_at":"2025-04-17T20:00:51.000Z","size":188,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-18T09:50:31.587Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","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/pkgw.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":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-20T00:38:09.000Z","updated_at":"2025-04-17T20:00:52.000Z","dependencies_parsed_at":"2023-01-31T19:45:50.429Z","dependency_job_id":null,"html_url":"https://github.com/pkgw/rubbl-rxpackage","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/pkgw/rubbl-rxpackage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Frubbl-rxpackage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Frubbl-rxpackage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Frubbl-rxpackage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Frubbl-rxpackage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pkgw","download_url":"https://codeload.github.com/pkgw/rubbl-rxpackage/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Frubbl-rxpackage/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272277571,"owners_count":24905522,"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-08-26T02:00:07.904Z","response_time":60,"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":[],"created_at":"2024-10-13T09:50:12.204Z","updated_at":"2025-08-27T01:45:35.468Z","avatar_url":"https://github.com/pkgw.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rubbl-rxpackage\n\nA collection of miscellaneous astronomical data reduction utilities written in\nRust, based on the [rubbl] framework (“Rust + Hubble = rubbl = astrophysics in\nRust”). These are mainly aimed at analyzing data from the Very Large Array,\nwhere the data sets can get very large. Certain data-intensive operations are\ntoo slow for Python, but I find working in C++ to be extremely unpleasant.\nRust provides the speed of C++ but massively improved ergonomics.\n\n[rubbl]: https://github.com/pkgw/rubbl\n\nThe name `rxpackage` is my shorthand for “[data] reduction package”.\n\n\n## Available tools\n\n- `rubbl rxpackage flagts` — print a time series of flagging statistics\n- `rubbl rxpackage peel` — use source-specific calibration tables to implement\n  “peeling” of a bright off-axis source. The intended workflow with which this\n  tool assists is described briefly in the research note\n  [Williams et al., 2019 RNAAS 3 110] (DOI: [10.3847/2515-5172/ab35d5]).\n- `rubbl rxpackage spwglue` — combine adjacent spectral windows into one big\n  one\n\n[Williams et al., 2019 RNAAS 3 110]: https://doi.org/10.3847/2515-5172/ab35d5\n[10.3847/2515-5172/ab35d5]: https://doi.org/10.3847/2515-5172/ab35d5\n\nThere are also:\n\n- `rubbl rxpackage show version-doi` — show the DOI of the current version of\n  the software package; you can use this for citing rubbl-rxpackage\n- `rubbl rxpackage show concept-doi` — show the \"concept DOI\" of\n  rubbl-rxpackage; this is included for completeness but is probably not what\n  you want. If in doubt, use the `version-doi` command.\n\n\n## Installation\n\nPrebuilt binaries are not provided. You need a Rust build toolchain installed.\nIf it's available, installation should be possible by just running:\n\n```\ncargo install --force --path .\n```\n\nThat will make available the command-line program `rubbl-rxpackage`. If you’ve\ngot the core `rubbl` command installed, the tools should also be accessible by\nrunning `rubbl rxpackage`.\n\n\n## Versioning\n\nWhen you check out the main branch, you might notice that everything is built\nwith version `0.0.0`. This is because this project uses the [just-in-time\nversioning][jitv] workflow as implemented by [Cranko]. Version numbers are\nassigned inside the CI/CD pipeline. See [the GitHub release\nhistory][gh-releases] for release history and changelogs.\n\n[jitv]: https://pkgw.github.io/cranko/book/latest/jit-versioning/\n[Cranko]: https://pkgw.github.io/cranko/book/latest/\n[gh-releases]: https://github.com/pkgw/rubbl-rxpackage/releases\n\n\n## Citation\n\nIf you use this software in academic work, you must cite it appropriately in\nyour research outputs.\n\nTo do so, you should reference *two* things: the entity that is the specific\nversion of the software you used, *and* the publication that describes that\nsoftware. Both of these things have DOIs, but they are different things with\ndifferent DOIs.\n\nIn particular:\n\n- To cite *the software itself*, obtain the DOI of the release that you're\n  running by executing the command `rubbl rxpackage show version-doi`. To create\n  a BibTeX entry corresponding to that release, point your browser to\n  `https://doi.org/{the-version-doi}`, which should take you to the [Zenodo]\n  landing page for the release. Then find and follow the “BibTeX export” link.\n- You should also cite the publication describing the software,\n  [Williams et al., 2019 RNAAS 3 110], which has DOI\n  [10.3847/2515-5172/ab35d5]. Here is a BibTeX entry for this publication:\n  ```\n  @article{Williams_2019,\n\tdoi = {10.3847/2515-5172/ab35d5},\n\turl = {https://doi.org/10.3847%2F2515-5172%2Fab35d5},\n\tyear = 2019,\n\tmonth = {jul},\n\tpublisher = {American Astronomical Society},\n\tvolume = {3},\n\tnumber = {7},\n\tpages = {110},\n\tauthor = {P. K. G. Williams and K. N. Allers and B. A. Biller and J. Vos},\n\ttitle = {A Tool and Workflow for Radio Astronomical {\\textquotedblleft}Peeling{\\textquotedblright} in {CASA}},\n\tjournal = {Research Notes of the {AAS}}\n  }\n  ```\n- There is nothing wrong with linking to this software’s GitHub repository for\n  completeness, but such a link does not have long-term archival guarantees\n  and is not “dereferenceable” by metadata tools.\n- Adding everything up, in a gold-standard publication you might write:\n  ```\n  The open-source software package\n  \\textsf{rubbl-rxpackage}\\footnote{Development currently hosted at\n  \\url{https://github.com/pkgw/rubbl-rxpackage}.} provides tools for\n  implementing interferometric ``peeling'' \\citep{Williams_2019}. We performed\n  this procedure, using the workflow described by \\citet{Williams_2019}, with\n  version 0.1.0 of the software, which is archived in Zenodo\n  \\citep{rubbl_rxpackage_0.1.0}.\n  ```\n\n[Zenodo]: https://zenodo.org/\n\n\n## Legalities\n\nThese files are copyright Peter Williams and collaborators. They are licensed\nunder the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpkgw%2Frubbl-rxpackage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpkgw%2Frubbl-rxpackage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpkgw%2Frubbl-rxpackage/lists"}