diff --git a/README.md b/README.md index 6a67fdaf..c48dd9f5 100644 --- a/README.md +++ b/README.md @@ -63,12 +63,12 @@ To install all MLIPs currently compatible with MACE, run: python3 -m pip install janus-core[all] ``` -Individual `extras` are listed in [Getting Started](https://stfc.github.io/janus-core/getting_started/getting_started.html#installation), as well as in [pyproject.toml](pyproject.toml) under `[project.optional-dependencies]`. +Individual `extras` are listed in [Getting Started](https://stfc.github.io/janus-core/user_guide/get_started.html#installation), as well as in [pyproject.toml](pyproject.toml) under `[project.optional-dependencies]`. ### Further help -Please see [Getting Started](https://stfc.github.io/janus-core/getting_started/getting_started.html), +Please see [Getting Started](https://stfc.github.io/janus-core/user_guide/get_started.html), as well as guides for janus-core's [Python](https://stfc.github.io/janus-core/user_guide/python.html) and [command line](https://stfc.github.io/janus-core/user_guide/command_line.html) interfaces, for additional information, or [open an issue](https://github.com/stfc/janus-core/issues/new) if something doesn't seem right. @@ -341,7 +341,7 @@ We recommend installing uv for dependency management when developing for `janus- ```shell git clone https://github.com/stfc/janus-core cd janus-core -uv sync --extras all # Create a virtual environment and install dependencies +uv sync --extra all # Create a virtual environment and install dependencies source .venv/bin/activate pre-commit install # Install pre-commit hooks pytest -v # Discover and run all tests diff --git a/docs/source/developer_guide/get_started.rst b/docs/source/developer_guide/get_started.rst index 6d64649e..bd7d7b79 100644 --- a/docs/source/developer_guide/get_started.rst +++ b/docs/source/developer_guide/get_started.rst @@ -31,7 +31,7 @@ Extras, such as optional MLIPs, can also be installed by running:: or to install all MLIPs that do not depend on ``dgl``:: - uv sync -p 3.12 --extras all + uv sync -p 3.12 --extra all Using uv