Skip to content

Commit

Permalink
[SWE] Update PyPI README.
Browse files Browse the repository at this point in the history
  • Loading branch information
SepandKashani committed Oct 3, 2023
1 parent b4c3b1a commit bf8cca4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions dev/README_no_html.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ Pyxu: Modular and Scalable Computational Imaging
:target: https://doi.org/10.5281/zenodo.4486431


**Pyxu** (pronounced [piksu], formerly known as Pycsou) is an open-source Python framework allowing scientists at any
level to quickly prototype/deploy *hardware accelerated and out-of-core* computational imaging pipelines at scale.
Thanks to its **microservice architecture** and tight integration with the PyData ecosystem, Pyxu supports a wide range
of imaging applications, scales, and computation architectures.

What Makes Pyxu Special?
------------------------

Expand Down Expand Up @@ -100,9 +105,9 @@ Basic Installation

The core of **Pyxu** is lightweight and straightforward to install. You'll need Python (>= 3.9, < 3.12) and a few
mandatory dependencies. While these dependencies will be automatically installed via ``pip``, we highly recommend
installing NumPy and SciPy via ``conda`` to benefit from Intel MKL bindings and speed optimizations.
installing NumPy and SciPy via ``conda`` to benefit from optimized math libraries.

First, to install NumPy and SciPy from the conda-forge channel:
First, to install NumPy and SciPy from conda-forge:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ build-backend = "hatchling.build"
name = "pyxu"
dynamic = ["version"]
description = "Modular and scalable computational imaging in Python with support for GPU/out-of-core computing."
readme = "README.rst"
readme = "dev/README_no_html.rst"
requires-python = ">= 3.9, < 3.12"
license = "MIT"
authors = [
Expand Down

0 comments on commit bf8cca4

Please sign in to comment.