| Name | svetlanna JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | https://github.com/CompPhysLab/SVETlANNa |
| Summary | SVETlANNa is an open-source Python library for simulation of free-space optical set-ups and neuromorphic systems such as Diffractive Neural Networks. |
| upload_time | 2025-07-30 08:51:47 |
| maintainer | None |
| docs_url | None |
| author | Alexey A. Shcherbakov |
| requires_python | <3.12,>=3.11.0 |
| license | Mozilla Public License Version 2.0
==================================
1. Definitions
--------------
1.1. "Contributor"
means each individual or legal entity that creates, contributes to
the creation of, or owns Covered Software.
1.2. "Contributor Version"
means the combination of the Contributions of others (if any) used
by a Contributor and that particular Contributor's Contribution.
1.3. "Contribution"
means Covered Software of a particular Contributor.
1.4. "Covered Software"
means Source Code Form to which the initial Contributor has attached
the notice in Exhibit A, the Executable Form of such Source Code
Form, and Modifications of such Source Code Form, in each case
including portions thereof.
1.5. "Incompatible With Secondary Licenses"
means
(a) that the initial Contributor has attached the notice described
in Exhibit B to the Covered Software; or
(b) that the Covered Software was made available under the terms of
version 1.1 or earlier of the License, but not also under the
terms of a Secondary License.
1.6. "Executable Form"
means any form of the work other than Source Code Form.
1.7. "Larger Work"
means a work that combines Covered Software with other material, in
a separate file or files, that is not Covered Software.
1.8. "License"
means this document.
1.9. "Licensable"
means having the right to grant, to the maximum extent possible,
whether at the time of the initial grant or subsequently, any and
all of the rights conveyed by this License.
1.10. "Modifications"
means any of the following:
(a) any file in Source Code Form that results from an addition to,
deletion from, or modification of the contents of Covered
Software; or
(b) any new file in Source Code Form that contains any Covered
Software.
1.11. "Patent Claims" of a Contributor
means any patent claim(s), including without limitation, method,
process, and apparatus claims, in any patent Licensable by such
Contributor that would be infringed, but for the grant of the
License, by the making, using, selling, offering for sale, having
made, import, or transfer of either its Contributions or its
Contributor Version.
1.12. "Secondary License"
means either the GNU General Public License, Version 2.0, the GNU
Lesser General Public License, Version 2.1, the GNU Affero General
Public License, Version 3.0, or any later versions of those
licenses.
1.13. "Source Code Form"
means the form of the work preferred for making modifications.
1.14. "You" (or "Your")
means an individual or a legal entity exercising rights under this
License. For legal entities, "You" includes any entity that
controls, is controlled by, or is under common control with You. For
purposes of this definition, "control" means (a) the power, direct
or indirect, to cause the direction or management of such entity,
whether by contract or otherwise, or (b) ownership of more than
fifty percent (50%) of the outstanding shares or beneficial
ownership of such entity.
2. License Grants and Conditions
--------------------------------
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
(a) under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
(b) under Patent Claims of such Contributor to make, use, sell, offer
for sale, have made, import, and otherwise transfer either its
Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:
(a) for any code that a Contributor has removed from Covered Software;
or
(b) for infringements caused by: (i) Your and any other third party's
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
(c) under Patent Claims infringed by Covered Software in the absence of
its Contributions.
This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights
to grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
in Section 2.1.
3. Responsibilities
-------------------
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
(a) such Covered Software must also be made available in Source Code
Form, as described in Section 3.1, and You must inform recipients of
the Executable Form how they can obtain a copy of such Source Code
Form by reasonable means in a timely manner, at a charge no more
than the cost of distribution to the recipient; and
(b) You may distribute such Executable Form under the terms of this
License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter
the recipients' rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
3.4. Notices
You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty,
or limitations of liability) contained within the Source Code Form of
the Covered Software, except that You may alter any license notices to
the extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
---------------------------------------------------
If it is impossible for You to comply with any of the terms of this
License with respect to some or all of the Covered Software due to
statute, judicial order, or regulation then You must: (a) comply with
the terms of this License to the maximum extent possible; and (b)
describe the limitations and the code they affect. Such description must
be placed in a text file included with all distributions of the Covered
Software under this License. Except to the extent prohibited by statute
or regulation, such description must be sufficiently detailed for a
recipient of ordinary skill to be able to understand it.
5. Termination
--------------
5.1. The rights granted under this License will terminate automatically
if You fail to comply with any of its terms. However, if You become
compliant, then the rights granted under this License from a particular
Contributor are reinstated (a) provisionally, unless and until such
Contributor explicitly and finally terminates Your grants, and (b) on an
ongoing basis, if such Contributor fails to notify You of the
non-compliance by some reasonable means prior to 60 days after You have
come back into compliance. Moreover, Your grants from a particular
Contributor are reinstated on an ongoing basis if such Contributor
notifies You of the non-compliance by some reasonable means, this is the
first time You have received notice of non-compliance with this License
from such Contributor, and You become compliant prior to 30 days after
Your receipt of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
end user license agreements (excluding distributors and resellers) which
have been validly granted by You or Your distributors under this License
prior to termination shall survive termination.
************************************************************************
* *
* 6. Disclaimer of Warranty *
* ------------------------- *
* *
* Covered Software is provided under this License on an "as is" *
* basis, without warranty of any kind, either expressed, implied, or *
* statutory, including, without limitation, warranties that the *
* Covered Software is free of defects, merchantable, fit for a *
* particular purpose or non-infringing. The entire risk as to the *
* quality and performance of the Covered Software is with You. *
* Should any Covered Software prove defective in any respect, You *
* (not any Contributor) assume the cost of any necessary servicing, *
* repair, or correction. This disclaimer of warranty constitutes an *
* essential part of this License. No use of any Covered Software is *
* authorized under this License except under this disclaimer. *
* *
************************************************************************
************************************************************************
* *
* 7. Limitation of Liability *
* -------------------------- *
* *
* Under no circumstances and under no legal theory, whether tort *
* (including negligence), contract, or otherwise, shall any *
* Contributor, or anyone who distributes Covered Software as *
* permitted above, be liable to You for any direct, indirect, *
* special, incidental, or consequential damages of any character *
* including, without limitation, damages for lost profits, loss of *
* goodwill, work stoppage, computer failure or malfunction, or any *
* and all other commercial damages or losses, even if such party *
* shall have been informed of the possibility of such damages. This *
* limitation of liability shall not apply to liability for death or *
* personal injury resulting from such party's negligence to the *
* extent applicable law prohibits such limitation. Some *
* jurisdictions do not allow the exclusion or limitation of *
* incidental or consequential damages, so this exclusion and *
* limitation may not apply to You. *
* *
************************************************************************
8. Litigation
-------------
Any litigation relating to this License may be brought only in the
courts of a jurisdiction where the defendant maintains its principal
place of business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions.
Nothing in this Section shall prevent a party's ability to bring
cross-claims or counter-claims.
9. Miscellaneous
----------------
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides
that the language of a contract shall be construed against the drafter
shall not be used to construe this License against a Contributor.
10. Versions of the License
---------------------------
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses
If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
-------------------------------------------
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to look
for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
---------------------------------------------------------
This Source Code Form is "Incompatible With Secondary Licenses", as
defined by the Mozilla Public License, v. 2.0.
|
| keywords |
optical neural network
diffractive neural network
pytorch
optical beam
optical setup
diffractive element
spatial light modulator
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/CompPhysLab/SVETlANNa/blob/main/README.md)
[](https://github.com/CompPhysLab/SVETlANNa/blob/main/README.ru.md)
# SVETlANNa
SVETlANNa is an open-source Python library for simulation of free-space optical set-ups and neuromorphic systems such as Diffractive Neural Networks. It is primarily built on the PyTorch framework, leveraging key features such as tensor-based computations and efficient parallel processing. At its core, SvetlANNa relies on the Fourier optics, supporting multiple propagation models, including the Angular spectrum method and the Fresnel approximation.
There is a supporting github project [SVETlANNa.docs](https://github.com/CompPhysLab/SVETlANNa.docs) containing numerous application examples in the Jupyter notebook format.
The name of the library is composed of the Russian word "svet", which is the "light" in English and the abbreviation ANN standing for an artificial neural network, and simultaneously the whole word sounds like a Russian female name Svetlana.
## Abbreviations
NN - Neural Network
ANN - Artificial Neural Network
ONN - Optical Neural Network
DONN - Diffractive Optical Neural Network
DOE - Diffractive Optical Element
SLM - Spatial Light Modulator
## Features
- based on the [PyTorch](https://pytorch.org/)
- forward propagation models include the Angular spectrum method and the Fresnel approximation
- possibility to solve the classical DOE/SLM optimization problem with the Gerchberg-Saxton and hybrid input-output algorithms
- support for custom elements and optimization methods
- support for various free-space ONN architectures including feed-forward NN, autoencoders, and recurrent NN
- cross platform
- full GPU aceleration
- companion repository with numerous .ipynb examples
- custom logging, project management, analysis, and visualization tools
- tests for the whole functionality
## Possible applications
- modeling and optimization of optical systems and optical beams propagating in free space;
- calculation of parameters of phase masks, DOEs and SLMs for both classical optical systems and neuromorphic optical computers;
- modeling and optimization of parameters of ONN and DONN for problems of all-optical classification and prediction.
## Recommended technical requirements:
1. Intel Core i5 8400 / AMD Ryzen 5 1400 or higher;
2. memory greater than 8 Gb;
3. HDD/SSD space not less than 16 Гб (virtual enviroment takes about 6 Gb);
4. for running on GPU you need an Nvidia card with CUDA support and memory not less than 2 Gb;
5. OS Windows 10 or greater, or Linux with kernel 5.15 or greater;
6. the library requires Python 3.11.
# Installation, Usage and Examples
For usage there are two options, either run from the source or install from pip.
## Installation From PyPI
```bash
pip install svetlanna
```
## Running From Source
We reccomend first to install [git](https://git-scm.com) in your system.
1. Clone the repository:
```bash
git clone https://github.com/CompPhysLab/SVETlANNa.git
```
2. Move to the project dyrectory:
```bash
cd SVETlANNa
```
3. Create a virtual environment for Python 3.11 (see [venv documentation](https://docs.python.org/3/library/venv.html)) and activate it.
4. Istall the Poetry (version 2.0.0 or greater):
```bash
pip install poetry
```
5. Install all depencies:
```bash
poetry install --all-extras
```
6. Install the PyTorch (check the instructions at the official [cite](https://pytorch.org/get-started/locally/)). Choose options appropriate to your system. For running the library on a GPU you need to have an appropriate graphic card and a PyTorch version which supports this card.
```bash
pip install torch
```
## Running Tests
The tests can be executed when the library is running from source only. PIP istallation does not include tests.
NOTE: running tests requires at least 4 Gb of free memory.
To run tests, run the following command (within the activated virtual environment in the library folder)
```bash
pytest
```
## Documentation
[Documentation](https://compphyslab.github.io/SVETlANNa/)
## Running examples with library installation
Examples of various scenarios and setups are provided in the repository [SVETlANNa.docs](https://github.com/CompPhysLab/SVETlANNa.docs).
To run the example locally follow the instructions:
1. Clone the repository (you should have an installed [git](https://git-scm.com)):
```bash
git clone https://github.com/CompPhysLab/SVETlANNa.docs.git
```
2. Go to the project directory:
```bash
cd SVETlANNa.docs
```
3.Create a virtual environment for Python 3.11 (see [venv documentation](https://docs.python.org/3/library/venv.html)) and activate it. All subsequent actions should be done within the activated environment.
4. Install the main library:
```bash
pip install svetlanna
```
5. Install the PyTorch (check the instructions at the official [cite](https://pytorch.org/get-started/locally/)). Choose options appropriate to your system. For running the library on a GPU you need to have an appropriate graphic card and a PyTorch version which supports this card.
6. If you do not have the Jupyter notebook in your system, install it:
```bash
pip install notebook
```
7. Install additional dependencies:
```bash
pip install reservoirpy matplotlib tqdm requests av scikit-image py-cpuinfo gputil
```
8. Run the Jupyter notebook:
```bash
jupyter notebook
```
and open the page in your browser (see “Or copy and paste one of these URLs:” in a terminal window)
9. Go to the folder SVETlANNa.docs. Examples are grouped into subject subfolders in form of .ipynb files. To run them you need to open a file in the Jupyter notebook and run all code cells (key Shift+Enter).
## Running exaples with SVETlANNa installed from source
1. Clone the repository (you should have an installed [git](https://git-scm.com)):
```bash
git clone https://github.com/CompPhysLab/SVETlANNa.docs.git
```
All subsequent actions should be done within the activated environment, which was used to install the SVETlANNa library from source.
2. If you do not have the Jupyter notebook in your system, install it:
```bash
pip install notebook
```
3. Install additional dependencies:
```bash
pip install reservoirpy matplotlib tqdm requests av scikit-image py-cpuinfo gputil
```
4. Run the Jupyter notebook:
```bash
jupyter notebook
```
and open the page in your browser (see “Or copy and paste one of these URLs:” in a terminal window)
5. Go to the folder SVETlANNa.docs. Examples are grouped into subject subfolders in form of .ipynb files. To run them you need to open a file in the Jupyter notebook and run all code cells (key Shift+Enter).
## Examples
Result of training the feed-forward optical neural network for the MNIST classification task: The image of the figure "8" is passed through a stack of 10 phase plates with adjusted phase masks. Selected regions of the detector correspond to different classes of figures. The class of the figure is identified by the detector region that measures the maximum optical intensity.
Examples of visualzation of optical set-ups and optical fields:
<img src="./pics/visualization.png" alt="drawing" width="400"/>
Example a of five-layer DONN trained to recognize numbers from the MNIST database:
<img src="./pics/MNIST example 1.png" alt="drawing" width="400"/>
<img src="./pics/MNIST example 2.png" alt="drawing" width="400"/>
<img src="./pics/MNIST example 3.png" alt="drawing" width="400"/>
# Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
Please adhere to this project's `code of conduct`.
# Acknowledgements
The work on this repository was initiated within the grant by the [Foundation for Assistance to Small Innovative Enterprises](https://en.fasie.ru/)
# Authors
- [@aashcher](https://github.com/aashcher)
- [@alexeykokhanovskiy](https://github.com/alexeykokhanovskiy)
- [@Den4S](https://github.com/Den4S)
- [@djiboshin](https://github.com/djiboshin)
- [@Nevermind013](https://github.com/Nevermind013)
# License
[Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/)
Raw data
{
"_id": null,
"home_page": "https://github.com/CompPhysLab/SVETlANNa",
"name": "svetlanna",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.11.0",
"maintainer_email": null,
"keywords": "optical neural network, diffractive neural network, pytorch, optical beam, optical setup, diffractive element, spatial light modulator",
"author": "Alexey A. Shcherbakov",
"author_email": "cplab@metalab.ifmo.ru",
"download_url": "https://files.pythonhosted.org/packages/fc/e1/dbc767b6f4a390ba29144db9ca44d18915d22f2e29ee33cd2475e05c0cd9/svetlanna-1.0.3.tar.gz",
"platform": null,
"description": "[](https://github.com/CompPhysLab/SVETlANNa/blob/main/README.md)\n[](https://github.com/CompPhysLab/SVETlANNa/blob/main/README.ru.md)\n\n# SVETlANNa\n\nSVETlANNa is an open-source Python library for simulation of free-space optical set-ups and neuromorphic systems such as Diffractive Neural Networks. It is primarily built on the PyTorch framework, leveraging key features such as tensor-based computations and efficient parallel processing. At its core, SvetlANNa relies on the Fourier optics, supporting multiple propagation models, including the Angular spectrum method and the Fresnel approximation.\n\nThere is a supporting github project [SVETlANNa.docs](https://github.com/CompPhysLab/SVETlANNa.docs) containing numerous application examples in the Jupyter notebook format.\n\nThe name of the library is composed of the Russian word \"svet\", which is the \"light\" in English and the abbreviation ANN standing for an artificial neural network, and simultaneously the whole word sounds like a Russian female name Svetlana.\n\n## Abbreviations\n\nNN - Neural Network\n\nANN - Artificial Neural Network\n\nONN - Optical Neural Network\n\nDONN - Diffractive Optical Neural Network\n\nDOE - Diffractive Optical Element\n\nSLM - Spatial Light Modulator\n\n## Features\n\n- based on the [PyTorch](https://pytorch.org/)\n- forward propagation models include the Angular spectrum method and the Fresnel approximation\n- possibility to solve the classical DOE/SLM optimization problem with the Gerchberg-Saxton and hybrid input-output algorithms\n- support for custom elements and optimization methods\n- support for various free-space ONN architectures including feed-forward NN, autoencoders, and recurrent NN\n- cross platform\n- full GPU aceleration\n- companion repository with numerous .ipynb examples\n- custom logging, project management, analysis, and visualization tools\n- tests for the whole functionality\n\n## Possible applications\n\n- modeling and optimization of optical systems and optical beams propagating in free space;\n- calculation of parameters of phase masks, DOEs and SLMs for both classical optical systems and neuromorphic optical computers;\n- modeling and optimization of parameters of ONN and DONN for problems of all-optical classification and prediction.\n\n## Recommended technical requirements:\n\n1.\tIntel Core i5 8400 / AMD Ryzen 5 1400 or higher;\n2.\tmemory greater than 8 Gb;\n3.\tHDD/SSD space not less than 16 \u0413\u0431 (virtual enviroment takes about 6 Gb);\n4.\tfor running on GPU you need an Nvidia card with CUDA support and memory not less than 2 Gb;\n5.\tOS Windows 10 or greater, or Linux with kernel 5.15 or greater;\n6.\tthe library requires Python 3.11.\n\n# Installation, Usage and Examples\n\nFor usage there are two options, either run from the source or install from pip.\n\n## Installation From PyPI\n\n```bash\npip install svetlanna\n```\n\n## Running From Source\n\nWe reccomend first to install [git](https://git-scm.com) in your system.\n\n1. Clone the repository:\n```bash\n git clone https://github.com/CompPhysLab/SVETlANNa.git\n```\n2. Move to the project dyrectory:\n```bash\n cd SVETlANNa\n```\n3. Create a virtual environment for Python 3.11 (see [venv documentation](https://docs.python.org/3/library/venv.html)) and activate it.\n4. Istall the Poetry (version 2.0.0 or greater):\n```bash\n pip install poetry\n```\n5. Install all depencies:\n```bash\n poetry install --all-extras\n```\n6. Install the PyTorch (check the instructions at the official [cite](https://pytorch.org/get-started/locally/)). Choose options appropriate to your system. For running the library on a GPU you need to have an appropriate graphic card and a PyTorch version which supports this card.\n```bash\n pip install torch\n```\n\n## Running Tests\n\nThe tests can be executed when the library is running from source only. PIP istallation does not include tests.\n\nNOTE: running tests requires at least 4 Gb of free memory.\n\nTo run tests, run the following command (within the activated virtual environment in the library folder)\n```bash\n pytest\n```\n\n## Documentation\n\n[Documentation](https://compphyslab.github.io/SVETlANNa/)\n\n## Running examples with library installation\n\nExamples of various scenarios and setups are provided in the repository [SVETlANNa.docs](https://github.com/CompPhysLab/SVETlANNa.docs).\n\nTo run the example locally follow the instructions:\n1. Clone the repository (you should have an installed [git](https://git-scm.com)):\n```bash\n git clone https://github.com/CompPhysLab/SVETlANNa.docs.git\n```\n2. Go to the project directory:\n```bash\n cd SVETlANNa.docs\n```\n3.Create a virtual environment for Python 3.11 (see [venv documentation](https://docs.python.org/3/library/venv.html)) and activate it. All subsequent actions should be done within the activated environment.\n4. Install the main library:\n```bash\n pip install svetlanna\n```\n5. Install the PyTorch (check the instructions at the official [cite](https://pytorch.org/get-started/locally/)). Choose options appropriate to your system. For running the library on a GPU you need to have an appropriate graphic card and a PyTorch version which supports this card.\n6. If you do not have the Jupyter notebook in your system, install it:\n```bash\n pip install notebook\n```\n7. Install additional dependencies:\n```bash\n pip install reservoirpy matplotlib tqdm requests av scikit-image py-cpuinfo gputil\n```\n8. Run the Jupyter notebook:\n```bash\n jupyter notebook\n```\nand open the page in your browser (see \u201cOr copy and paste one of these URLs:\u201d in a terminal window)\n9. Go to the folder SVETlANNa.docs. Examples are grouped into subject subfolders in form of .ipynb files. To run them you need to open a file in the Jupyter notebook and run all code cells (key Shift+Enter).\n\n## Running exaples with SVETlANNa installed from source\n\n1. Clone the repository (you should have an installed [git](https://git-scm.com)):\n```bash\n\tgit clone https://github.com/CompPhysLab/SVETlANNa.docs.git \n```\nAll subsequent actions should be done within the activated environment, which was used to install the SVETlANNa library from source.\n2. If you do not have the Jupyter notebook in your system, install it:\n```bash\n pip install notebook\n```\n3. Install additional dependencies:\n```bash\n pip install reservoirpy matplotlib tqdm requests av scikit-image py-cpuinfo gputil\n```\n4. Run the Jupyter notebook:\n```bash\n jupyter notebook\n```\nand open the page in your browser (see \u201cOr copy and paste one of these URLs:\u201d in a terminal window)\n5. Go to the folder SVETlANNa.docs. Examples are grouped into subject subfolders in form of .ipynb files. To run them you need to open a file in the Jupyter notebook and run all code cells (key Shift+Enter).\n\n## Examples\n\nResult of training the feed-forward optical neural network for the MNIST classification task: The image of the figure \"8\" is passed through a stack of 10 phase plates with adjusted phase masks. Selected regions of the detector correspond to different classes of figures. The class of the figure is identified by the detector region that measures the maximum optical intensity.\n\nExamples of visualzation of optical set-ups and optical fields:\n\n<img src=\"./pics/visualization.png\" alt=\"drawing\" width=\"400\"/>\n\nExample a of five-layer DONN trained to recognize numbers from the MNIST database:\n\n<img src=\"./pics/MNIST example 1.png\" alt=\"drawing\" width=\"400\"/>\n\n<img src=\"./pics/MNIST example 2.png\" alt=\"drawing\" width=\"400\"/>\n\n<img src=\"./pics/MNIST example 3.png\" alt=\"drawing\" width=\"400\"/>\n\n# Contributing\n\nContributions are always welcome!\n\nSee `contributing.md` for ways to get started.\n\nPlease adhere to this project's `code of conduct`.\n\n\n# Acknowledgements\n\nThe work on this repository was initiated within the grant by the [Foundation for Assistance to Small Innovative Enterprises](https://en.fasie.ru/)\n\n# Authors\n\n- [@aashcher](https://github.com/aashcher)\n- [@alexeykokhanovskiy](https://github.com/alexeykokhanovskiy)\n- [@Den4S](https://github.com/Den4S)\n- [@djiboshin](https://github.com/djiboshin)\n- [@Nevermind013](https://github.com/Nevermind013)\n\n# License\n\n[Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/)\n",
"bugtrack_url": null,
"license": "Mozilla Public License Version 2.0\n==================================\n\n1. Definitions\n--------------\n\n1.1. \"Contributor\"\n means each individual or legal entity that creates, contributes to\n the creation of, or owns Covered Software.\n\n1.2. \"Contributor Version\"\n means the combination of the Contributions of others (if any) used\n by a Contributor and that particular Contributor's Contribution.\n\n1.3. \"Contribution\"\n means Covered Software of a particular Contributor.\n\n1.4. \"Covered Software\"\n means Source Code Form to which the initial Contributor has attached\n the notice in Exhibit A, the Executable Form of such Source Code\n Form, and Modifications of such Source Code Form, in each case\n including portions thereof.\n\n1.5. \"Incompatible With Secondary Licenses\"\n means\n\n (a) that the initial Contributor has attached the notice described\n in Exhibit B to the Covered Software; or\n\n (b) that the Covered Software was made available under the terms of\n version 1.1 or earlier of the License, but not also under the\n terms of a Secondary License.\n\n1.6. \"Executable Form\"\n means any form of the work other than Source Code Form.\n\n1.7. \"Larger Work\"\n means a work that combines Covered Software with other material, in\n a separate file or files, that is not Covered Software.\n\n1.8. \"License\"\n means this document.\n\n1.9. \"Licensable\"\n means having the right to grant, to the maximum extent possible,\n whether at the time of the initial grant or subsequently, any and\n all of the rights conveyed by this License.\n\n1.10. \"Modifications\"\n means any of the following:\n\n (a) any file in Source Code Form that results from an addition to,\n deletion from, or modification of the contents of Covered\n Software; or\n\n (b) any new file in Source Code Form that contains any Covered\n Software.\n\n1.11. \"Patent Claims\" of a Contributor\n means any patent claim(s), including without limitation, method,\n process, and apparatus claims, in any patent Licensable by such\n Contributor that would be infringed, but for the grant of the\n License, by the making, using, selling, offering for sale, having\n made, import, or transfer of either its Contributions or its\n Contributor Version.\n\n1.12. \"Secondary License\"\n means either the GNU General Public License, Version 2.0, the GNU\n Lesser General Public License, Version 2.1, the GNU Affero General\n Public License, Version 3.0, or any later versions of those\n licenses.\n\n1.13. \"Source Code Form\"\n means the form of the work preferred for making modifications.\n\n1.14. \"You\" (or \"Your\")\n means an individual or a legal entity exercising rights under this\n License. For legal entities, \"You\" includes any entity that\n controls, is controlled by, or is under common control with You. For\n purposes of this definition, \"control\" means (a) the power, direct\n or indirect, to cause the direction or management of such entity,\n whether by contract or otherwise, or (b) ownership of more than\n fifty percent (50%) of the outstanding shares or beneficial\n ownership of such entity.\n\n2. License Grants and Conditions\n--------------------------------\n\n2.1. Grants\n\nEach Contributor hereby grants You a world-wide, royalty-free,\nnon-exclusive license:\n\n(a) under intellectual property rights (other than patent or trademark)\n Licensable by such Contributor to use, reproduce, make available,\n modify, display, perform, distribute, and otherwise exploit its\n Contributions, either on an unmodified basis, with Modifications, or\n as part of a Larger Work; and\n\n(b) under Patent Claims of such Contributor to make, use, sell, offer\n for sale, have made, import, and otherwise transfer either its\n Contributions or its Contributor Version.\n\n2.2. Effective Date\n\nThe licenses granted in Section 2.1 with respect to any Contribution\nbecome effective for each Contribution on the date the Contributor first\ndistributes such Contribution.\n\n2.3. Limitations on Grant Scope\n\nThe licenses granted in this Section 2 are the only rights granted under\nthis License. No additional rights or licenses will be implied from the\ndistribution or licensing of Covered Software under this License.\nNotwithstanding Section 2.1(b) above, no patent license is granted by a\nContributor:\n\n(a) for any code that a Contributor has removed from Covered Software;\n or\n\n(b) for infringements caused by: (i) Your and any other third party's\n modifications of Covered Software, or (ii) the combination of its\n Contributions with other software (except as part of its Contributor\n Version); or\n\n(c) under Patent Claims infringed by Covered Software in the absence of\n its Contributions.\n\nThis License does not grant any rights in the trademarks, service marks,\nor logos of any Contributor (except as may be necessary to comply with\nthe notice requirements in Section 3.4).\n\n2.4. Subsequent Licenses\n\nNo Contributor makes additional grants as a result of Your choice to\ndistribute the Covered Software under a subsequent version of this\nLicense (see Section 10.2) or under the terms of a Secondary License (if\npermitted under the terms of Section 3.3).\n\n2.5. Representation\n\nEach Contributor represents that the Contributor believes its\nContributions are its original creation(s) or it has sufficient rights\nto grant the rights to its Contributions conveyed by this License.\n\n2.6. Fair Use\n\nThis License is not intended to limit any rights You have under\napplicable copyright doctrines of fair use, fair dealing, or other\nequivalents.\n\n2.7. Conditions\n\nSections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted\nin Section 2.1.\n\n3. Responsibilities\n-------------------\n\n3.1. Distribution of Source Form\n\nAll distribution of Covered Software in Source Code Form, including any\nModifications that You create or to which You contribute, must be under\nthe terms of this License. You must inform recipients that the Source\nCode Form of the Covered Software is governed by the terms of this\nLicense, and how they can obtain a copy of this License. You may not\nattempt to alter or restrict the recipients' rights in the Source Code\nForm.\n\n3.2. Distribution of Executable Form\n\nIf You distribute Covered Software in Executable Form then:\n\n(a) such Covered Software must also be made available in Source Code\n Form, as described in Section 3.1, and You must inform recipients of\n the Executable Form how they can obtain a copy of such Source Code\n Form by reasonable means in a timely manner, at a charge no more\n than the cost of distribution to the recipient; and\n\n(b) You may distribute such Executable Form under the terms of this\n License, or sublicense it under different terms, provided that the\n license for the Executable Form does not attempt to limit or alter\n the recipients' rights in the Source Code Form under this License.\n\n3.3. Distribution of a Larger Work\n\nYou may create and distribute a Larger Work under terms of Your choice,\nprovided that You also comply with the requirements of this License for\nthe Covered Software. If the Larger Work is a combination of Covered\nSoftware with a work governed by one or more Secondary Licenses, and the\nCovered Software is not Incompatible With Secondary Licenses, this\nLicense permits You to additionally distribute such Covered Software\nunder the terms of such Secondary License(s), so that the recipient of\nthe Larger Work may, at their option, further distribute the Covered\nSoftware under the terms of either this License or such Secondary\nLicense(s).\n\n3.4. Notices\n\nYou may not remove or alter the substance of any license notices\n(including copyright notices, patent notices, disclaimers of warranty,\nor limitations of liability) contained within the Source Code Form of\nthe Covered Software, except that You may alter any license notices to\nthe extent required to remedy known factual inaccuracies.\n\n3.5. Application of Additional Terms\n\nYou may choose to offer, and to charge a fee for, warranty, support,\nindemnity or liability obligations to one or more recipients of Covered\nSoftware. However, You may do so only on Your own behalf, and not on\nbehalf of any Contributor. You must make it absolutely clear that any\nsuch warranty, support, indemnity, or liability obligation is offered by\nYou alone, and You hereby agree to indemnify every Contributor for any\nliability incurred by such Contributor as a result of warranty, support,\nindemnity or liability terms You offer. You may include additional\ndisclaimers of warranty and limitations of liability specific to any\njurisdiction.\n\n4. Inability to Comply Due to Statute or Regulation\n---------------------------------------------------\n\nIf it is impossible for You to comply with any of the terms of this\nLicense with respect to some or all of the Covered Software due to\nstatute, judicial order, or regulation then You must: (a) comply with\nthe terms of this License to the maximum extent possible; and (b)\ndescribe the limitations and the code they affect. Such description must\nbe placed in a text file included with all distributions of the Covered\nSoftware under this License. Except to the extent prohibited by statute\nor regulation, such description must be sufficiently detailed for a\nrecipient of ordinary skill to be able to understand it.\n\n5. Termination\n--------------\n\n5.1. The rights granted under this License will terminate automatically\nif You fail to comply with any of its terms. However, if You become\ncompliant, then the rights granted under this License from a particular\nContributor are reinstated (a) provisionally, unless and until such\nContributor explicitly and finally terminates Your grants, and (b) on an\nongoing basis, if such Contributor fails to notify You of the\nnon-compliance by some reasonable means prior to 60 days after You have\ncome back into compliance. Moreover, Your grants from a particular\nContributor are reinstated on an ongoing basis if such Contributor\nnotifies You of the non-compliance by some reasonable means, this is the\nfirst time You have received notice of non-compliance with this License\nfrom such Contributor, and You become compliant prior to 30 days after\nYour receipt of the notice.\n\n5.2. If You initiate litigation against any entity by asserting a patent\ninfringement claim (excluding declaratory judgment actions,\ncounter-claims, and cross-claims) alleging that a Contributor Version\ndirectly or indirectly infringes any patent, then the rights granted to\nYou by any and all Contributors for the Covered Software under Section\n2.1 of this License shall terminate.\n\n5.3. In the event of termination under Sections 5.1 or 5.2 above, all\nend user license agreements (excluding distributors and resellers) which\nhave been validly granted by You or Your distributors under this License\nprior to termination shall survive termination.\n\n************************************************************************\n* *\n* 6. Disclaimer of Warranty *\n* ------------------------- *\n* *\n* Covered Software is provided under this License on an \"as is\" *\n* basis, without warranty of any kind, either expressed, implied, or *\n* statutory, including, without limitation, warranties that the *\n* Covered Software is free of defects, merchantable, fit for a *\n* particular purpose or non-infringing. The entire risk as to the *\n* quality and performance of the Covered Software is with You. *\n* Should any Covered Software prove defective in any respect, You *\n* (not any Contributor) assume the cost of any necessary servicing, *\n* repair, or correction. This disclaimer of warranty constitutes an *\n* essential part of this License. No use of any Covered Software is *\n* authorized under this License except under this disclaimer. *\n* *\n************************************************************************\n\n************************************************************************\n* *\n* 7. Limitation of Liability *\n* -------------------------- *\n* *\n* Under no circumstances and under no legal theory, whether tort *\n* (including negligence), contract, or otherwise, shall any *\n* Contributor, or anyone who distributes Covered Software as *\n* permitted above, be liable to You for any direct, indirect, *\n* special, incidental, or consequential damages of any character *\n* including, without limitation, damages for lost profits, loss of *\n* goodwill, work stoppage, computer failure or malfunction, or any *\n* and all other commercial damages or losses, even if such party *\n* shall have been informed of the possibility of such damages. This *\n* limitation of liability shall not apply to liability for death or *\n* personal injury resulting from such party's negligence to the *\n* extent applicable law prohibits such limitation. Some *\n* jurisdictions do not allow the exclusion or limitation of *\n* incidental or consequential damages, so this exclusion and *\n* limitation may not apply to You. *\n* *\n************************************************************************\n\n8. Litigation\n-------------\n\nAny litigation relating to this License may be brought only in the\ncourts of a jurisdiction where the defendant maintains its principal\nplace of business and such litigation shall be governed by laws of that\njurisdiction, without reference to its conflict-of-law provisions.\nNothing in this Section shall prevent a party's ability to bring\ncross-claims or counter-claims.\n\n9. Miscellaneous\n----------------\n\nThis License represents the complete agreement concerning the subject\nmatter hereof. If any provision of this License is held to be\nunenforceable, such provision shall be reformed only to the extent\nnecessary to make it enforceable. Any law or regulation which provides\nthat the language of a contract shall be construed against the drafter\nshall not be used to construe this License against a Contributor.\n\n10. Versions of the License\n---------------------------\n\n10.1. New Versions\n\nMozilla Foundation is the license steward. Except as provided in Section\n10.3, no one other than the license steward has the right to modify or\npublish new versions of this License. Each version will be given a\ndistinguishing version number.\n\n10.2. Effect of New Versions\n\nYou may distribute the Covered Software under the terms of the version\nof the License under which You originally received the Covered Software,\nor under the terms of any subsequent version published by the license\nsteward.\n\n10.3. Modified Versions\n\nIf you create software not governed by this License, and you want to\ncreate a new license for such software, you may create and use a\nmodified version of this License if you rename the license and remove\nany references to the name of the license steward (except to note that\nsuch modified license differs from this License).\n\n10.4. Distributing Source Code Form that is Incompatible With Secondary\nLicenses\n\nIf You choose to distribute Source Code Form that is Incompatible With\nSecondary Licenses under the terms of this version of the License, the\nnotice described in Exhibit B of this License must be attached.\n\nExhibit A - Source Code Form License Notice\n-------------------------------------------\n\n This Source Code Form is subject to the terms of the Mozilla Public\n License, v. 2.0. If a copy of the MPL was not distributed with this\n file, You can obtain one at http://mozilla.org/MPL/2.0/.\n\nIf it is not possible or desirable to put the notice in a particular\nfile, then You may include the notice in a location (such as a LICENSE\nfile in a relevant directory) where a recipient would be likely to look\nfor such a notice.\n\nYou may add additional accurate notices of copyright ownership.\n\nExhibit B - \"Incompatible With Secondary Licenses\" Notice\n---------------------------------------------------------\n\n This Source Code Form is \"Incompatible With Secondary Licenses\", as\n defined by the Mozilla Public License, v. 2.0.\n",
"summary": "SVETlANNa is an open-source Python library for simulation of free-space optical set-ups and neuromorphic systems such as Diffractive Neural Networks.",
"version": "1.0.3",
"project_urls": {
"Documentation": "https://compphyslab.github.io/SVETlANNa/",
"Homepage": "https://github.com/CompPhysLab/SVETlANNa",
"Repository": "https://github.com/CompPhysLab/SVETlANNa"
},
"split_keywords": [
"optical neural network",
" diffractive neural network",
" pytorch",
" optical beam",
" optical setup",
" diffractive element",
" spatial light modulator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f4b531ce970469e502e9e86aa36d40e02b95823e69228e47891e93f57fe5ef9",
"md5": "12b5b950272c4d8edc574fde73ff64b8",
"sha256": "e29f2e97b4703e02fe892632fe488bc799891bfe7d6f6a22483a77b1e1d7195a"
},
"downloads": -1,
"filename": "svetlanna-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "12b5b950272c4d8edc574fde73ff64b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.11.0",
"size": 79690,
"upload_time": "2025-07-30T08:51:46",
"upload_time_iso_8601": "2025-07-30T08:51:46.275809Z",
"url": "https://files.pythonhosted.org/packages/3f/4b/531ce970469e502e9e86aa36d40e02b95823e69228e47891e93f57fe5ef9/svetlanna-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fce1dbc767b6f4a390ba29144db9ca44d18915d22f2e29ee33cd2475e05c0cd9",
"md5": "1742bcb5774806a0cb2a7b1c29a0f159",
"sha256": "5a8f9038119471b8c618fc3b7d027f25fdaf993d1aa52ee12f8ae795a41518cf"
},
"downloads": -1,
"filename": "svetlanna-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "1742bcb5774806a0cb2a7b1c29a0f159",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.11.0",
"size": 62308,
"upload_time": "2025-07-30T08:51:47",
"upload_time_iso_8601": "2025-07-30T08:51:47.668180Z",
"url": "https://files.pythonhosted.org/packages/fc/e1/dbc767b6f4a390ba29144db9ca44d18915d22f2e29ee33cd2475e05c0cd9/svetlanna-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 08:51:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CompPhysLab",
"github_project": "SVETlANNa",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "svetlanna"
}
