semvec/pypi-packages huggingface dataset:
sphinx-press-theme 0.9.1
A Sphinx-doc theme based on Vuepress
License: MIT
Keywords: sphinx doc theme vue.js

<!--- ## LOOKING FOR PROJECT MAINTAINERS

Unfortunately I (the author) do not have time to maintain this project.

If you are interested just ask me and I will provide admin rights on PyPI and commit access to this repo. --->

# sphinx_press_theme


[![PyPI](https://img.shields.io/pypi/v/sphinx_press_theme.svg)](https://pypi.python.org/pypi/sphinx_press_theme)


A modern responsive theme for python's [Sphinx](http://www.sphinx-doc.org) documentation generator.

See it in action on Press Theme own [website](https://schettino72.github.io/sphinx_press_site/)


This theme is based on [VuePress](https://vuepress.vuejs.org/).
It uses [Vue.js](https://vuejs.org/) & [Stylus](http://stylus-lang.com/) managed by
[vite](http://vitejs.dev/).



**Press** theme is still in **BETA**.
Contributions are welcome.

## Install

First install the theme:

```
$ pip install sphinx_press_theme
```

Sphinx version compatibility

|Sphinx |Press Theme|
|-------|-----------|
|7.X    | latest    |
|4.X    | 0.8.0     |
|3.X    | 0.6.1     |
|2.X    | 0.5.1     |


## Usage

On Sphinx project's ``conf.py``: set the theme name to ``press``.

```
html_theme = "press"
```

See details on [configuration](https://schettino72.github.io/sphinx_press_site/configuration.html).


## Development

First build web assets:

```
cd ui
npm install
npm run build
```

Sphinx theme has a soft link to built assets...
Install theme locally with `pip install -e .`.

`docs` folder contains theme's own documentantion.

```
cd docs
make clean html
```

## Release

Set version on:

- `setup.py`
- `sphinx_press_theme/__init__.py`
- `sphinx_press_theme/theme.conf`
- `docs/source/conf.py`
- `ui/package.json`


## Website

To update website:

```
cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all
```
echoshader 0.1.0
Open Source Python package for building ocean sonar data visualizations.
License: MIT
Requires Python: >=3.8

# Welcome to echoshader

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/OSOceanAcoustics/echoshader/HEAD)

Open Source Python package for building ocean sonar data visualizations based on the HoloViz suite of Python tools.

## What are ocean sonar systems?

Ocean sonar systems, such as echosounders, are the [workhorse to study life in the ocean](https://storymaps.arcgis.com/stories/e245977def474bdba60952f30576908f). They provide continuous observations of fish and zooplankton by transmitting sounds and analyzing the echoes bounced off these animals, just like how medical ultrasound images the interior of human body. In recent years these systems are widely deployed on ships, autonomous vehicles, or moorings, bringing in a lot of data that allow scientists to study the change of the marine ecosystem.

## What is echoshader?

Echoshader aims to enhance the capability to interactively visualize large volumes of ocean sonar data to accelerate the data exploration and discovery process. The project will go hand-in-hand with ongoing development of the [echopype](https://echopype.readthedocs.io/en/stable/) package that handles the standardization, pre-processing, and organization of these data.

By providing an accessible and customizable platform for echo data visualization, the project can accelerate advancements in oceanographic research for the benefit of conservation and sustainable resource management like fishery.

## Installation

First it is best to create a new environment:

```bash
mamba create -c conda-forge -n echoshader --yes python=3.10

mamba activate echoshader
```

To install from PyPi:

```bash
pip install echoshader
```

The latest branch can be installed via the following:

```bash
pip install git+https://github.com/OSOceanAcoustics/echoshader.git
```

To run in development mode, fork and clone the repository at [Echoshader](https://github.com/OSOceanAcoustics/echoshader):

```bash
mamba create -c conda-forge -n echoshader-dev --yes python=3.10 --file requirements.txt --file requirements-dev.txt
pip install -e
```

We recommend use [mamba](https://mamba.readthedocs.io/en/latest/user_guide/mamba.html) to manage conda's environments, which is a re-implementation of conda offering additional benefits.

## Creating a development environment

This section is intended for those who are actively developing this package.

```bash
mamba create -n echoshader-dev -c pyviz -c conda-forge echopype hvplot geoviews pyvista ipykernel
```

Note: Users may already have `echopype` installed, but it should be at a version greater than or equal to `0.7.1`.

To link this environment with a Jupyter kernel:

```bash
conda activate echoshader-dev
python -m ipykernel install --user --name echoshader-dev --display-name "echoshader-dev"
```