diff --git a/.gitignore b/.gitignore index c612bda..3febc83 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,5 @@ build instances/**/*.json instances/_source local -docs notebooks TODO.md diff --git a/mkdocs.yml b/mkdocs.yml index 444e2ae..b54e6c2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,8 @@ site_name: UnitCommitment.jl theme: cinder copyright: "Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved." -repo_url: https://github.com/ -edit_uri: edit/master/src/docs/ +repo_url: https://github.com/ANL-CEEESA/unitcommitment.jl +edit_uri: edit/dev/src/docs/ nav: - Home: index.md - Usage: usage.md diff --git a/src/docs/index.md b/src/docs/index.md index d34ad8c..a27cd18 100644 --- a/src/docs/index.md +++ b/src/docs/index.md @@ -14,6 +14,10 @@ * [Usage](usage.md) * [Data Format](format.md) +### Source code + +* [https://github.com/ANL-CEEESA/unitcommitment.jl](https://github.com/ANL-CEEESA/unitcommitment.jl) + ### Authors * **Alinson Santos Xavier** (Argonne National Laboratory) * **Feng Qiu** (Argonne National Laboratory) diff --git a/src/docs/usage.md b/src/docs/usage.md new file mode 100644 index 0000000..f452694 --- /dev/null +++ b/src/docs/usage.md @@ -0,0 +1,18 @@ +# Installation Guide + +This package was tested and developed with [Julia 1.5](https://julialang.org/). To install Julia, please follow the [installation guide on their website](https://julialang.org/downloads/platform.html). To install `UnitCommitment.jl`, run the Julia interpreter, type `]` to open the package manager, then type: + +```text +pkg> add https://github.com/ANL-CEEESA/UnitCommitment.jl.git +``` + +To test that the package has been correctly installed, run: + +```text +pkg> test UnitCommitment +``` + +If all tests pass, the package should now be ready to be used by any Julia script on the machine. To try it out in the julia interpreter hit `backspace` to return to the regular interpreter, and type the following command: +```julia +using UnitCommitment +```