# DistOptica
[](https://github.com/mrfitzpa/distoptica/actions/workflows/test_library.yml)
[](https://github.com/mrfitzpa/distoptica/actions/workflows/measure_code_coverage.yml)
[](https://mrfitzpa.github.io/distoptica)
[](https://pypi.org/project/distoptica)
[](https://anaconda.org/conda-forge/distoptica)
[](https://www.gnu.org/licenses/gpl-3.0)
`distoptica` is a Python library for modelling optical distortions.
Visit the `distoptica` [website](https://mrfitzpa.github.io/distoptica) for a
web version of the installation instructions, the reference guide, and the
examples archive.
The source code can be found in the [`distoptica` GitHub
repository](https://github.com/mrfitzpa/distoptica).
## Table of contents
- [Instructions for installing and uninstalling
`distoptica`](#instructions-for-installing-and-uninstalling-distoptica)
- [Installing `distoptica`](#installing-distoptica)
- [Installing `distoptica` using `pip`](#installing-distoptica-using-pip)
- [Installing `distoptica` using
`conda`](#installing-distoptica-using-conda)
- [Uninstalling `distoptica`](#uninstalling-distoptica)
- [Learning how to use `distoptica`](#learning-how-to-use-distoptica)
## Instructions for installing and uninstalling `distoptica`
### Installing `distoptica`
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.
Before installing `distoptica`, it is recommended that users install `PyTorch`
in the same environment that they intend to install `distoptica` according to
the instructions given [here](https://pytorch.org/get-started/locally/) for
their preferred PyTorch installation option.
#### Installing `distoptica` using `pip`
Before installing `distoptica`, 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 distoptica
The above command will install the latest stable version of `distoptica`.
To install the latest development version from the main branch of the
[distoptica GitHub repository](https://github.com/mrfitzpa/distoptica), one must
first clone the repository by running the following command:
git clone https://github.com/mrfitzpa/distoptica.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 `distoptica`.
Optionally, for additional features in `distoptica`, one can install additional
dependencies upon installing `distoptica`. 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 distoptica[<selector>]
elsewhere in order to install the latest stable version of `distoptica`, along
with the subset of additional dependencies specified by `<selector>`.
#### Installing `distoptica` using `conda`
Before proceeding, make sure that you have activated the (virtual) `conda`
environment in which you intend to install said package. For Windows systems,
users must install `PyTorch` separately prior to following the remaining
instructions below.
To install `distoptica` using the `conda` package manager, run the following
command:
conda install -c conda-forge distoptica
The above command will install the latest stable version of `distoptica`.
### Uninstalling `distoptica`
If `distoptica` was installed using `pip`, then to uninstall, run the following
command:
pip uninstall distoptica
If `distoptica` was installed using `conda`, then to uninstall, run the
following command:
conda remove distoptica
## Learning how to use `distoptica`
For those new to the `distoptica` library, it is recommended that they take a
look at the [Examples](https://mrfitzpa.github.io/distoptica/examples.html)
page, which contain code examples that show how one can use the `distoptica`
library. While going through the examples, readers can consult the [distoptica
reference
guide](https://mrfitzpa.github.io/distoptica/_autosummary/distoptica.html) to
understand what each line of code is doing.
Raw data
{
"_id": null,
"home_page": null,
"name": "distoptica",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pytorch, microscopy, distortion, distortion correction",
"author": null,
"author_email": "Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a6/a0/96221fe3eaf4ff007bd9319c317f0f3f08562ee39d58a5a8508924f30900/distoptica-0.4.1.tar.gz",
"platform": null,
"description": "# DistOptica\n\n[](https://github.com/mrfitzpa/distoptica/actions/workflows/test_library.yml)\n[](https://github.com/mrfitzpa/distoptica/actions/workflows/measure_code_coverage.yml)\n[](https://mrfitzpa.github.io/distoptica)\n[](https://pypi.org/project/distoptica)\n[](https://anaconda.org/conda-forge/distoptica)\n[](https://www.gnu.org/licenses/gpl-3.0)\n\n`distoptica` is a Python library for modelling optical distortions.\n\nVisit the `distoptica` [website](https://mrfitzpa.github.io/distoptica) for a\nweb version of the installation instructions, the reference guide, and the\nexamples archive.\n\nThe source code can be found in the [`distoptica` GitHub\nrepository](https://github.com/mrfitzpa/distoptica).\n\n\n\n## Table of contents\n\n- [Instructions for installing and uninstalling\n `distoptica`](#instructions-for-installing-and-uninstalling-distoptica)\n - [Installing `distoptica`](#installing-distoptica)\n - [Installing `distoptica` using `pip`](#installing-distoptica-using-pip)\n - [Installing `distoptica` using\n `conda`](#installing-distoptica-using-conda)\n - [Uninstalling `distoptica`](#uninstalling-distoptica)\n- [Learning how to use `distoptica`](#learning-how-to-use-distoptica)\n\n\n\n## Instructions for installing and uninstalling `distoptica`\n\n\n\n### Installing `distoptica`\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\nBefore installing `distoptica`, it is recommended that users install `PyTorch`\nin the same environment that they intend to install `distoptica` according to\nthe instructions given [here](https://pytorch.org/get-started/locally/) for\ntheir preferred PyTorch installation option.\n\n\n\n#### Installing `distoptica` using `pip`\n\nBefore installing `distoptica`, 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 distoptica\n\nThe above command will install the latest stable version of `distoptica`.\n\nTo install the latest development version from the main branch of the\n[distoptica GitHub repository](https://github.com/mrfitzpa/distoptica), one must\nfirst clone the repository by running the following command:\n\n git clone https://github.com/mrfitzpa/distoptica.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 `distoptica`.\n\nOptionally, for additional features in `distoptica`, one can install additional\ndependencies upon installing `distoptica`. 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 distoptica[<selector>]\n\nelsewhere in order to install the latest stable version of `distoptica`, along\nwith the subset of additional dependencies specified by `<selector>`. \n\n\n\n#### Installing `distoptica` using `conda`\n\nBefore proceeding, make sure that you have activated the (virtual) `conda`\nenvironment in which you intend to install said package. For Windows systems,\nusers must install `PyTorch` separately prior to following the remaining\ninstructions below.\n\nTo install `distoptica` using the `conda` package manager, run the following\ncommand:\n\n conda install -c conda-forge distoptica\n\nThe above command will install the latest stable version of `distoptica`.\n\n\n\n### Uninstalling `distoptica`\n\nIf `distoptica` was installed using `pip`, then to uninstall, run the following\ncommand:\n\n pip uninstall distoptica\n\nIf `distoptica` was installed using `conda`, then to uninstall, run the\nfollowing command:\n\n conda remove distoptica\n\n\n\n## Learning how to use `distoptica`\n\nFor those new to the `distoptica` library, it is recommended that they take a\nlook at the [Examples](https://mrfitzpa.github.io/distoptica/examples.html)\npage, which contain code examples that show how one can use the `distoptica`\nlibrary. While going through the examples, readers can consult the [distoptica\nreference\nguide](https://mrfitzpa.github.io/distoptica/_autosummary/distoptica.html) to\nunderstand what each line of code is doing.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python library for modelling optical distortions.",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://mrfitzpa.github.io/distoptica",
"Repository": "https://github.com/mrfitzpa/distoptica"
},
"split_keywords": [
"pytorch",
" microscopy",
" distortion",
" distortion correction"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "426e967f7905e8d7afc30d0a7d1a733f50a5b49ee80790471c42031f79585946",
"md5": "35ffd5c7b3976c2042163e4303c602ff",
"sha256": "31078ddd83d472a9bf4b114821434d88b582a174ba419040bf5df382b3e3d82d"
},
"downloads": -1,
"filename": "distoptica-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "35ffd5c7b3976c2042163e4303c602ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 45781,
"upload_time": "2025-10-25T04:39:40",
"upload_time_iso_8601": "2025-10-25T04:39:40.733251Z",
"url": "https://files.pythonhosted.org/packages/42/6e/967f7905e8d7afc30d0a7d1a733f50a5b49ee80790471c42031f79585946/distoptica-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a6a096221fe3eaf4ff007bd9319c317f0f3f08562ee39d58a5a8508924f30900",
"md5": "6e1136c1cb0ef1e2c0d961ef78ad61d5",
"sha256": "aa24653891d18756b850d9fd10294fa59f3012ab55bdd432a8fa937ae92ab253"
},
"downloads": -1,
"filename": "distoptica-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "6e1136c1cb0ef1e2c0d961ef78ad61d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 557040,
"upload_time": "2025-10-25T04:39:42",
"upload_time_iso_8601": "2025-10-25T04:39:42.323909Z",
"url": "https://files.pythonhosted.org/packages/a6/a0/96221fe3eaf4ff007bd9319c317f0f3f08562ee39d58a5a8508924f30900/distoptica-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-25 04:39:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mrfitzpa",
"github_project": "distoptica",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "distoptica"
}
JSON
