Skip to content

Commit

Permalink
docs: update installation instructions (now available on `conda-forge…
Browse files Browse the repository at this point in the history
…`) and update package dependencies (especially `makedocs-material`)
  • Loading branch information
mtrocadomoreira committed Nov 13, 2024
1 parent 7ce3ba0 commit e2c93ce
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 2 additions & 6 deletions docs/docs/user-guide/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ Ozzy is a Python package. We recommend installing ozzy in its own virtual enviro

## with conda <small>(recommended)</small>

!!! 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).
Expand All @@ -23,15 +19,15 @@ 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

After you have activated a new virtual environment, run:

```bash
python3 -m pip install ozzy
python3 -m pip install ozzy-pic
```


Expand Down
2 changes: 1 addition & 1 deletion templates/.changes.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)

}}
Expand Down

0 comments on commit e2c93ce

Please sign in to comment.