diff --git a/README.md b/README.md index b387a9e..b1fc52a 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,12 @@ Ozzy's philosophy is to make the analysis of simulation data originating from mu A detailed guide is available in the ["Installation" page of the documentation](https://mtrocadomoreira.github.io/ozzy/user-guide/installation/). -We highly recommend installing ozzy in its own virtual environment. +We highly recommend installing ozzy [in its own virtual environment](https://mtrocadomoreira.github.io/ozzy/user-guide/installation/virtual-environments/). ### conda (recommended) ```bash -conda install ozzy-pic +conda install --channel=conda-forge ozzy-pic ``` ### pip diff --git a/docs/docs/user-guide/installation/index.md b/docs/docs/user-guide/installation/index.md index f0a1270..057287f 100644 --- a/docs/docs/user-guide/installation/index.md +++ b/docs/docs/user-guide/installation/index.md @@ -11,10 +11,6 @@ Ozzy is a Python package. We recommend installing ozzy in its own virtual enviro ## with conda (recommended) -!!! warning - - Ozzy is awaiting approval to be uploaded to [`conda-forge`](https://conda-forge.org/), but should be available to install via `conda`/`mamba` soon. - !!! note "Note about mamba" Feel free to replace the `conda` command with `mamba`. [Mamba](https://mamba.readthedocs.io/en/latest/index.html) is a faster version of the conda package manager, and is installed by default with [miniforge](https://github.com/conda-forge/miniforge). @@ -23,7 +19,7 @@ Ozzy is a Python package. We recommend installing ozzy in its own virtual enviro After you have activated a new virtual environment, run: ```bash -conda install ozzy +conda install --channel=conda-forge ozzy-pic ``` ## with pip @@ -31,7 +27,7 @@ conda install ozzy After you have activated a new virtual environment, run: ```bash -python3 -m pip install ozzy +python3 -m pip install ozzy-pic ``` diff --git a/templates/.changes.md.j2 b/templates/.changes.md.j2 index 9562970..0804f47 100644 --- a/templates/.changes.md.j2 +++ b/templates/.changes.md.j2 @@ -8,7 +8,7 @@ "\n* [`%s`](%s): %s\n" | format( commit.short_hash, commit.hexsha | commit_hash_url, - commit.descriptions[0] | capitalize, + commit.descriptions[0] | capitalize | safe, ) }}