Skip to content

installation.md

Latest commit

 

History

History
38 lines (27 loc) · 1.65 KB

installation.md

File metadata and controls

38 lines (27 loc) · 1.65 KB

Prerequisites

You will need to have Julia (v1.7 or newer) installed. The latest release and installation instruction for Julia are available here here.

!!! warning If you are running Julia for the first time, there is a chance that the General Registrity is not added to you installation. To install the General Registry run the following code from within a Julia REPL. julia using Pkg Pkg.Registry.add("General")

Installation

The package ACEfriction and some required dependencies can be downloaded from ACEregistry. To add this registry and install ACEfriction execute the following steps from within a Julia REPL.

  1. Add the ACEregistry registry:

    using Pkg
Pkg.Registry.add(RegistrySpec(url="https://github.com/ACEsuit/ACEregistry"))

  2. Install ACEfriction:

    Pkg.add("ACEfriction")

Done! Now you can use the functionality of ACEfriction in your project by running using ACEfriction.

!!! note It is recommended to install ACEfriction within a dedicated julia environment, where approriate version bounds can be set within the Project.toml file, and versions of dependencies are tracked in a Manifest.toml file.

To create a new project, simply create a new directory, navigate to that directory and run
```julia
Pkg.activate(".")
```
Then, execute sthe teps 1. and 2. from within the project directory.