Metadata-Version: 2.4
Name: sol-usb
Version: 0.8.0
Summary: FPGA-based USB Analysis and SoC toolkit
Home-page: https://sol.shmdn.link/
Author: Katherine Temkin
Author-email: k@ktemkin.com
Maintainer: Aki Van Ness, Rachel Mant
Maintainer-email: aki@lethalbit.net, git@dragonmux.network
License: BSD-3-Clause
Project-URL: Documentation, https://sol.shmdn.link/
Project-URL: Source Code, https://github.com/shrine-maiden-heavy-industries/sol
Project-URL: Bug Tracker, https://github.com/shrine-maiden-heavy-industries/sol/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware :: Universal Serial Bus (USB)
Classifier: Typing :: Typed
Requires-Python: ~=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.docs
License-File: LICENSE.hardware
License-File: LICENSE.software
Requires-Dist: torii<1.0,>=0.8.0
Requires-Dist: torii-usb<1.0,>=0.8.0
Requires-Dist: usb-construct<1.0,>=0.2.1
Requires-Dist: pyserial~=3.5
Requires-Dist: pyvcd<0.5,>=0.4.0
Requires-Dist: rich
Provides-Extra: dev
Requires-Dist: nox; extra == "dev"
Provides-Extra: platform
Requires-Dist: pyusb~=1.2.0; extra == "platform"
Requires-Dist: libusb1~=1.9.2; extra == "platform"
Requires-Dist: luminary-fpga<=0.1.0,>=0.0.6; extra == "platform"
Requires-Dist: prompt-toolkit~=3.0.16; extra == "platform"
Requires-Dist: ziglang~=0.8.0; extra == "platform"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# SOL: Torii USB Analyzer

> [!IMPORTANT]
> The core USB gateware functionality has been moved to [Torii-USB], please see the
> SOL to Torii-USB [migration guide] for information on migrating your code.

SOL is a fork of [Luna] USB platform and Analyzer, it was ported from [Amaranth] to [Torii] and split into the core USB gateware library [Torii-USB] and SOL which contains the hardware platforms, SoC toolkit, and USB analyzer frontend.

SOL itself is at the moment purely a fork of the software, however the original LUNA hardware has been preserved in the repository under the [`hardware`] subdirectory.

## Installation

Please see the [installation instructions] on the [online documentation].

## License

The SOL gateware is released under the [BSD-3-Clause], the full text of which can be found in the [`LICENSE.software`]file.

The SOL hardware is released under the [CERN-OHL-P], the full text of which can be found in the [`LICENSE.hardware`] file.

The SOL documentation is released under the [CC-BY-4.0], the full text of which can be found in the [`LICENSE.docs`] file.

[migration guide]: https://torii-usb.shmdn.link/migration.html
[Luna]: https://github.com/greatscottgadgets/luna/
[Amaranth]: https://github.com/amaranth-lang
[Torii]: https://github.com/shrine-maiden-heavy-industries/torii-hdl
[Torii-USB]: https://github.com/shrine-maiden-heavy-industries/torii-usb
[`hardware`]: ./hardware/
[installation instructions]: https://sol.shmdn.link/install.html
[online documentation]: https://sol.shmdn.link/
[BSD-3-Clause]: https://spdx.org/licenses/BSD-3-Clause.html
[`LICENSE.software`]: ./LICENSE.software
[CERN-OHL-P]: https://ohwr.org/cern_ohl_p_v2.txt
[`LICENSE.hardware`]: ./LICENSE.hardware
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/
[`LICENSE.docs`]: ./LICENSE.docs
