Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mamba recommendation into docs #1084

Merged
merged 3 commits into from
Jul 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,20 @@ then set the source repository as the ``upstream`` git remote:
cd echopype
git remote add upstream https://github.com/OSOceanAcoustics/echopype.git

Create a `conda <https://docs.conda.io>`_ environment for echopype development
(replace the Python version with your preferred version):
Below shows the steps to create a `conda <https://docs.conda.io>`_
environment for echopype development
(replace the Python version with your preferred version).

.. attention::
We recommend using the ``libmamba`` solver instead of the classic solver,
since the ``conda create`` and ``conda install`` step could take very long or fail.
See instructions `here <https://conda.github.io/conda-libmamba-solver/getting-started/>`_
for installation and usage.


.. code-block:: bash

# create conda environment using the supplied requirements files
# create a conda environment using the supplied requirements files
# note the last one docs/requirements.txt is only required for building docs
conda create -c conda-forge -n echopype --yes python=3.9 --file requirements.txt --file requirements-dev.txt --file docs/requirements.txt

Expand All @@ -93,13 +101,6 @@ Create a `conda <https://docs.conda.io>`_ environment for echopype development
# the command will install all the dependencies along with plotting dependencies.
pip install -e ".[plot]"

.. note::

Try using `mamba <https://mamba.readthedocs.io>`_ instead of ``conda``
if the ``conda create`` and ``conda install`` step fail or take too long.
``Mamba`` is a drop-in replacement for conda environment creation and package
installation that is typically faster than conda.

See the :doc:`installation` page to simply install the latest echopype release from conda or PyPI.


Expand Down
5 changes: 5 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ or through conda from the `conda-forge Anaconda channel <https://anaconda.org/co

$ conda install -c conda-forge echopype

.. attention::
We recommend using the ``libmamba`` solver instead of the classic solver.
See instructions `here <https://conda.github.io/conda-libmamba-solver/getting-started/>`_
for installation and usage.

Previous releases are also available on PyPI and conda.

For instructions on installing a development version of echopype,
Expand Down
Loading