diff --git a/README.md b/README.md index 66c13ea2..d55a239f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![PyPI](https://img.shields.io/pypi/v/optimas)](https://pypi.org/project/optimas/) +[![Conda Version](https://img.shields.io/conda/vn/conda-forge/optimas.svg)](https://anaconda.org/conda-forge/optimas) [![tests badge](https://github.com/optimas-org/optimas/actions/workflows/unix.yml/badge.svg)](https://github.com/optimas-org/optimas/actions) [![Documentation Status](https://readthedocs.org/projects/optimas/badge/?version=latest)](https://optimas.readthedocs.io/en/latest/?badge=latest) [![DOI](https://zenodo.org/badge/287560975.svg)](https://zenodo.org/badge/latestdoi/287560975) @@ -39,11 +40,15 @@ Optimas is a Python library designed for highly scalable optimization, from lapt ## Installation -You can install Optimas from PyPI: +You can install Optimas from PyPI (recommended): ```sh pip install optimas ``` -Or directly from GitHub: +from conda-forge: +```sh +conda install optimas --channel conda-forge +``` +or directly from GitHub: ```sh pip install git+https://github.com/optimas-org/optimas.git ``` diff --git a/doc/source/user_guide/dependencies.rst b/doc/source/user_guide/dependencies.rst index 9286a3bf..636f75be 100644 --- a/doc/source/user_guide/dependencies.rst +++ b/doc/source/user_guide/dependencies.rst @@ -22,7 +22,7 @@ See table below for a summary. * - Generator - ``pip install optimas`` - - ``pip install optimas[all]`` + - ``pip install 'optimas[all]'`` * - :class:`~optimas.generators.LineSamplingGenerator` - ✅ - ✅ diff --git a/doc/source/user_guide/installation_juwels.rst b/doc/source/user_guide/installation_juwels.rst index 2cc70303..33764cab 100644 --- a/doc/source/user_guide/installation_juwels.rst +++ b/doc/source/user_guide/installation_juwels.rst @@ -47,7 +47,7 @@ Install ``optimas`` with all dependencies if you plan to do Bayesian optimizatio .. code:: - pip install optimas[all] + pip install 'optimas[all]' Installing FBPIC and Wake-T (optional) diff --git a/doc/source/user_guide/installation_local.rst b/doc/source/user_guide/installation_local.rst index 9483c748..8ef70c1a 100644 --- a/doc/source/user_guide/installation_local.rst +++ b/doc/source/user_guide/installation_local.rst @@ -45,11 +45,18 @@ Installing with **all** dependencies: .. code:: - pip install optimas[all] + pip install 'optimas[all]' Use this option if you plan to do Bayesian optimization (see :ref:`dependencies` for more details). +Install from conda-forge +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: + + conda install optimas --channel conda-forge + Install from GitHub ~~~~~~~~~~~~~~~~~~~ This will install the latest development version with all dependencies. diff --git a/doc/source/user_guide/installation_maxwell.rst b/doc/source/user_guide/installation_maxwell.rst index c8b32df3..7554e12e 100644 --- a/doc/source/user_guide/installation_maxwell.rst +++ b/doc/source/user_guide/installation_maxwell.rst @@ -56,7 +56,7 @@ Install ``optimas`` with all dependencies if you plan to do Bayesian optimizatio .. code:: - pip install optimas[all] + pip install 'optimas[all]' Installing FBPIC and Wake-T (optional) diff --git a/doc/source/user_guide/installation_perlmutter.rst b/doc/source/user_guide/installation_perlmutter.rst index d00b944f..a9871074 100644 --- a/doc/source/user_guide/installation_perlmutter.rst +++ b/doc/source/user_guide/installation_perlmutter.rst @@ -17,7 +17,7 @@ environment, in which to install *optimas*. python3 -m venv $HOME/sw/perlmutter/gpu/venvs/optimas source $HOME/sw/perlmutter/gpu/venvs/optimas/bin/activate - pip install optimas[all] + pip install 'optimas[all]' Running an optimas job ~~~~~~~~~~~~~~~~~~~~~~