{"id":18723800,"url":"https://github.com/hscells/pybool_ir-ui","last_synced_at":"2025-08-24T13:08:56.210Z","repository":{"id":182262432,"uuid":"667475882","full_name":"hscells/pybool_ir-ui","owner":"hscells","description":"Straightforward SERPs for Lucene indexes","archived":false,"fork":false,"pushed_at":"2023-09-21T11:59:31.000Z","size":155,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T09:51:12.272Z","etag":null,"topics":["information-retrieval","lucene","pyserini","serp"],"latest_commit_sha":null,"homepage":"https://github.com/hscells/pybool_ir","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/hscells.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-17T15:32:02.000Z","updated_at":"2023-09-20T21:04:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"22cbd4b9-7399-49c9-9d10-bc6cb8fb56d2","html_url":"https://github.com/hscells/pybool_ir-ui","commit_stats":null,"previous_names":["hscells/pybool_ir-ui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hscells%2Fpybool_ir-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hscells%2Fpybool_ir-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hscells%2Fpybool_ir-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hscells%2Fpybool_ir-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hscells","download_url":"https://codeload.github.com/hscells/pybool_ir-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586218,"owners_count":21128998,"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":["information-retrieval","lucene","pyserini","serp"],"created_at":"2024-11-07T13:51:38.623Z","updated_at":"2025-04-12T15:20:22.180Z","avatar_url":"https://github.com/hscells.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pybool_ir-ui\n\n![Screenshot of pybool_ir-ui in action, with a PubMed index](ui-screenshot.png)\n\nThis is a library for creating search interfaces for indexes created with [pybool_ir](https://github.com/hscells/pybool_ir), however any index created with [Lucene](https://lucene.apache.org/) is also compatible, including those from [pyserini](https://github.com/castorini/pyserini/).\n\n**DEMO** https://pubmed.chatnoir.eu/\n\n## Installation\n\nCommand line:\n\n```bash\npip install -r requirements.txt\n```\n\nDocker:\n\n```bash\nmake docker-build\n```\n\n## Usage\n\nFirst, create a config file which specifies things like the index to use, and how the SERP should be rendered. For an example, take a look at [config-pubmed.toml](config-pubmed.toml).\n\nNext, edit [.env](.env) to point to your config file.\n\nThen, if you are running on the command line:\n\n```bash\nstreamlit run app.py\n```\n\nOr, if you are running in Docker:\n\n```bash\nmake docker-run\n```\n\n## Example\n\nWant to see it in action?\n\n1. Download and index the [CORD-19](https://www.semanticscholar.org/cord19) dataset.\n```bash\npybool_ir ir-datasets index -c cord19/trec-covid -i index-treccovid -s1\n```\n\n2. Edit the [.env](.env) file to point to [config-treccovid.toml](config-treccovid.toml).\n\n```bash\nPBIRUI_CONFIG_FILE=config-treccovid.toml\n```\n\n3. Run the UI.\n```bash\nstreamlit run app.py\n```\n\nOR\n\n```bash\nmake docker-run\n```\n\n## Extending\n\n### Implementing a SERP renderer\n\nImplementations of how SERPs are must be included in [serp.py](serp.py). There are already some default implementations.\n\n### Implementing a query parser\n\nImplementing new query parsers is a little more tricky than new SERP renderers. This requires implementing the [QueryParser](https://scells.me/pybool_ir/_autosummary/pybool_ir.query.parser.html) class from [pybool_ir](https://github.com/hscells/pybool_ir).\n\n## License\n\nMIT\n\n## Citing\n\nIf you use this library in your research, please cite [the following paper](https://dl.acm.org/doi/10.1145/3539618.3591819):\n\n```\n@inproceedings{scells2023pyboolir,\n    author = {Scells, Harrisen and Potthast, Martin},\n    title = {Pybool_ir: A Toolkit for Domain-Specific Search Experiments},\n    year = {2023},\n    booktitle = {Proceedings of the 46th International ACM SIGIR Conference on Research and Development in Information Retrieval},\n    pages = {3190–3194},\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhscells%2Fpybool_ir-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhscells%2Fpybool_ir-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhscells%2Fpybool_ir-ui/lists"}