{"id":19588924,"url":"https://github.com/mggg/gerrychainjulia","last_synced_at":"2025-04-27T12:32:00.527Z","repository":{"id":46156762,"uuid":"239854101","full_name":"mggg/GerryChainJulia","owner":"mggg","description":"A high-performance implementation of GerryChain in Julia","archived":false,"fork":false,"pushed_at":"2022-01-03T17:42:31.000Z","size":3993,"stargazers_count":19,"open_issues_count":23,"forks_count":12,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-11T05:35:16.515Z","etag":null,"topics":["gerrychain","julia"],"latest_commit_sha":null,"homepage":"https://mggg.github.io/GerryChainJulia/stable/","language":"Julia","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mggg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-11T20:08:15.000Z","updated_at":"2023-01-26T00:50:08.000Z","dependencies_parsed_at":"2022-08-23T11:10:38.157Z","dependency_job_id":null,"html_url":"https://github.com/mggg/GerryChainJulia","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mggg%2FGerryChainJulia","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mggg%2FGerryChainJulia/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mggg%2FGerryChainJulia/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mggg%2FGerryChainJulia/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mggg","download_url":"https://codeload.github.com/mggg/GerryChainJulia/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224069367,"owners_count":17250456,"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":["gerrychain","julia"],"created_at":"2024-11-11T08:16:34.298Z","updated_at":"2024-11-11T08:16:36.074Z","avatar_url":"https://github.com/mggg.png","language":"Julia","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GerryChain\n\n![Build and Test status](https://github.com/mggg/GerryChainJulia/workflows/Build%20and%20Test/badge.svg)\n[![Code Coverage](https://codecov.io/gh/mggg/GerryChainJulia/branch/main/graph/badge.svg)](https://codecov.io/gh/mggg/GerryChainJulia/branch/main)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4649464.svg)](https://doi.org/10.5281/zenodo.4649464)\n\n[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://mggg.github.io/GerryChainJulia/stable)\n[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://mggg.github.io/GerryChainJulia/dev)\n\n`GerryChain` is a Julia package for building ensembles of districting plans using [Markov Chain Monte Carlo](https://en.wikipedia.org/wiki/Markov_chain_Monte_Carlo) techniques. It is developed and maintained by the [Metric Geometry and Gerrymandering Group](https://www.mggg.org/) and our network of volunteers. We also have [a Python package of the same name](https://github.com/mggg/GerryChain).\n\nThe basic workflow is to start with the geometry of an initial plan and generate a large collection of sample plans for comparison. Usually, we will constrain these sampled plans in such a way that they perform at least as well as the initial plan according to traditional districting principles, such as population balance or compactness. Comparing the initial plan to the ensemble provides quantitative tools for measuring whether or not it is an outlier among the sampled plans.\n\n## Getting set up\nIf you already have Julia installed, then installing `GerryChain` is easy using Julia's in-built package manager `Pkg`.\n```\nusing Pkg; Pkg.add(\"GerryChain\")\nusing GerryChain\n```\nIf you need to install Julia, use Julia in Jupyter Notebooks or use learn how to use `GerryChain` in a specific virtual environment, head over to [our more detailed setup instructions](https://mggg.github.io/GerryChainJulia/stable/installation/).\n\n## Useful links\nPlease refer to [our documentation pages](https://mggg.github.io/GerryChainJulia/stable) for API references.\n\nFollow [this link](https://mggg.github.io/GerryChainJulia/stable/getting_started/) if you want to get started on your first chain already.\n\nIf you want to contribute to this project, please check [our contributing guidelines](https://github.com/mggg/GerryChainJulia/blob/main/CONTRIBUTING.md).\n\nIf you have any issues or requests, please do not hesitate to [raise an issue.](https://github.com/mggg/GerryChainJulia/issues)\n\n## Citations\nYou can cite the Recombination algorithm as\n```\n@article{DeFord2021Recombination,\njournal = {Harvard Data Science Review},\ndoi = {10.1162/99608f92.eb30390f},\nnote = {https://hdsr.mitpress.mit.edu/pub/1ds8ptxu},\ntitle = {Recombination: A Family of Markov Chains for Redistricting},\nurl = {https://hdsr.mitpress.mit.edu/pub/1ds8ptxu},\nauthor = {DeFord, Daryl and Duchin, Moon and Solomon, Justin},\ndate = {2021-03-31},\nyear = {2021},\nmonth = {3},\nday = {31},\n}\n```\nThe current version of the code can be cited as\n```\n@software{gerrychain_julia_4649464,\n  author       = {Parker Rule and\n                  Matthew Sun and\n                  Bhushan Suwal\n                  },\n  title        = {mggg/GerryChainJulia: Minor fixes + Save as HDF5},\n  month        = mar,\n  year         = 2021,\n  publisher    = {Zenodo},\n  version      = {v0.1.3},\n  doi          = {10.5281/zenodo.4649464},\n  url          = {https://doi.org/10.5281/zenodo.4649464}\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmggg%2Fgerrychainjulia","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmggg%2Fgerrychainjulia","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmggg%2Fgerrychainjulia/lists"}