rainbowkit 0.0.2__tar.gz → 0.0.3__tar.gz

rainbowkit-0.0.3/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: rainbowkit
+Version: 0.0.3
+Summary: Tools to work with spectra
+Author-email: Sourav Das <souravdas.sd20@gmail.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Dynamic: license-file
+
+# RainbowKit
+
+RainbowKit is a Python toolkit for spectral analysis. It allows you to create spectrum objects and perform various tasks, such as plotting spectra, marking spectral lines, and estimating redshifts from observed spectral transitions.
+
+## Features
+
+- Create and manipulate spectrum objects
+- Plot flux versus wavelength
+- Plot normalized flux
+- Mark important spectral lines for analysis
+- Estimate redshift from spectral transitions
+
+## Installation
+
+You can install RainbowKit using pip:
+
+```bash
+pip install rainbowkit
+```
+
+RainbowKit requires Python 3.8 or later.
+
+## Quick start
+
+Import RainbowKit:
+
+```python
+import rainbowkit
+```
+
+RainbowKit includes an example spectrum, which can be loaded directly:
+
+```python
+spec = rainbowkit.Spectrum()
+```
+
+or your own spectrum file:
+
+```python
+spec = rainbowkit.Spectrum("my_spectrum.dat")
+```
+
+You can then plot the spectrum:
+
+```python
+spec.fplot()
+```
+
+or plot the normalized spectrum:
+
+```python
+spec.nfplot()
+```
+
+The input file should contain four columns:
+
+1. Wavelength
+2. Flux
+3. Error
+4. Continuum
+
+Important spectral transitions can be marked on the spectrum:
+
+```python
+spec.marklines()
+```
+
+The lines can also be shifted according to a redshift:
+
+```python
+spec.marklines(z=3.0)
+```
+
+RainbowKit can estimate the redshift of a spectral transition interactively.
+
+For example:
+
+```python
+spec.getz("CIV_1548")
+```
+
+After calling this method, click on the observed transition in the plotted spectrum.
+RainbowKit will calculate and print the corresponding redshift.
+
+## Example workflow
+
+A minimal working example:
+
+```python
+import rainbowkit
+
+spec = rainbowkit.Spectrum()  # default example spectrum
+# For user-provided spectrum
+# spec = rainbowkit.Spectrum('my_spectrum.dat')
+
+spec.nfplot()
+spec.marklines()
+```
+
+## Input Spectrum Format
+
+RainbowKit expects a plain-text spectrum containing four columns:
+
+| Column | Description |
+|---|---|
+| 1 | Wavelength |
+| 2 | Flux |
+| 3 | Error |
+| 4 | Continuum |
+
+The columns should be separated by whitespace.
+
+## Requirements
+
+- Python >= 3.8
+- NumPy
+- Matplotlib
+
+## Acknowledgements
+
+I would like to thank Prof. Sowgat Muzahid at the Inter-University Centre for Astronomy and Astrophysics (IUCAA), who was my MSc supervisor, for his guidance and support during the development of this work.
+
+I am particularly grateful to him for providing the spectral line lists and the example spectrum included with RainbowKit.
+
+## License
+
+RainbowKit is released under the MIT License. See the `LICENSE` file for details.
+
+## Author
+
+[Sourav Das](https://github.com/PhysicistSouravDas "PhysicistSouravDas GitHub page")
+

rainbowkit-0.0.3/README.md

@@ -0,0 +1,132 @@
+# RainbowKit
+
+RainbowKit is a Python toolkit for spectral analysis. It allows you to create spectrum objects and perform various tasks, such as plotting spectra, marking spectral lines, and estimating redshifts from observed spectral transitions.
+
+## Features
+
+- Create and manipulate spectrum objects
+- Plot flux versus wavelength
+- Plot normalized flux
+- Mark important spectral lines for analysis
+- Estimate redshift from spectral transitions
+
+## Installation
+
+You can install RainbowKit using pip:
+
+```bash
+pip install rainbowkit
+```
+
+RainbowKit requires Python 3.8 or later.
+
+## Quick start
+
+Import RainbowKit:
+
+```python
+import rainbowkit
+```
+
+RainbowKit includes an example spectrum, which can be loaded directly:
+
+```python
+spec = rainbowkit.Spectrum()
+```
+
+or your own spectrum file:
+
+```python
+spec = rainbowkit.Spectrum("my_spectrum.dat")
+```
+
+You can then plot the spectrum:
+
+```python
+spec.fplot()
+```
+
+or plot the normalized spectrum:
+
+```python
+spec.nfplot()
+```
+
+The input file should contain four columns:
+
+1. Wavelength
+2. Flux
+3. Error
+4. Continuum
+
+Important spectral transitions can be marked on the spectrum:
+
+```python
+spec.marklines()
+```
+
+The lines can also be shifted according to a redshift:
+
+```python
+spec.marklines(z=3.0)
+```
+
+RainbowKit can estimate the redshift of a spectral transition interactively.
+
+For example:
+
+```python
+spec.getz("CIV_1548")
+```
+
+After calling this method, click on the observed transition in the plotted spectrum.
+RainbowKit will calculate and print the corresponding redshift.
+
+## Example workflow
+
+A minimal working example:
+
+```python
+import rainbowkit
+
+spec = rainbowkit.Spectrum()  # default example spectrum
+# For user-provided spectrum
+# spec = rainbowkit.Spectrum('my_spectrum.dat')
+
+spec.nfplot()
+spec.marklines()
+```
+
+## Input Spectrum Format
+
+RainbowKit expects a plain-text spectrum containing four columns:
+
+| Column | Description |
+|---|---|
+| 1 | Wavelength |
+| 2 | Flux |
+| 3 | Error |
+| 4 | Continuum |
+
+The columns should be separated by whitespace.
+
+## Requirements
+
+- Python >= 3.8
+- NumPy
+- Matplotlib
+
+## Acknowledgements
+
+I would like to thank Prof. Sowgat Muzahid at the Inter-University Centre for Astronomy and Astrophysics (IUCAA), who was my MSc supervisor, for his guidance and support during the development of this work.
+
+I am particularly grateful to him for providing the spectral line lists and the example spectrum included with RainbowKit.
+
+## License
+
+RainbowKit is released under the MIT License. See the `LICENSE` file for details.
+
+## Author
+
+[Sourav Das](https://github.com/PhysicistSouravDas "PhysicistSouravDas GitHub page")
+

{rainbowkit-0.0.2 → rainbowkit-0.0.3}/pyproject.toml

@@ -4,16 +4,23 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rainbowkit"
-version = "0.0.2"
+version = "0.0.3"
 authors = [
   { name="Sourav Das", email="souravdas.sd20@gmail.com" },
 ]
 description = "Tools to work with spectra"
 readme = "README.md"
 requires-python = ">=3.8"
+dependencies=[
+    "numpy",
+    "matplotlib",
+]
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
 
+[tool.setuptools.package-data]
+rainbowkit = ["*.dat"]
+

rainbowkit-0.0.3/rainbowkit/__init__.py

@@ -0,0 +1,2 @@
+from .rainbowkit import Spectrum
+

{rainbowkit-0.0.2 → rainbowkit-0.0.3}/rainbowkit/rainbowkit.py

@@ -2,6 +2,8 @@ import numpy as np
 import matplotlib.pyplot as plt
 import matplotlib.offsetbox as offsetbox
 
+from importlib.resources import files
+
 from . import linelist as ll
 
 class Spectrum():
@@ -33,9 +35,16 @@ class Spectrum():
         'SiIII_1206', 'SiIV_1402', 'SiIV_1393',
     )
 
-    def __init__(self, filename, ):
-        self.filename = filename
-        f = open(self.filename)
+    def __init__(self, filename=None):
+
+        if filename is None:
+            # default spectrum
+            f = files("rainbowkit").joinpath("spec_PKS0405-12.dat").open("r")
+            self.filename = "spec_PKS0405-12.dat"
+        else:
+            f = open(filename)
+            self.filename = filename
+
         wvlength = []
         flux = []
         cont = []    # continuum
@@ -45,7 +54,7 @@ class Spectrum():
             wvlength.append(float(line[0].lstrip().rstrip()))
             flux.append(float(line[1].lstrip().rstrip()))
             cont.append(float(line[3].lstrip().rstrip()))
-        
+
         f.close()
 
         self.wvlength = np.asarray(wvlength)
@@ -57,14 +66,14 @@ class Spectrum():
         # Keep track of added lines and annotations
         self.added_lines = []
         self.added_annotations = []
-        
+
         # Store the clicked coordinates
         self.clicked_coords = None
         self.cid = None
 
         # Storing the transition value of getz
         self.transition = None
-    
+
     def fplot(self):
         """
         Method to plot flux vs wavelength