Skip to content

Update installation instructions #132

@sfmig

Description

@sfmig

Is your feature request related to a problem? Please describe.
We can install from pip now but the current instructions don't reflect it, so it would be nice to update them. It would be nice to follow movement's lead and add uv installation instructions too.

Describe the solution you'd like
Ideally, we would follow movement's layout and format as much as possible. Note that we don't publish ethology in conda yet, so we should only cover these two cases:

  • conda+pip installation
  • uv installation

We should update the "Update the package" section too.

Describe alternatives you've considered
\

Additional context
movement currently does not mention uv sync, which as far as I understand it would be equivalent to creating a virtual environment and running pip install -e .. If this is confirmed, it would be nice to add maybe an admonition/note to mention the uv sync command. The pip-like command will be easier to remember for people coming from pip/conda, but seems nice to also mention uv sync as it is less verbose.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions