Skip to content

Commit 0088a17

Browse files
committed
update readme
1 parent 53b0f7c commit 0088a17

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,27 @@ result = binning.mean_binning(
118118
)
119119
```
120120

121+
### Time Series Processing
122+
123+
The tool automatically handles time dimensions:
124+
125+
```python
126+
# Works seamlessly with time-varying datasets
127+
# Input: (time, lat, lon) -> Output: (time, lat_low, lon_low)
128+
result = binning.mean_binning()
129+
```
130+
## Configuration for CMEMS data download
131+
132+
### Environment Variables
133+
134+
Copy `.env.template` to `.env` and configure:
135+
136+
```bash
137+
# Copernicus Marine Service credentials (if using CMEMS data)
138+
COPERNICUSMARINE_SERVICE_USERNAME=<your_username>
139+
COPERNICUSMARINE_SERVICE_PASSWORD=<your_password>
140+
```
141+
121142
## API Reference
122143

123144
### Binning Class
@@ -159,34 +180,13 @@ map_binning/
159180
├── tests/ # Unit tests
160181
│ ├── __init__.py
161182
│ └── ...
162-
├── pickle_folder/ # Default location for cached indices
163183
├── pyproject.toml # Project configuration
164184
├── environment.yml # Conda environment specification
165185
├── .env.template # Environment variables template
166186
└── README.md # This file
167187
```
168188

169-
## Configuration for CMEMS data download
170-
171-
### Environment Variables
172-
173-
Copy `.env.template` to `.env` and configure:
174-
175-
```bash
176-
# Copernicus Marine Service credentials (if using CMEMS data)
177-
COPERNICUSMARINE_SERVICE_USERNAME=<your_username>
178-
COPERNICUSMARINE_SERVICE_PASSWORD=<your_password>
179-
```
180-
181-
### Time Series Processing
182-
183-
The tool automatically handles time dimensions:
184189

185-
```python
186-
# Works seamlessly with time-varying datasets
187-
# Input: (time, lat, lon) -> Output: (time, lat_low, lon_low)
188-
result = binning.mean_binning()
189-
```
190190

191191
## Performance Considerations
192192

0 commit comments

Comments
 (0)