Skip to content

Commit 313c7f5

Browse files
Fix install extras typo and getting started links (#629)
1 parent a4fc9c0 commit 313c7f5

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ To install all MLIPs currently compatible with MACE, run:
6363
python3 -m pip install janus-core[all]
6464
```
6565

66-
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]`.
66+
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]`.
6767

6868

6969
### Further help
7070

71-
Please see [Getting Started](https://stfc.github.io/janus-core/getting_started/getting_started.html),
71+
Please see [Getting Started](https://stfc.github.io/janus-core/user_guide/get_started.html),
7272
as well as guides for janus-core's [Python](https://stfc.github.io/janus-core/user_guide/python.html)
7373
and [command line](https://stfc.github.io/janus-core/user_guide/command_line.html) interfaces,
7474
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-
341341
```shell
342342
git clone https://github.com/stfc/janus-core
343343
cd janus-core
344-
uv sync --extras all # Create a virtual environment and install dependencies
344+
uv sync --extra all # Create a virtual environment and install dependencies
345345
source .venv/bin/activate
346346
pre-commit install # Install pre-commit hooks
347347
pytest -v # Discover and run all tests

docs/source/developer_guide/get_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Extras, such as optional MLIPs, can also be installed by running::
3131

3232
or to install all MLIPs that do not depend on ``dgl``::
3333

34-
uv sync -p 3.12 --extras all
34+
uv sync -p 3.12 --extra all
3535

3636

3737
Using uv

0 commit comments

Comments
 (0)