From 03e43b1f6060041df50e192aded3c12370741a2f Mon Sep 17 00:00:00 2001 From: Srihari Sundar Date: Mon, 6 Jan 2025 16:34:11 -0700 Subject: [PATCH] Move installation instructions to GitHub landing page --- README.md | 34 +++++++++++++++++++++++++++++++ docs/index.md | 3 +-- docs/installation.md | 48 -------------------------------------------- 3 files changed, 35 insertions(+), 50 deletions(-) delete mode 100644 docs/installation.md diff --git a/README.md b/README.md index 94826901..d0a08492 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 69c5d566..d320b2c1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. diff --git a/docs/installation.md b/docs/installation.md deleted file mode 100644 index 316a3983..00000000 --- a/docs/installation.md +++ /dev/null @@ -1,48 +0,0 @@ -# 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 in two easy steps! - -First, add NREL's Julia package registry to your Julia installation. -From the main Julia prompt, type `]` to enter the package management REPL. -The prompt should change from `julia>` to something like `(v1.3) pkg>` -(your version number may be slightly different). -Type (or paste) the following (minus the `pkg>` prompt) - note that the first -line is only necessary if your Julia installation is brand new and you've -never installed a package before: - -``` -pkg> registry add https://github.com/JuliaRegistries/General.git -pkg> registry add https://github.com/NREL/JuliaRegistry.git -``` - -Adding the NREL registry will allow you to easily add NREL-developed -packages (like PRAS) that aren't yet available in the main Julia registry. - -Now you can install the PRAS package. In the package REPL (`(v1.1) pkg>`), -simply type or paste: - -``` -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. - -# Usage - -With PRAS installed, you can load it into Julia as follows: - -`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](./getting-started) page provides more information -on using PRAS.