Skip to content

Commit ee507a5

Browse files
committed
Updated readme to include PyPI instructions
1 parent 6556b15 commit ee507a5

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# RawRefinery
22

3+
[![PyPI version](https://img.shields.io/pypi/v/RawHandler.svg)](https://pypi.org/project/rawrefinery/)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
[![Python version](https://img.shields.io/pypi/pyversions/RawHandler.svg)](https://pypi.org/project/rawrefinery/)
6+
37
**RawRefinery** is an open-source application for **raw image quality refinement and denoising**.
48

59
Currently in **alpha release**, RawRefinery provides a high-quality raw image denoising tool that works directly on most Bayer image formats, including those from **Canon, Nikon, and Sony** cameras.
@@ -33,6 +37,43 @@ It uses a deep learning–based denoising model designed to preserve fine image
3337

3438
## Installation
3539

40+
### Install via PyPI (All OS):
41+
42+
RawRefinery is now on PyPI!
43+
44+
https://pypi.org/project/rawrefinery/1.3.0/
45+
46+
You can install with pip as follows with python 3.11+:
47+
48+
#### Setting up the enviroment
49+
Example instructions for setting up the enviorment in an apt based linux OS:
50+
51+
```bash
52+
# Set up python 3.11+
53+
sudo apt update
54+
sudo apt install python3 python3-pip python3-venv build-essential python3-dev
55+
56+
# Clone the repository from GitHub
57+
git clone https://github.com/rymuelle/RawRefinery.git
58+
cd RawRefinery
59+
60+
# Create the virtual environment named '.venv'
61+
python3 -m venv .venv
62+
```
63+
64+
#### Install via PyPI
65+
66+
```bash
67+
python -m pip install rawrefinery==1.3.0
68+
```
69+
70+
And run in bash:
71+
72+
```bash
73+
rawrefinery
74+
```
75+
76+
3677
### Build from source from git (linux):
3778

3879
https://github.com/rymuelle/RawRefinery/tree/main/linux

0 commit comments

Comments
 (0)