An open API service indexing awesome lists of open source software.

https://github.com/prism-spectra/spectroforge

Prescription-based Spectrograph Design, Verification and Data Processing Tool
https://github.com/prism-spectra/spectroforge

spectrograph spectrograph-design spectrograph-images spectrograph-models

Last synced: 4 days ago
JSON representation

Prescription-based Spectrograph Design, Verification and Data Processing Tool

Awesome Lists containing this project

README

          

# SpectroForge: The Spectrograph Designer

[![DOI](https://zenodo.org/badge/1210953724.svg)](https://zenodo.org/badge/latestdoi/1210953724)

SpectroForge aids in design and optimization of single-grating spectrographs.
It provides a user-friendly interface to explore various configurations and parameters, enabling users to visualize and analyze the performance of their spectrograph designs.

## Installation
To install SpectroForge, follow these steps:
1. Go to the [Releases](https://github.com/sunipkm/SpectroForge/releases) page and download the latest version for your operating system.
2. Extract the downloaded file.

### Windows
1. Extract the installer executable from the downloaded archive.
2. Run the installer and follow the on-screen instructions to complete the installation.
3. Once installed, you can launch SpectroForge from the Start Menu.

> [!TIP]
> Windows users may need to allow the application to run by clicking "More info" and then "Run anyway" if prompted by Windows Defender SmartScreen.

### macOS
1. Mount the downloaded DMG file by double-clicking it.
2. Drag the SpectroForge application to your Applications folder.
3. You can launch SpectroForge from the Applications folder.

> [!TIP]
> macOS users may need to allow the application to run by going to System Preferences > Security & Privacy > General and clicking "Open Anyway" for SpectroForge.

### Linux
#### Debian/Ubuntu
1. Launch a terminal and navigate to the directory where you downloaded the .deb file.
2. Install the package using the following command:
```bash
sudo dpkg -i SpectroForge-.deb
```
3. If there are any dependency issues, run:
```bash
sudo apt-get install -f
```
4. Once installed, you can launch SpectroForge from your application menu.
5. Alternatively, you can run it from the terminal using:
```bash
spectroforge
```
#### Other Linux Distributions
1. Download the `SpectroForge-.AppImage` file.
2. Make the AppImage executable by running the following command in the terminal:
```bash
chmod +x SpectroForge-.AppImage
```
3. Run the AppImage using the following command:
```bash
./SpectroForge-.AppImage
```
4. You can also create a desktop shortcut for easier access.

## Usage
Once you have SpectroForge installed, you can start designing your spectrograph by opening the application, and modifying the parameters in the control panel on the right.

## Documentation
For detailed documentation on how to use SpectroForge, please refer to the [User Guide](https://sunipkm.github.io/SpectroForge/).

## License
SpectroForge is licensed under the SpectroForge Software License. Please see the [LICENSE](LICENSE) file for more details.

> [!IMPORTANT]
> ⚠️ Disclaimer
> **This software is provided "AS IS" without any warranty of any kind.** The software does not come with any guarantees regarding functionality, reliability, or fitness for any particular purpose. Installation and use of this software is at the user's own risk. The author is not responsible for any damage, data loss, or other consequences that may result from the installation or use of this software.

## Citation

If you use SpectroForge to design an instrument, please cite the use of the tool:

```bibtex
@software{spectroforge_mukherjee_2026,
author = {Sunip Mukherjee},
title = {prism-spectra/SpectroForge: v0.0.3},
month = may,
year = 2026,
publisher = {Zenodo},
version = {v0.0.2},
doi = {10.5281/zenodo.20469410},
url = {https://doi.org/10.5281/zenodo.20469410},
swhid = {swh:1:dir:86074949b31981cbf7778a0ad77bcd7e11d07dd2
;origin=https://doi.org/10.5281/zenodo.20469409;vi
sit=swh:1:snp:6c295f2f9cd0f241c79a47a71aae8d048a69
cf05;anchor=swh:1:rel:7f0f573bfa7d85af2f43a86f1491
fcefb411bc63;path=prism-spectra-SpectroForge-
bc2e455
},
}
```