Skip to content

Commit 1fa030f

Browse files
authored
supply all major classes via wkcuber.api (#350)
1 parent 0a5458d commit 1fa030f

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

wkcuber/api/__init__.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
## Examples
1212
### Opening Datasets
1313
```python
14-
from wkcuber.api.dataset import Dataset
14+
from wkcuber.api import Dataset
1515
1616
dataset = Dataset(<path_to_dataset>)
1717
# Assuming that the dataset has a layer called 'color' and the layer has the magnification "1"
@@ -21,8 +21,8 @@
2121
2222
### Creating Datasets
2323
```python
24-
from wkcuber.api.dataset import Dataset
25-
from wkcuber.api.layer import Layer
24+
from wkcuber.api import Dataset
25+
from wkcuber.api import Layer
2626
2727
dataset = Dataset.create(<path_to_new_dataset>, scale=(1, 1, 1))
2828
layer = dataset.add_layer(
@@ -37,7 +37,7 @@
3737
3838
### Reading Datasets
3939
```python
40-
from wkcuber.api.dataset import Dataset
40+
from wkcuber.api import Dataset
4141
4242
dataset = Dataset(<path_to_dataset>)
4343
# Assuming that the dataset has a layer called 'color' and the layer has the magnification "1" and "2"
@@ -54,7 +54,7 @@
5454
5555
### Writing Datasets
5656
```python
57-
from wkcuber.api.dataset import Dataset
57+
from wkcuber.api import Dataset
5858
5959
dataset = Dataset(<path_to_dataset>)
6060
# Assuming that the dataset has a layer called 'color' and the layer has the magnification "1" and "2"
@@ -74,3 +74,9 @@
7474
)
7575
```
7676
"""
77+
78+
from .bounding_box import BoundingBox
79+
from .dataset import Dataset
80+
from .layer import Layer
81+
from .mag_view import MagView
82+
from .view import View

0 commit comments

Comments
 (0)