Skip to content

Commit

Permalink
small docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
cortner authored Feb 1, 2025
1 parent 6b95848 commit 3377c08
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
16 changes: 8 additions & 8 deletions docs/src/gettingstarted/pkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,22 @@ The package manager provides functionality to organize reproducable Julia projec
If you are a user rather than developer it should almost never be required for you to check out a package (or, `dev` it in the package manager). When developers make changes to - say - `ACEpotentials.jl` they will always immediately tag another version and then you can adjust your version bounds in your project to update as well as enforce which version to use. However a developer would frequently do this, and occasionally it might be required when iterating between a user and developer for testing. There are multiple ways to achieve this; the following is our recommended procedure:
Suppose for example that a development branch `co/dev` of `ACE1.jl` is needed in a project `project`. Then one should perform the following steps:
* Make sure `ACE1` has been added to `project/Project.toml`
* In a separate folder, `/path/to/` , clone `ACE1.jl`
Suppose for example that a development branch `co/dev` of `ACEpotentials.jl` is needed in a project `project`. Then one should perform the following steps:
* Make sure `ACEpotentials` has been added to `project/Project.toml`
* In a separate folder, `/path/to/` , clone `ACEpotentials.jl`
```
cd /path/to
git clone [email protected]:ACEsuit/ACE1.jl.git
git clone [email protected]:ACEsuit/ACEpotentials.jl.git
git checkout co/dev
```
so that the repo will now live in `/path/to/ACE1.jl`
so that the repo will now live in `/path/to/ACEpotentials.jl`
* Go to and activate `project`, then in a Julia REPL switch to the package manager `]` and execute
```
dev /path/to/ACE1.jl
dev /path/to/ACEpotentials.jl
```
This will replace the `ACE1` package in the Manifest with the version that lives in `/path/to/ACE1.jl`
This will replace the `ACEpotentials` package in the Manifest with the version that lives in `/path/to/ACEpotentials.jl`
Later on, when you want to go back to the standad Pkg versin control you can simply `free ACE1`.
Later on, when you want to go back to the standad Pkg versin control you can simply `free ACEpotentials`.
#### Further Notes
Expand Down
2 changes: 1 addition & 1 deletion docs/src/gettingstarted/saving-and-loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
!!! warning
Saving and loading potentials is currently only supported for the
a workflow that uses JSON / dictionaries to specify models. For anything
"too creative" the user is responsible for ensuring reproducability.
more "creative" the user is responsible for ensuring reproducability.

### General Principles

Expand Down
3 changes: 2 additions & 1 deletion docs/src/tutorials/basic_julia_workflow.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ using ACEpotentials
# We need a dataset `TiAl_tutorial.xyz` for this tutorial. Normally we would get the path to a datset and then use `read_extxyz` to load in the training set.
# ```julia
# # (don't execute this block)
# using ExtXYZ
# data_file = "path/to/TiAl_tutorial.xyz"
# data = read_extxyz(data_file)
# data = ExtXYZ.load(data_file)
# ```
# For convenience we provide this dataset as a [Julia artifact](https://docs.julialang.org/en/v1/stdlib/Artifacts/) and make it accessible via `ACEpotentials.example_dataset`. We keep only a small subset of the structures for training and testing to keep the regression problem small.

Expand Down

0 comments on commit 3377c08

Please sign in to comment.