{"id":43229712,"url":"https://github.com/neutrons/addie","last_synced_at":"2026-02-01T10:03:46.264Z","repository":{"id":37493053,"uuid":"55717688","full_name":"neutrons/addie","owner":"neutrons","description":"ADvanced DIffraction Environment - GUI for Reduction of Neturon Time-of-Flight Total Scattering Diffraction Data","archived":false,"fork":false,"pushed_at":"2026-01-16T16:17:02.000Z","size":28452,"stargazers_count":8,"open_issues_count":44,"forks_count":4,"subscribers_count":9,"default_branch":"next","last_synced_at":"2026-01-17T05:06:32.442Z","etag":null,"topics":["mantid","neutron-scattering","pair-distance-distribution-function","radial-distribution-function","time-of-flight"],"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/neutrons.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-04-07T18:20:28.000Z","updated_at":"2025-11-14T14:39:34.000Z","dependencies_parsed_at":"2026-02-01T08:02:39.352Z","dependency_job_id":null,"html_url":"https://github.com/neutrons/addie","commit_stats":null,"previous_names":[],"tags_count":111,"template":false,"template_full_name":null,"purl":"pkg:github/neutrons/addie","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neutrons%2Faddie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neutrons%2Faddie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neutrons%2Faddie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neutrons%2Faddie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neutrons","download_url":"https://codeload.github.com/neutrons/addie/tar.gz/refs/heads/next","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neutrons%2Faddie/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28975278,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T09:57:52.632Z","status":"ssl_error","status_checked_at":"2026-02-01T09:57:49.143Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["mantid","neutron-scattering","pair-distance-distribution-function","radial-distribution-function","time-of-flight"],"created_at":"2026-02-01T10:03:45.706Z","updated_at":"2026-02-01T10:03:46.259Z","avatar_url":"https://github.com/neutrons.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"| CI     | Release | Other |\n|--------|---------|-------|\n| [![GitHub Actions](https://github.com/neutrons/addie/actions/workflows/actions.yml/badge.svg?branch=master)](https://github.com/neutrons/addie/actions/workflows/actions.yml) | [![Anaconda-Server Badge](https://anaconda.org/neutrons/addie/badges/version.svg)](https://anaconda.org/neutrons/addie) | [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) |\n|  | [![Anaconda-Server Badge](https://anaconda.org/neutrons/addie/badges/platforms.svg)](https://anaconda.org/neutrons/addie) |\n\n\n\n\n\n# ADDIE\n\n**ADDIE** stands for **AD**vandced **DI**ffraction **E**nvironment,\na data reduction application for total scattering powder diffraction data.\n\nThe name came about from being developed for the Diffraction Group\nat SNS located at ORNL (and previously known as the Advanced Diffraction Group).\n\nThis \"reduction\" entails taking raw neutron counts from detectors\nin the diffraction experiment and turning them into the\nreciprocal-space structure factor patterns, F(Q) or S(Q),\nand applying a Fourier Transform to real-space to give\nthe pair distribution fuction, PDF.\n\nADDIE is a front-end GUI for total scattering that hopes to support\nmultiple diffractometers performing total scattering measurements.\nThe back-end that uses the\n[Mantid Framework](https://docs.mantidproject.org/nightly/)\nis the [`mantid-total-scattering`](https://github.com/neutrons/mantid_total_scattering)\nproject.\n\n## Install\n\n### Pre-requisite: Install Pixi\n\nPlease follow the instructions provided at https://pixi.sh/latest/installation/\n\n### Install the Pixi Environment\n\nIn the root of the repo:\n\n```\npixi install\n```\n\nIf you would just like to import the package into your own conda environement\nthen simply run the following instead.\n\nInstall ADDIE in the conda environment:\n```\nmamba install -c neutrons addie\n```\n\n## Uninstall\n\nFor Pixi simply delete the `.pixi` folder it generates in the repo root.\n\nFor Conda:\n```\nmamba remove addie\n```\n\n## Launch\n\nTo launch ADDIE, run the following from the command line:\n\n```bash\npixi run addie\n```\n\nIf you need to specify the path to Mantid build.\nIn the pyproject.toml file \nupdate `MANTID_BUILD_DIR` to point to your build directory\nand  `MANTID_SRC_DIR` to point to your source directory.\n```\npixi run addie-local-mantid\n```\n\n\n## Development\n\n\n### Installation development environment using Pixi\n\n```bash\npixi install\n```\n\nThis will setup all the dependencies necessary to develop ADDIE.\n\nThen suppose one is located in the main directory of the ADDIE repo, executing\nthe following command will start up ADDIE,\n\n```bash\npixi run python addie/main.py\n```\n\nor just\n\n```bash\npixi run addie\n```\n\n\u003e N.B. If the drive mounting point on the operating system is changed, we may to\nrerun the setup above. Otherwise, even though the soft link may still point to\nthe right locations, we may encounter the file permission issues when trying to\nlaunch the `ADDIE` GUI.\n\n### Uninstall\n\nSimply delete the `.pixi` folder.\n\n**Notes**\n\nIf you have an error (see below for example) related to the `libGL` library,\nyou may not have it installed for the Mantid Framework to work.\nSee instructions\n[here](https://github.com/mantidproject/conda-recipes/#gl-and-glu-libs)\nfor installing the necessary libraries for different OS\n\nExample error:\n\n```\nImportError: First import of \"._api\" failed with \"libGL.so.1: cannot open shared object file...\n```\n\n### Testing\n\nThe test suite can be run using [pytest](https://docs.pytest.org/en/latest/) through pixi.\n```bash\n$ pixi run test\n```\nIf it is complaining about not being able to find the `pytest` module, first we\nneed to make sure we have installed the pixi environment.\n\n### Some cheat sheet commands for running pixi\n\n```bash\npixi shell  # activate the pixi shell, something analogous to `conda activate`\naddie  # the command is only available when pixi shell is active\nexit  # exit the pixi shell\npixi run addie  # run application task without activating pixi shell\npixi run link  # specifically defined link task\npixi shell -e local-mantid  # activate the pixi shell with the `local-mantid` environment\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneutrons%2Faddie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneutrons%2Faddie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneutrons%2Faddie/lists"}