# Electron Microscopy Beam (EMBeam)
[](https://github.com/mrfitzpa/embeam/actions/workflows/test_library.yml)
[](https://github.com/mrfitzpa/embeam/actions/workflows/measure_code_coverage.yml)
[](https://mrfitzpa.github.io/embeam)
[](https://pypi.org/project/embeam)
[](https://anaconda.org/conda-forge/embeam)
[](https://www.gnu.org/licenses/gpl-3.0)
`embeam` is a Python library for modelling beams and lenses in electron
microscopy.
Visit the `embeam` [website](https://mrfitzpa.github.io/embeam) for a web version
of the installation instructions, the reference guide, and the examples archive.
The source code can be found in the [`embeam` GitHub
repository](https://github.com/mrfitzpa/embeam).
## Table of contents
- [Instructions for installing and uninstalling
`embeam`](#instructions-for-installing-and-uninstalling-embeam)
- [Installing `embeam`](#installing-embeam)
- [Installing `embeam` using
`pip`](#installing-embeam-using-pip)
- [Installing `embeam` using
`conda`](#installing-embeam-using-conda)
- [Uninstalling `embeam`](#uninstalling-embeam)
- [Learning how to use `embeam`](#learning-how-to-use-embeam)
## Instructions for installing and uninstalling `embeam`
### Installing `embeam`
For all installation scenarios, first open up the appropriate command line
interface. On Unix-based systems, you could open e.g. a terminal. On Windows
systems you could open e.g. an Anaconda Prompt as an administrator.
#### Installing `embeam` using `pip`
Before installing `embeam`, make sure that you have activated the (virtual)
environment in which you intend to install said package. After which, simply run
the following command:
pip install embeam
The above command will install the latest stable version of `embeam`.
To install the latest development version from the main branch of the [embeam
GitHub repository](https://github.com/mrfitzpa/embeam), one must first clone the
repository by running the following command:
git clone https://github.com/mrfitzpa/embeam.git
Next, change into the root of the cloned repository, and then run the following
command:
pip install .
Note that you must include the period as well. The above command executes a
standard installation of `embeam`.
Optionally, for additional features in `embeam`, one can install additional
dependencies upon installing `embeam`. To install a subset of additional
dependencies (along with the standard installation), run the following command
from the root of the repository:
pip install .[<selector>]
where `<selector>` can be one of the following:
* `tests`: to install the dependencies necessary for running unit tests;
* `examples`: to install the dependencies necessary for executing files stored
in `<root>/examples`, where `<root>` is the root of the repository;
* `docs`: to install the dependencies necessary for documentation generation;
* `all`: to install all of the above optional dependencies.
Alternatively, one can run:
pip install embeam[<selector>]
elsewhere in order to install the latest stable version of `embeam`, along with
the subset of additional dependencies specified by `<selector>`.
#### Installing `embeam` using `conda`
To install `embeam` using the `conda` package manager, run the following
command:
conda install -c conda-forge embeam
The above command will install the latest stable version of `embeam`.
### Uninstalling `embeam`
If `embeam` was installed using `pip`, then to uninstall, run the following
command:
pip uninstall embeam
If `embeam` was installed using `conda`, then to uninstall, run the following
command:
conda remove embeam
## Learning how to use `embeam`
For those new to the `embeam` library, it is recommended that they take a look
at the [Examples](https://mrfitzpa.github.io/embeam/examples.html) page, which
contain code examples that show how one can use the `embeam` library. While
going through the examples, readers can consult the [embeam reference
guide](https://mrfitzpa.github.io/embeam/_autosummary/embeam.html) to understand
what each line of code is doing.
Raw data
{
"_id": null,
"home_page": null,
"name": "embeam",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "hyperspy, microscopy, electron beam, electron probe",
"author": null,
"author_email": "Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/67/74/c984e56fbf1de2083fc25a67a329359b422f63b505c402f1c097c9e16cde/embeam-0.0.5.tar.gz",
"platform": null,
"description": "# Electron Microscopy Beam (EMBeam)\n\n[](https://github.com/mrfitzpa/embeam/actions/workflows/test_library.yml)\n[](https://github.com/mrfitzpa/embeam/actions/workflows/measure_code_coverage.yml)\n[](https://mrfitzpa.github.io/embeam)\n[](https://pypi.org/project/embeam)\n[](https://anaconda.org/conda-forge/embeam)\n[](https://www.gnu.org/licenses/gpl-3.0)\n\n`embeam` is a Python library for modelling beams and lenses in electron\nmicroscopy.\n\nVisit the `embeam` [website](https://mrfitzpa.github.io/embeam) for a web version\nof the installation instructions, the reference guide, and the examples archive.\n\nThe source code can be found in the [`embeam` GitHub\nrepository](https://github.com/mrfitzpa/embeam).\n\n\n\n## Table of contents\n\n- [Instructions for installing and uninstalling\n `embeam`](#instructions-for-installing-and-uninstalling-embeam)\n - [Installing `embeam`](#installing-embeam)\n - [Installing `embeam` using\n `pip`](#installing-embeam-using-pip)\n - [Installing `embeam` using\n `conda`](#installing-embeam-using-conda)\n - [Uninstalling `embeam`](#uninstalling-embeam)\n- [Learning how to use `embeam`](#learning-how-to-use-embeam)\n\n\n\n## Instructions for installing and uninstalling `embeam`\n\n\n\n### Installing `embeam`\n\nFor all installation scenarios, first open up the appropriate command line\ninterface. On Unix-based systems, you could open e.g. a terminal. On Windows\nsystems you could open e.g. an Anaconda Prompt as an administrator.\n\n\n\n#### Installing `embeam` using `pip`\n\nBefore installing `embeam`, make sure that you have activated the (virtual)\nenvironment in which you intend to install said package. After which, simply run\nthe following command:\n\n pip install embeam\n\nThe above command will install the latest stable version of `embeam`.\n\nTo install the latest development version from the main branch of the [embeam\nGitHub repository](https://github.com/mrfitzpa/embeam), one must first clone the\nrepository by running the following command:\n\n git clone https://github.com/mrfitzpa/embeam.git\n\nNext, change into the root of the cloned repository, and then run the following\ncommand:\n\n pip install .\n\nNote that you must include the period as well. The above command executes a\nstandard installation of `embeam`.\n\nOptionally, for additional features in `embeam`, one can install additional\ndependencies upon installing `embeam`. To install a subset of additional\ndependencies (along with the standard installation), run the following command\nfrom the root of the repository:\n\n pip install .[<selector>]\n\nwhere `<selector>` can be one of the following:\n\n* `tests`: to install the dependencies necessary for running unit tests;\n* `examples`: to install the dependencies necessary for executing files stored\n in `<root>/examples`, where `<root>` is the root of the repository;\n* `docs`: to install the dependencies necessary for documentation generation;\n* `all`: to install all of the above optional dependencies.\n\nAlternatively, one can run:\n\n pip install embeam[<selector>]\n\nelsewhere in order to install the latest stable version of `embeam`, along with\nthe subset of additional dependencies specified by `<selector>`.\n\n\n\n#### Installing `embeam` using `conda`\n\nTo install `embeam` using the `conda` package manager, run the following\ncommand:\n\n conda install -c conda-forge embeam\n\nThe above command will install the latest stable version of `embeam`.\n\n\n\n### Uninstalling `embeam`\n\nIf `embeam` was installed using `pip`, then to uninstall, run the following\ncommand:\n\n pip uninstall embeam\n\nIf `embeam` was installed using `conda`, then to uninstall, run the following\ncommand:\n\n conda remove embeam\n\n\n\n## Learning how to use `embeam`\n\nFor those new to the `embeam` library, it is recommended that they take a look\nat the [Examples](https://mrfitzpa.github.io/embeam/examples.html) page, which\ncontain code examples that show how one can use the `embeam` library. While\ngoing through the examples, readers can consult the [embeam reference\nguide](https://mrfitzpa.github.io/embeam/_autosummary/embeam.html) to understand\nwhat each line of code is doing.\n",
"bugtrack_url": null,
"license": null,
"summary": "For modelling beams and lenses in electron microscopy.",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://mrfitzpa.github.io/embeam",
"Repository": "https://github.com/mrfitzpa/embeam"
},
"split_keywords": [
"hyperspy",
" microscopy",
" electron beam",
" electron probe"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8ba9706e91aa0ba910adf3ab018ddd10d4ffe8558d040ced00a4a0d80c2b39a2",
"md5": "fac697e606d431e7709eeb7848a053d2",
"sha256": "8e828430c48cebfd7f59c32b93194932d02d2abef5b83a2abc5651687e1976e7"
},
"downloads": -1,
"filename": "embeam-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fac697e606d431e7709eeb7848a053d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 73362,
"upload_time": "2025-10-24T21:54:22",
"upload_time_iso_8601": "2025-10-24T21:54:22.022160Z",
"url": "https://files.pythonhosted.org/packages/8b/a9/706e91aa0ba910adf3ab018ddd10d4ffe8558d040ced00a4a0d80c2b39a2/embeam-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6774c984e56fbf1de2083fc25a67a329359b422f63b505c402f1c097c9e16cde",
"md5": "9cafd8246df9dc7d0fd502318f7fa6af",
"sha256": "659136bb57efff8e658ce2d6459ef91b53e076768f6a70e4532cd8d4308aff1c"
},
"downloads": -1,
"filename": "embeam-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "9cafd8246df9dc7d0fd502318f7fa6af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3712750,
"upload_time": "2025-10-24T21:54:23",
"upload_time_iso_8601": "2025-10-24T21:54:23.970129Z",
"url": "https://files.pythonhosted.org/packages/67/74/c984e56fbf1de2083fc25a67a329359b422f63b505c402f1c097c9e16cde/embeam-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 21:54:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mrfitzpa",
"github_project": "embeam",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "embeam"
}
JSON
