{"id":24508486,"url":"https://github.com/aplbrain/bossphorus-python","last_synced_at":"2025-08-18T03:35:41.415Z","repository":{"id":73813603,"uuid":"124905530","full_name":"aplbrain/bossphorus-python","owner":"aplbrain","description":"bossphorus is a simple volumetric datastore for dense 3D data.","archived":false,"fork":false,"pushed_at":"2020-02-23T21:58:42.000Z","size":3094,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T09:22:42.406Z","etag":null,"topics":["3d","bossdb","dense-3d-data","docker","jhuapl","neuroscience","volume"],"latest_commit_sha":null,"homepage":"https://aplbrain.github.io/bossphorus/#","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aplbrain.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-03-12T14:54:50.000Z","updated_at":"2020-07-06T21:13:43.000Z","dependencies_parsed_at":"2023-07-16T07:15:51.381Z","dependency_job_id":null,"html_url":"https://github.com/aplbrain/bossphorus-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aplbrain/bossphorus-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aplbrain","download_url":"https://codeload.github.com/aplbrain/bossphorus-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aplbrain%2Fbossphorus-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270940583,"owners_count":24671674,"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-18T02:00:08.743Z","response_time":89,"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":["3d","bossdb","dense-3d-data","docker","jhuapl","neuroscience","volume"],"created_at":"2025-01-22T00:16:40.218Z","updated_at":"2025-08-18T03:35:41.404Z","avatar_url":"https://github.com/aplbrain.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n \u003cimg align=\"center\" alt=\"bossphorus\" src=\"./logo.png\" width=\"100\" /\u003e\n \u003ch1 align=\"center\" fontsize=\"2em\"\u003eb o s s p h o r u s\u003c/h1\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003ea simple volumetric datastore for dense 3D data\u003c/p\u003e\n\n\u003cp align=center\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/bossphorus.svg\" /\u003e\n    \u003cimg src=\"https://img.shields.io/github/last-commit/aplbrain/bossphorus.svg\" /\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Extremely Rad-👌-00ddcc.svg\" /\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/aplbrain/bossphorus.svg\" /\u003e\n\u003c/p\u003e\n\n\n\u003e **WARNING!** *Bossphorus* is **NOT** stable and **NOT** tested. Use at your own risk, and always keep a backup copy of your data someplace safe.\n\n## bossDB Feature Parity\n\nFor more information, see our [Features](features.md) page.\n\n## Why use bossphorus?\n\n*bossphorus* simplifies data-access patterns for data that do not fit into RAM. When you write a 100-gigabyte file, *bossphorus* automatically slices your dataset up to fit in bite-sized pieces.\n\nWhen you request small pieces of your data for analysis, *bossphorus* intelligently serves only the parts you need, leaving the rest on disk.\n\n## Usage\n\nYou can either run *bossphorus* using Python on your host machine, or use the provided Dockerfile to run *bossphorus* in a Docker container.\n\n### Docker Method (Preferred)\n\n#### 1. Build the docker image\n\n```shell\ndocker build -t bossphorus .\n```\n\n#### 2. Create a directory for your filesystem to live in.\n\n```shell\nmkdir ./uploads\n```\n\n#### 3. Source the provided alias file.\n\nThis exposes a simplified wrapper to run *bossphorus* in a container.\n\n```shell\nsource alias\n```\n\n#### 4. Run *bossphorus*!\n\n```shell\nbossphorus $(pwd)/uploads\n```\n\nYou can run *bossphorus* in demo-mode by omitting the path to your uploads directory. **Data saved to bossphorus using this method will be destroyed when you end the bossphorus process!** Use only when testing *bossphorus* out.\n\n### Native Method\n\n```shell\npipenv install\nmkdir ./uploads\npython3 ./run.py\n```\n\n#### pip Method\n\n```shell\npip3 install -U bossphorus\n```\n\n## Configuration\n\nYou can modify the top-level variables in `bossphorus/config.py` in order to change where bossphorus stores its data by default, and what size each file is by default.\n\nA word of warning: While larger values of `BLOCK_SIZE` will reduce the amount of parallel threads in order to read a small file, it will also increase RAM usage per read. 256\u003csup\u003e3\u003c/sup\u003e is probably a good default, unless you have a very good reason to change it.\n\n---\n\n### Why bossphorus instead of other volumetric services?\n\nThat's a great question! *bossphorus* is certainly not the most performant, nor is it the most secure. And it's not versioned or distributed. If you're looking for a volumetric datastore, I would recommend looking below at the _Alternatives_ section for some really well-engineered systems.\n\nThe primary advantage of *bossphorus* is that it uses an identical API to that of [bossDB](https://bossdb.org) — and so if you anticipate your data growing from a few gigabytes now to a few terabytes later, you can get used to the bossDB ecosystem ([intern](https://https://github.com/jhuapl-boss/intern), [ingest](https://github.com/jhuapl-boss/ingest-client), and [many more tools](https://github.com/aplbrain/)) _now_, and then invest in real bossDB architecture later on with a seamless transition.\n\n## Why is it called bossphorus?\n\n*bossphorus* borrows its indexing pattern from _[bossDB](https://bossdb.org)_, a cloud-native database that can store way more data than *bossphorus* ever could. If your day-to-day routine includes multiple terabytes of volumetric data, [bossDB](https://bossdb.org) may be for you.\n\n## Alternatives\n\n| Project | Description | If you want... |\n|---------|-------------|----------------|\n| [bossDB](https://bossdb.org) | Petabyte-scale, Cloud-Native Volumetric Database | ...faster IO speed and infinite scalability |\n| [DVID](https://github.com/janelia-flyem/dvid) | Distributed, Versioned, Image-oriented Dataservice | ...versioned data |\n\n\n## Contributing\n\n### Updating the Documentation\n\nWhen you make any changes to outward-facing APIs or services, you must update the documentation. To do so, run the following:\n\n```shell\ncd website/                                # enter the docusaurus dir\nyarn                                       # install dependencies\nGIT_USER=XXXX yarn run publish-gh-pages    # build and upload the documentation\n```\n\n-----\n\n\u003cp align=\"center\"\u003e\u003csmall\u003eMade with 💙 at \u003ca href=\"http://www.jhuapl.edu/\"\u003e\u003cimg alt=\"JHU APL\" align=\"center\" src=\"./website/static/img/apl-logo.png\" height=\"23px\"\u003e\u003c/a\u003e\u003c/small\u003e\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faplbrain%2Fbossphorus-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faplbrain%2Fbossphorus-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faplbrain%2Fbossphorus-python/lists"}