Skip to content

Commit

Permalink
docs: Add conda-forge install instructions
Browse files Browse the repository at this point in the history
* Add install instructions from conda-forge for pixi and conda.
   - c.f. https://github.com/conda-forge/equinox-feedstock
* Update listed min dependencies to Python 3.10 and JAX v0.4.38.
  • Loading branch information
matthewfeickert committed Jan 7, 2025
1 parent 90626ee commit bbdc3f3
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,27 @@ _Coming from [Flax](https://github.com/google/flax) or [Haiku](https://github.co

## Installation

Requires Python 3.10+ and JAX 0.4.38+.

### From [PyPI](https://pypi.org/project/equinox/)

```bash
python -m pip install equinox
```

### From [conda-forge](https://github.com/conda-forge/equinox-feedstock)

To install and add to a project with [`pixi`](https://pixi.sh/)

```bash
pip install equinox
pixi add equinox
```

Requires Python 3.9+ and JAX 0.4.13+.
and to install into a particular conda environment with [`conda`](https://docs.conda.io/projects/conda/)

```bash
conda install --channel conda-forge equinox
```

## Documentation

Expand Down
20 changes: 18 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,27 @@ _Coming from [Flax](https://github.com/google/flax) or [Haiku](https://github.co

## Installation

Requires Python 3.10+ and JAX 0.4.38+.

### From [PyPI](https://pypi.org/project/equinox/)

```bash
python -m pip install equinox
```

### From [conda-forge](https://github.com/conda-forge/equinox-feedstock)

To install and add to a project with [`pixi`](https://pixi.sh/)

```bash
pip install equinox
pixi add equinox
```

Requires Python 3.9+ and JAX 0.4.13+.
and to install into a particular conda environment with [`conda`](https://docs.conda.io/projects/conda/)

```bash
conda install --channel conda-forge equinox
```

## Quick example

Expand Down

0 comments on commit bbdc3f3

Please sign in to comment.