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 conda-forge badge and update docs #177

Merged
merged 2 commits into from
Feb 16, 2024
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
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
- ✅
- ✅
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/installation_juwels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
9 changes: 8 additions & 1 deletion doc/source/user_guide/installation_local.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/installation_maxwell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/installation_perlmutter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading