{"id":37634357,"url":"https://github.com/rmcd-mscb/netcdf-viewer","last_synced_at":"2026-01-16T11:01:26.915Z","repository":{"id":296300387,"uuid":"992911329","full_name":"rmcd-mscb/netcdf-viewer","owner":"rmcd-mscb","description":"A vscode extension for viewing the contents of a NetCDF file.","archived":false,"fork":false,"pushed_at":"2025-06-06T14:21:19.000Z","size":16664,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-06T14:27:03.418Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rmcd-mscb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-29T22:57:12.000Z","updated_at":"2025-06-06T14:21:21.000Z","dependencies_parsed_at":"2025-05-30T00:25:28.913Z","dependency_job_id":"0cf1d67b-caa5-45d3-b83f-ef2b39d53d77","html_url":"https://github.com/rmcd-mscb/netcdf-viewer","commit_stats":null,"previous_names":["rmcd-mscb/netcdf-viewer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rmcd-mscb/netcdf-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Fnetcdf-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Fnetcdf-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Fnetcdf-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Fnetcdf-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rmcd-mscb","download_url":"https://codeload.github.com/rmcd-mscb/netcdf-viewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmcd-mscb%2Fnetcdf-viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-16T11:01:26.829Z","updated_at":"2026-01-16T11:01:26.890Z","avatar_url":"https://github.com/rmcd-mscb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NetCDF Viewer for VS Code\n\n**NetCDF Viewer** is a Visual Studio Code extension that lets you explore and inspect NetCDF files (`.nc`, `.nc4`, `.cdf`, `.h5`) directly within your editor. Designed for scientists, engineers, and data analysts, this extension provides a fast, interactive way to browse datasets, view metadata, and preview sample data—without leaving VS Code.\n\n---\n\n## ✨ Features\n\n- **Browse NetCDF files** in a dedicated sidebar tree view\n- **Expand dimensions, coordinates, and data variables** just like in xarray\n- **View variable attributes and sample data** with a simple click\n- **No need for external tools**—all inspection is done in the editor\n- **Python-powered backend** for robust NetCDF parsing\n\n## 📂 Supported Formats \u0026 Limitations\n\n- Works with local NetCDF files: `.nc`, `.nc4`, `.cdf`, `.h5`.\n- Primarily tested with NetCDF4/HDF5—older NetCDF3 files may not display all metadata.\n- Only a small preview of each variable (first ten values) is shown in the tree view.\n- Loading extremely large files can take additional time and memory.\n\n---\n\n## Demonstration\n\n1. From the Command Palette, type `netcdf-viewer.selectPythonEnv` to select your Python environment.\n\n   ![NetCDF Viewer Python Environment Selection](media/Select_python_env.gif)\n\n2. Open a NetCDF file in the editor.\n   - from the Welcome page, click on the \"Open NetCDF File\" button\n\n      ![NetCDF Viewer Open File Demo](media/Select_netcdf_file_1.gif)\n\n   - or right-click a `.nc` file in the Explorer and select **Open in NetCDF Viewer**\n\n      ![NetCDF Viewer Open File Demo - right-click](media/Select_netcdf_file_2.gif)\n\n   - or use the command palette: `NetCDF Viewer: Open File…`\n\n      ![NetCDF Viewer Open File Demo - command palette](media/Select_netcdf_file_3.gif)\n\n## 📦 Installation\n\n### From the VS Code Marketplace\n\n1. Open the Extensions view (`Ctrl+Shift+X`).\n2. Search for **NetCDF Viewer**.\n3. Click **Install**.\n\n### From Source\n\n1. Clone this repository:\n\n   ```sh\n   git clone https://github.com/rmcd-mscb/netcdf-viewer.git\n   cd netcdf-viewer\n   ```\n\n2. Install dependencies:\n\n   ```sh\n   npm install\n   ```\n\n3. Open the folder in VS Code:\n\n   ```sh\n   code .\n   ```\n\n4. Press `F5` to launch the extension in a new Extension Development Host window.\n\n## 🔄 Updating \u0026 Uninstalling\n\n### Updating\n\n- **Marketplace**: Open the Extensions view and click the refresh icon to check for updates (or enable auto-update).\n- **VSIX**: Download the latest `.vsix` and run `code --install-extension netcdf-viewer-\u003cversion\u003e.vsix`.\n\n### Uninstalling\n\n1. Open the Extensions view (`Ctrl+Shift+X`).\n2. Locate **NetCDF Viewer** in your installed extensions.\n3. Click the gear icon and choose **Uninstall**.\n\n---\n\n## 🐍 Python Requirements\n\nThis extension uses Python (via [xarray](https://xarray.dev/) and [netCDF4](https://unidata.github.io/netcdf4-python/)) to parse NetCDF files.\n\n**You must have:**\n\n- Python 3.7+\n- `xarray` and `netCDF4` installed in your Python environment\n\nIf you use a custom Python path, set it in your VS Code settings:\n\n- Select **File \u003e Preferences \u003e Settings** (or `Ctrl+,`)\n- Search for `netcdfViewer.pythonPath`\n- Set the path to your Python executable:\n\n```markdown\n\"netcdfViewer.pythonPath\": \"/path/to/python\"\n```\n\n---\n\n## 🚀 Usage\n\n1. **Open the NetCDF Viewer**  \n   Find the **NetCDF Explorer** in the Activity Bar or Side Bar.\n\n2. **Open a NetCDF file**  \n   - Right-click a `.nc` file in the Explorer and select **Open in NetCDF Viewer**  \n   - Or use the command palette: `NetCDF Viewer: Open File…`\n\n3. **Browse your data**  \n   - Expand **Dimensions**, **Coordinates**, and **Data Variables**.\n   - Click on a variable to expand and see its attributes and a sample of its data.\n\n---\n\n## 🛠️ Development \u0026 Packaging\n\nThis extension is written in TypeScript and uses a Python script for data extraction.\n\n**To package for VS Code:**\n\n1. Build the extension:\n\n   ```sh\n   npm run compile\n   ```\n\n2. Package it:\n\n   ```sh\n   npx vsce package\n   ```\n\n   This will create a `.vsix` file you can install or distribute.\n\n**To install a VSIX:**\n\n```sh\ncode --install-extension netcdf-viewer-*.vsix\n```\n\n---\n\n## 💡 Why NetCDF Viewer?\n\n- No more switching between command-line tools and your editor\n- Instantly inspect large scientific datasets\n- Works cross-platform (Windows, macOS, Linux)\n- Familiar xarray-like organization\n\n---\n\n## 📝 Feedback \u0026 Issues\n\nFound a bug or have a feature request?  \n[Open an issue on GitHub](https://github.com/rmcd-mscb/netcdf-viewer/issues).\n\n---\n\n## 📄 License\n\nPlease see [LICENSE.md](LICENSE.md) for details.\n\n---\n\n## Contributing\n\nPlease see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on setting up your development environment and making contributions.\n\n---\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for a history of changes to this project.\n\n---\n\n**Happy data exploring!**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmcd-mscb%2Fnetcdf-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frmcd-mscb%2Fnetcdf-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmcd-mscb%2Fnetcdf-viewer/lists"}