Skip to content

Commit 9f56047

Browse files
Update README.md
1 parent 2363c6d commit 9f56047

File tree

1 file changed

+11
-61
lines changed

1 file changed

+11
-61
lines changed

README.md

+11-61
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# radio-galaxy-classifier
1+
# RGC: Radio Galaxy Classifier 📡✨
22

33
[![Release](https://img.shields.io/github/v/release/mirsazzathossain/radio-galaxy-classifier)](https://img.shields.io/github/v/release/mirsazzathossain/radio-galaxy-classifier)
44
[![Build status](https://img.shields.io/github/actions/workflow/status/mirsazzathossain/radio-galaxy-classifier/ci.yml?branch=main)](https://github.com/mirsazzathossain/radio-galaxy-classifier/actions/workflows/ci.yml?query=branch%3Amain)
@@ -7,69 +7,19 @@
77
[![License](https://img.shields.io/github/license/mirsazzathossain/radio-galaxy-classifier?label=license)](https://img.shields.io/github/license/mirsazzathossain/radio-galaxy-classifier?label=license)
88
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
99

10-
This is a template repository for Python projects that use uv for their dependency management.
10+
Welcome to **RGC** (Radio Galaxy Classifier) — a Python package designed to process and classify radio galaxy images with ease! 🌌 The acronym also alludes to **Radha Govinda Chandra** (1878–1975), a Bangladeshi-Indian variable star observer who made significant contributions to astronomy. 🔭✨
1111

12-
- **Github repository**: <https://github.com/mirsazzathossain/radio-galaxy-classifier/>
13-
- **Documentation** <https://mirsazzathossain.github.io/radio-galaxy-classifier/>
12+
### Features 🚀
13+
- 📊 **Data Preprocessing**: Simplifies handling of radio images.
14+
- 🧠 **Classification Tools**: Provides tools for categorizing Narrow-Angle Tailed (NAT) and Wide-Angle Tailed (WAT) galaxies.
15+
- 🛠️ **Customizable Pipelines**: Build flexible pipelines for image analysis.
1416

15-
## Getting started with your project
16-
17-
### 1. Create a New Repository
18-
19-
First, create a repository on GitHub with the same name as this project, and then run the following commands:
20-
21-
```bash
22-
git init -b main
23-
git add .
24-
git commit -m "init commit"
25-
git remote add origin git@github.com:mirsazzathossain/radio-galaxy-classifier.git
26-
git push -u origin main
27-
```
28-
29-
### 2. Set Up Your Development Environment
30-
31-
Then, install the environment and the pre-commit hooks with
32-
33-
```bash
34-
make install
35-
```
36-
37-
This will also generate your `uv.lock` file
38-
39-
### 3. Run the pre-commit hooks
40-
41-
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
42-
43-
```bash
44-
uv run pre-commit run -a
45-
```
46-
47-
### 4. Commit the changes
48-
49-
Lastly, commit the changes made by the two steps above to your repository.
17+
### Documentation 📚
18+
Find detailed guides and examples at **[Documentation](https://mirsazzathossain.github.io/radio-galaxy-classifier/)**.
5019

20+
Get started quickly by installing with:
5121
```bash
52-
git add .
53-
git commit -m 'Fix formatting issues'
54-
git push origin main
22+
pip install rgc
5523
```
5624

57-
You are now ready to start development on your project!
58-
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
59-
60-
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
61-
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
62-
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
63-
64-
## Releasing a new version
65-
66-
- Create an API Token on [PyPI](https://pypi.org/).
67-
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/mirsazzathossain/radio-galaxy-classifier/settings/secrets/actions/new).
68-
- Create a [new release](https://github.com/mirsazzathossain/radio-galaxy-classifier/releases/new) on Github.
69-
- Create a new tag in the form `*.*.*`.
70-
71-
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
72-
73-
---
74-
75-
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
25+
Explore the tools and contribute to enhancing radio galaxy research! 💫

0 commit comments

Comments
 (0)