https://github.com/ejoliet/firefly-vscode-extension
VSCode extension for visualizing FITS files with Firefly tool
https://github.com/ejoliet/firefly-vscode-extension
firefly fits-image visual-studio visualization vscode vscode-extension
Last synced: 2 months ago
JSON representation
VSCode extension for visualizing FITS files with Firefly tool
- Host: GitHub
- URL: https://github.com/ejoliet/firefly-vscode-extension
- Owner: ejoliet
- Created: 2024-07-27T02:03:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-21T22:05:08.000Z (about 1 year ago)
- Last Synced: 2025-05-21T23:20:58.365Z (about 1 year ago)
- Topics: firefly, fits-image, visual-studio, visualization, vscode, vscode-extension
- Language: Python
- Homepage:
- Size: 701 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# FITS Viewer Extension
This Visual Studio Code extension allows you to open FITS files in a browser using the Firefly library.
## Features
- Open FITS files directly from the VSCode Explorer.
- View FITS files in a web browser with Firefly.
## Usage
1. Right-click on a FITS file in the VSCode Explorer.
2. Select "Open FITS File" from the context menu.
3. The FITS file will open in your default web browser.
## Development
This uses scaffolding code 'yo', installed with:
```bash
npm install -g yo generator-code
```
And run to create the structure of the repos:
```bash
yo code
```
Updates are in `src/extension.ts` and `package.json`
### Prerequisites
- [Node.js](https://nodejs.org/) (version 14 or higher recommended)
- [npm](https://www.npmjs.com/) (usually comes with Node.js)
- [Visual Studio Code](https://code.visualstudio.com/)
### Setup
1. Clone the repository:
```bash
git clone https://github.com/ejoliet/firefly-vscode-extension.git
cd firefly-vscode-extension
```
2. Install dependencies:
```bash
npm install
```
3. Build the extension:
```bash
npm run compile
```
4. Open the extension in VSCode:
```bash
code .
```
5. Launch the extension:
- Press `F5` to open a new VSCode window with your extension loaded.
## Installation
Build package with
```bash
vsce package
```
### From VSIX File
1. Download the `.vsix` file from the provided link.
2. Open VSCode.
3. Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X` on macOS).
4. Click the three-dot menu (`...`) at the top-right corner.
5. Select "Install from VSIX..." and choose the downloaded `.vsix` file.
## Extension Settings
This extension does not require any specific settings.
## Known Issues
- Ensure the FITS file is accessible and not corrupted.
## Release Notes
### 0.0.1
- Initial release of FITS Viewer Extension.