Skip to content

Commit

Permalink
updated installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
niksirbi committed Jan 23, 2024
1 parent 53d18d7 commit 1f99e10
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
7 changes: 2 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,13 @@ or [mamba](mamba:) to create a
development environment for movement. In the following we assume you have
`conda` installed, but the same commands will also work with `mamba`/`micromamba`.

First, create and activate a `conda` environment with some pre-requisites:
First, create and activate a `conda` environment:

```sh
conda create -n movement-dev -c conda-forge python=3.10 pytables
conda create -n movement-dev python=3.10
conda activate movement-dev
```

The above method ensures that you will get packages that often can't be
installed via `pip`, including [hdf5](https://www.hdfgroup.org/solutions/hdf5/).

To install movement for development, clone the GitHub repository,
and then run from inside the repository:

Expand Down
9 changes: 6 additions & 3 deletions docs/source/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

## Installation

:::{admonition} Use a conda environment
:class: note
We recommend you install movement inside a [conda](conda:)
or [mamba](mamba:) environment.
or [mamba](mamba:) environment, to avoid dependency conflicts with other packages.
In the following we assume you have `conda` installed,
but the same commands will also work with `mamba`/`micromamba`.

Expand All @@ -12,11 +14,12 @@ First, create and activate an environment.
You can call your environment whatever you like, we've used "movement-env".

```sh
conda create -n movement-env -c conda-forge python=3.10 pytables
conda create -n movement-env python=3.10
conda activate movement-env
```

Next install the `movement` package:
Then install the `movement` package as described below.
:::

::::{tab-set}

Expand Down

0 comments on commit 1f99e10

Please sign in to comment.