Skip to content

Commit

Permalink
Move installation instructions to GitHub landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
sriharisundar committed Jan 6, 2025
1 parent dccf8d7 commit 03e43b1
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 50 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,37 @@ The Probabilistic Resource Adequacy Suite (PRAS) is a collection of tools for
bulk power system resource adequacy analysis and capacity credit calculation.
The most recent documentation report (for version 0.6) is available
[here](https://www.nrel.gov/docs/fy21osti/79698.pdf).

# Installation

PRAS is written in the [Julia](https://julialang.org/) numerical programming
language. If you haven't already, your first step should be to install Julia.
Instructions are available at
[julialang.org/downloads](https://julialang.org/downloads/).

Once you have Julia installed, PRAS can be installed from the Julia [General registry](https://pkgdocs.julialang.org/v1/registries/) which is installed by default if you have no other registries installed.

From the main Julia prompt, type `]` to enter the package management REPL.
The prompt should change from `julia>` to something like `(v1.10) pkg>`
(your version number may be slightly different).
Type (or paste) the following (minus the `pkg>` prompt)
```
pkg> add PRAS
```

This will automatically install the PRAS Julia module and all of its
related dependencies. At this point you can hit Backspace to switch back to the
main `julia>` prompt.

With PRAS installed, you can load it into Julia as follows:

```Julia
using PRAS
```

This will make the core PRAS functions (most importantly, the `SystemModel`
and `assess` functions) available for use in your Julia script or
interactive REPL session.

The [Getting Started](docs/getting-started) document provides more information
on using PRAS.
3 changes: 1 addition & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ assessment, including simulation of energy-limited resources such as storage.
PRAS is developed and maintained at the US
[National Renewable Energy Laboratory](https://www.nrel.gov/) (NREL).

For help installing PRAS, see the [Installation](./installation) page. To get started using PRAS,
see the [Getting Started](./getting-started) page.
For help installing PRAS, see the [instructions in the PRAS GitHub page](https://github.com/NREL/PRAS). To get started using PRAS, see the [Getting Started](./getting-started) page.
48 changes: 0 additions & 48 deletions docs/installation.md

This file was deleted.

0 comments on commit 03e43b1

Please sign in to comment.