Metadata-Version: 2.1
Name: openvisuspy
Version: 1.0.10
Summary: openvisuspy
Author: OpenVisus developers
Project-URL: Homepage, https://github.com/sci-visus/openvisuspy
Project-URL: Bug Tracker, https://github.com/sci-visus/openvisuspy
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# OpenViSUS Visualization project

The official OpenVisus C++ GitHub repository is [here](https://github.com/sci-visus/OpenVisus).


# Install openvisuspy

Create a virtual environment. This step is optional, but best to avoid conflicts:

- for windows users you can do `doskey python3=python $*` and `.venv/Scripts/activate.bat`

```
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip
```

Install python packages, technically only `numpy` is stricly needed, but to access cloud storage and show dashboards/notebooks, you need additional packages too.

```
python3 -m pip install numpy boto3 xmltodict colorcet requests scikit-image matplotlib bokeh panel itkwidgets[all] pyvista vtk jupyter
```

Next, nstall Openvisus packages. 


If you **do not need the OpenVisus viewer** (or if you are in Windows WSL):

```
python3 -m pip install --upgrade OpenVisusNoGui
python3 -m pip install --upgrade openvisuspy 
```

if **you do need the OpenVisus viewer**:

```
python3 -m pip install --upgrade OpenVisus
python3 -m OpenVisus configure 
python3 -m pip install --upgrade openvisuspy 
```

if you are in **debugging mode** you may want to reference your local packages:

```
python3 -m pip uninstall OpenVisusNoGui
python3 -m pip uninstall OpenVisus
python3 -m pip uninstall openvisuspy 
export PYTHONPATH=./src;/projects/OpenVisus/build/RelWithDebInfo
```

# Examples

## Bokeh Dashboards 

```
python3 -m bokeh serve "examples/dashboards/run.py"  --dev --address localhost --args --single
python3 -m bokeh serve "examples/dashboards/run.py"  --dev --address localhost --args --multi
python3 -m bokeh serve "examples/dashboards/nasa.py" --dev --address localhost --args --single
```

Other misc examples:

```
python -m bokeh serve "examples/dashboards/run.py"  --dev --args --dataset  "https://atlantis.sci.utah.edu/mod_visus?dataset=david_subsampled&cached=1" --palette Greys256    --palette-range "[0, 255]"
python -m bokeh serve "examples/dashboards/run.py"  --dev --args --dataset  "https://atlantis.sci.utah.edu/mod_visus?dataset=2kbit1&cached=1"           --palette Greys256    --palette-range "[0, 255]"
python -m bokeh serve "examples/dashboards/run.py"  --dev --args --dataset  "https://atlantis.sci.utah.edu/mod_visus?dataset=chess-zip&cached=1"        --palette Viridis256  --palette-range "[-0.017141795, 0.012004322]" --num-views 3 

```

### Probes

CHESS:

```
set PYTHONPATH=.\src;c:\projects\OpenVisus\build\RelWithDebInfo
python  -m bokeh serve examples/dashboards/run.py --args  --dataset "http://atlantis.sci.utah.edu/mod_visus?dataset=block_raw&cached=1" --palette "colorcet.coolwarm" --palette-range "[ 8644., 65530.//4]" --probes --show-options "['palette','field','offset','direction']"
```

Foam, Multiple timesteps, (TODO: range)):

```
python  -m bokeh serve examples/dashboards/run.py --args  --dataset "http://atlantis.sci.utah.edu/mod_visus?dataset=foam-2022-01&cached=1" --palette "colorcet.coolwarm" --palette-range "[ 8644., 65530.//4]" --probes --show-options "['palette','field','offset','direction']"
```


## Panel Dashboards 

```
python -m panel serve "examples/dashboards/run.py"  --dev --address localhost --args --single
python -m panel serve "examples/dashboards/run.py"  --dev --address localhost --args --multi
python -m panel serve "examples/dashboards/nasa.py" --dev --address localhost --args --single
```

## Jupyter Notebooks 

```
python3 -m jupyter notebook ./examples/notebooks 
```
