{"id":20931826,"url":"https://github.com/hyperspy/exspy-demos","last_synced_at":"2025-05-13T19:33:40.462Z","repository":{"id":207830962,"uuid":"720206309","full_name":"hyperspy/exspy-demos","owner":"hyperspy","description":"eXSpy Jupyter Notebook demos","archived":false,"fork":false,"pushed_at":"2024-05-31T18:29:07.000Z","size":63531,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-05-31T19:55:36.455Z","etag":null,"topics":["data-analysis","data-visualization","eds","edx","eels","electron-energy-loss-spectroscopy","hyperspy","life-sciences","materials-science","multi-dimensional","physical-sciences","spectroscopy","tutorial","x-ray-spectroscopy","xrf"],"latest_commit_sha":null,"homepage":"https://hyperspy.org/exspy","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperspy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-11-17T20:20:37.000Z","updated_at":"2024-05-31T18:29:12.000Z","dependencies_parsed_at":"2024-05-31T19:55:20.415Z","dependency_job_id":"ed261502-c723-45b7-a2eb-a96b4a8f5bbd","html_url":"https://github.com/hyperspy/exspy-demos","commit_stats":null,"previous_names":["hyperspy/exspy-demos"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperspy%2Fexspy-demos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperspy%2Fexspy-demos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperspy%2Fexspy-demos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperspy%2Fexspy-demos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperspy","download_url":"https://codeload.github.com/hyperspy/exspy-demos/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225255898,"owners_count":17445423,"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":["data-analysis","data-visualization","eds","edx","eels","electron-energy-loss-spectroscopy","hyperspy","life-sciences","materials-science","multi-dimensional","physical-sciences","spectroscopy","tutorial","x-ray-spectroscopy","xrf"],"created_at":"2024-11-18T21:45:56.844Z","updated_at":"2024-11-18T21:45:57.477Z","avatar_url":"https://github.com/hyperspy.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# exSpy demos\n\n[![Live demos (Binder)](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/hyperspy/exspy-demos/main)\n[![Notebook Viewer (nbviewer)](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg?sanitize=true)](https://nbviewer.org/github/hyperspy/exspy-demos)\n[![Documentation Status](https://readthedocs.org/projects/exspy/badge/?version=latest)](https://exspy.readthedocs.io/en/latest/?badge=latest)\n\n## Introduction\n\nThis repository contains [Jupyter Notebooks](https://jupyter.org/) to demo and learn\nhow to process electron energy loss spectroscopy (EELS) and X-ray energy dispersive spectroscopy (EDS)\nwith [exSpy](https://hyperspy.org/exspy). For learning purposes, we recommend to use them alongside the \n[exSpy User Guide](https://hyperspy.org/exspy).\n\n*exSpy* uses the HyperSpy framework and to learn about generic functionalities of [HyperSpy](https://hyperspy.org),\nsee the [HyperSpy user guide](https://hyperspy.org/hyperspy-doc/current/index.html) and the [HyperSpy demos](https://github.com/hyperspy/hyperspy-demos).\n\n## Visualising and running the demos.\n\n### (Interactive) Running the demos online\n\n[![Live demos (Binder)](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/hyperspy/exspy-demos/main)\n\nFollow [this link](https://mybinder.org/v2/gh/hyperspy/exspy-demos/main)\nor click the \"launch binder\" banner above to run the the demos on \n[mybinder.org](https://mybinder.org/). The demos will run remotely, \nand one can experiment with HyperSpy in a Jupyter notebook with no need \nto install or configure any software locally.\n\n**Note:** depending on the remote server load, the interactive binder demo may \ntake up to several minutes to load. For a quicker (but non-interactive) \nvisualization, see below.\n\n### (Non-interactive) Visualizing the demos online\n\n[![Notebook Viewer (nbviewer)](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg?sanitize=true)](https://nbviewer.org/github/hyperspy/exspy-demos)\n\nFollow [this link](https://nbviewer.org/github/hyperspy/exspy-demos) \nor click on the \"render nbviewer\" banner above\nto display the demos with the \n[Jupyter Notebook viewer](https://nbviewer.org). \n[nbviewer](https://nbviewer.org/) will allow you to view the notebooks online,\nbut you will not be able to change them or evaluate any code, like is possible with the \n[binder](https://mybinder.org/v2/gh/hyperspy/exspy-demos/main).\n\n### Running and visualizing the demos locally\n\nTo run the demo notebooks locally, \nclone or download the [demos repository](https://github.com/hyperspy/exspy-demos) \nto your local\nmachine, install HyperSpy and\n[Jupyter Lab](https://jupyterlab.readthedocs.io) or \n[Jupyter Notebook](https://jupyter-notebook.readthedocs.io)\nand use either of Jupyter tools to run the notebooks.\n\n\n#### (For developers) Testing the demos locally\n\nTo test the demos, install\n[nbval](https://github.com/computationalmodelling/nbval) and\n[pytest](https://pytest.org/) and run\n\n```bash\n$ pytest\n```\n\nTo help visualize differences/errors, install\n[nbdime](https://github.com/jupyter/nbdime) as well, and run the test with\n\n```bash\n$ pytest --nbdime\n```\n\n## Contributing\n\nTo contribute new demos or improvements to the current ones fork the demos\nrepository and send us a pull request. See the \n[HyperSpy Developer Guide](https://hyperspy.org/hyperspy-doc/current/dev_guide.html) \nfor more details on how to contribute to HyperSpy.\n\nFor issues and discussions fill a new\nissue in [the demos github repository](https://github.com/hyperspy/exspy-demos)\nor discuss it in [HyperSpy's gitter chat](https://gitter.im/hyperspy/hyperspy).\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperspy%2Fexspy-demos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperspy%2Fexspy-demos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperspy%2Fexspy-demos/lists"}