Metadata-Version: 2.4
Name: synth_spectra
Version: 0.1.0
Summary: A package to generate synthetic spectra for testing purposes.
Author-email: Ashley Bemis <arbemis@gmail.com>, Annabella Meech <annabella.meech@cfa.harvard.edu>
Project-URL: Homepage, https://github.com/ashleyrbemis/synth_spectra
Project-URL: Issues, https://github.com/ashleyrbemis/synth_spectra/issues
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
Requires-Dist: scipy
Dynamic: license-file

# Synthetic Spectra Generator

This is a simple tool for generating synthetic astronomical spectra. You can use it to create test data with multiple Gaussian components and control the amount of noise.

### How It's Organized

* `config.py`: Contains all the default spectra properties you might want to tweak, like the spectral range and noise levels.
* `spectrum_utils.py`: The core library with functions that do the actual work of building a spectrum.
* `plotting.py`: The main script you execute to see an example plot.

### Getting Started

1.  **Clone the repo:**
    ```bash
    git clone https://github.com/ashleyrbemis/synth_spectra.git
    cd synth_spectra
    ```

2.  **Set up the environment:**
    This project uses Conda. Make sure your `codeastro` environment is active and has the necessary packages.
    ```bash
    conda activate codeastro
    conda install numpy scipy matplotlib
    ```

3.  **Installation:**
    ```bash
    pip install -e .
    ```

4.  **Run the code:**
    ```python
    import synth_spectra
    import matplotlib.pyplot as plt
    spec   = synth_spectra.generate_synthetic_spectrum()
    fig,ax = synth_spectra.plot_spectrum(spec)
    plt.show()
    ```
    This will generate a sample spectrum and show you a plot.
