Skip to content

Convert the repo to monorepo #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,16 @@ dist-ssr
*.sln
*.sw?

public/*.zarr/
*.zarr

## Python widget

.venv
dist
.DS_Store

# Python
__pycache__
.ipynb_checkpoints

**/*/static
55 changes: 44 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,57 @@
## Overview

DeckGL layers and helpers to visualize numeric data. The example of the numeric data can be such as Zarr V3 data containing GeoZarr compliant multiscales, numpy arrays.

`NumericDataLayer` is meant to be used as a subLayer of DeckGL's TileLayer. This means that input data should conform to tilesize×tilesize dimensions (e.g., 256×256, 512×512) to ensure proper rendering and optimization within the tiling system.

## Running a development environment
The repo is organized into multiple packages to provide both Javascript and Python bindings for Numeric Data Layer.

1. Clone the repo
The packages included in this repo are

```
git clone https://github.com/your-org/your-repo.git
cd your-repo
1. **Core Library** (`packages/numeric-data-layer/`) - TypeScript/JavaScript DeckGL layers. This package includes helpers to parse numeric data foramt such as zarr and numpty tiles.
2. **Examples Application** (`packages/examples/`) - React demo application
3. **Python Widget** (`packages/python-widget/`) - Jupyter notebook widget

```

2. Run Local Dev Environment
## Local Development Setup

### Prerequisites

- **Node.js**
- **PNPM** (preferred package manager for workspace management)
- **Python**

### Getting Started

1. **Clone the Repository**
```bash
git clone https://github.com/developmentseed/geozarr-numeric-data-layer.git
cd geozarr-numeric-data-layer
```

2. **Install dependencies**
The command below will install all dependencies in all the projects.

```bash
pnpm install
```
npm install
npm run dev

### Development Commands

#### Hot Reloading

If you want to see the change you are making to the core package from the other package (ex. from one of the example) in real time, the commands below are your friend.

```bash
# Terminal 1: Core library in watch mode
pnpm dev:core

# Terminal 2: Examples application
pnpm dev:examples

# Terminal 3: Python widget (if developing)
pnpm dev:widgets
```

The example app will then be accessible at http://localhost:5173.
#### Package specific set up

See each package's readme and package.json file for package-specific commands.
Loading