{"id":32175936,"url":"https://github.com/dioptas/dioptas","last_synced_at":"2026-04-02T13:18:08.870Z","repository":{"id":25870937,"uuid":"29311026","full_name":"Dioptas/Dioptas","owner":"Dioptas","description":"Python based GUI-Program for integration and exploration of 2D x-ray diffraction images. ","archived":false,"fork":false,"pushed_at":"2025-06-23T07:28:50.000Z","size":189438,"stargazers_count":63,"open_issues_count":19,"forks_count":39,"subscribers_count":10,"default_branch":"develop","last_synced_at":"2025-10-21T19:51:41.775Z","etag":null,"topics":["diffraction","diffraction-analysis","gui","python","synchrotron","x-ray"],"latest_commit_sha":null,"homepage":"","language":"Python","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/Dioptas.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE.txt","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":"2015-01-15T18:16:12.000Z","updated_at":"2025-08-31T06:09:00.000Z","dependencies_parsed_at":"2025-06-22T10:33:31.156Z","dependency_job_id":null,"html_url":"https://github.com/Dioptas/Dioptas","commit_stats":{"total_commits":2203,"total_committers":21,"mean_commits":104.9047619047619,"dds":"0.17385383567862012","last_synced_commit":"5ad4838404f9c3279d0c40d2573171a47a6feaf8"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/Dioptas/Dioptas","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dioptas%2FDioptas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dioptas%2FDioptas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dioptas%2FDioptas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dioptas%2FDioptas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dioptas","download_url":"https://codeload.github.com/Dioptas/Dioptas/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dioptas%2FDioptas/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280325298,"owners_count":26311419,"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-21T02:00:06.614Z","response_time":58,"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":["diffraction","diffraction-analysis","gui","python","synchrotron","x-ray"],"created_at":"2025-10-21T19:52:02.268Z","updated_at":"2026-04-02T13:18:08.864Z","avatar_url":"https://github.com/Dioptas.png","language":"Python","readme":"# Dioptas\n\nA GUI program for fast analysis of powder X-ray diffraction Images. It provides the capability of calibrating,\ncreating masks, having pattern overlays and showing phase lines.\n\n## Maintainer\n\nClemens Prescher (clemens.prescher@gmail.com)\n\n## Requirements\n\n    * python 3.9+\n\nIt is known to run on Windows, Mac and Linux. For optimal usage on a Windows machine it should be run with 64 bit\npython.\n\n## Installation\n\n### Executables\n\nExecutable versions for Windows, Mac OsX and Linux (all 64bit) can be downloaded from:\n\nhttps://github.com/Dioptas/Dioptas/releases\n\nThe executable versions are self-contained folders, which do not need any python installation.\nUnder Windows and Linux the program can be started by running the executable (e.g. Dioptas.exe or Dioptas).\nUnder MacOS X the download will contain a `.tar.gz` archive. Extract it first, then right-click the `.app` folder and select \"Open\" to start the program.\n\nIf macOS shows a warning that the app \"cannot be verified\", you need to remove the quarantine attribute by running the following command in the Terminal:\n\n```bash\nfind Dioptas_*.app -exec xattr -c {} \\;\n```\n\n### Python Package\n\nThe easiest way to install the dioptas python package is using pip.\n\n```bash\npip install dioptas\n```\n\nand then run Dioptas by typing:\n\n```bash\ndioptas\n```\n\nin the commandline.\n\nWe also maintain a conda-forge version of dioptas.\nYou can add the conda-forge channel to your conda distribution and then install dioptas via conda should be working correctly.\n\n```bash\nconda config --add channels conda-forge\nconda install dioptas\n```\n\n## Running the Program from source\n\nIn order to run the program from source, the easiest way is to use the uv package manager.\nClone the repository from github and navigate to the repository:\n\n```bash\ngit clone https://github.com/Dioptas/Dioptas.git\ncd Dioptas\n```\n\nNote: This will clone the `develop` branch by default, which contains the latest development version.\nIf you want to use the latest stable release instead, switch to the `main` branch after cloning:\n\n```bash\ngit checkout main\n```\n\nInstall uv and the dependencies by running:\n\n```bash\npython -m pip install uv\nuv sync\n```\n\nThis will create a new environment with all the required python packages in `.venv`.\n\nAfterward the program can be started by running:\n\n```bash\nuv run dioptas\n```\n\nIn order to run the program without uv, you need to install the required packages yourself.\nThe packages are listed in the file `pyproject.toml`. The program can then be started by running:\n\n```bash\npython run.py\n```\n\n## Scripting API\n\nDioptas can also be used as a Python library for headless integration from scripts and Jupyter notebooks.\nSet up your experiment in the GUI, save a `.dio` project file, then use it in code:\n\n```python\nfrom dioptas.pipeline import Pipeline\n\n# Load full setup (calibration, mask, corrections, etc.) from a project file\np = Pipeline.from_project(\"experiment.dio\")\n\n# Override the mask if needed\np.load_mask(\"new_beamstop.mask\")\n\n# Integrate a single image\npattern = p.integrate(\"sample_001.tiff\")\npattern.save(\"sample_001.xy\")\n\n# Batch integrate with a glob pattern\npatterns = p.integrate_batch(\"data/sample_*.tif\")\n```\n\nSee the [scripting API documentation](docs/source/scripting_api.rst) for the full reference.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdioptas%2Fdioptas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdioptas%2Fdioptas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdioptas%2Fdioptas/lists"}