Skip to content

Commit

Permalink
Update installation doc page (#1389)
Browse files Browse the repository at this point in the history
* update installation page, convert from rst to md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add hyperlink on contributing.md

* remove horizontal lines

* fix small typos

* specify python 3.12

Co-authored-by: Caesar Tuguinay <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Caesar Tuguinay <[email protected]>
  • Loading branch information
3 people authored Sep 10, 2024
1 parent 3f103db commit 9345b78
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 39 deletions.
1 change: 1 addition & 0 deletions docs/source/contributing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(contributing)=
# Contributing to echopype


Expand Down
37 changes: 37 additions & 0 deletions docs/source/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Installation and examples

## Installation

Echopype is available and tested for Python 3.9-3.11. The latest release can be installed through conda (or mamba, see below) via the [conda-forge channel](https://anaconda.org/conda-forge/echopype):
```shell
# Install via conda-forge
$ conda install -c conda-forge echopype
```

It is available via [PyPI](https://pypi.org/project/echopype):
```shell
# Install via pip
$ pip install echopype
```

:::{note}
We are working on adding support for Python 3.12 soon!
:::

:::{attention}
It's common to encounter the situation that installing packages using Conda is slow or fails,
because Conda is unable to resolve dependencies.
We suggest using Mamba to get around this.
See [Mamba's documentation](https://mamba.readthedocs.io/en/latest/) for installation and usage.
One can replace `conda` with `mamba` in the above commands when creating the environment and installing additional packages.
:::

Previous releases are also available on conda and PyPI.

For instructions on installing a development version of echopype,
see the [](contributing) page.


## Example notebooks

The [echopype-examples](https://github.com/OSOceanAcoustics/echopype-examples) repository contains multiple Jupyter notebook examples illustrating the Echopype workflow. See the [rendered pages](https://echopype-examples.readthedocs.io/) before trying them out!
39 changes: 0 additions & 39 deletions docs/source/installation.rst

This file was deleted.

0 comments on commit 9345b78

Please sign in to comment.