diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5115da1..4970783 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing Community driven development of this package is encouraged. To maintain code quality standards, please adhere to the following guidlines when contributing: - - To get started, sign the Contributor License Agreement. - - Please do your best to adhere to our [coding style guide](https://github.com/nrel/powersystems.jl/docs/src/style.md). + - To get started, sign the Contributor License Agreement. + - Please do your best to adhere to our [coding style guide](https://github.com/Sienna-Platform/PowerSystems.jl/blob/main/docs/src/style.md). - To submit code contributions, [fork](https://help.github.com/articles/fork-a-repo/) the repository, commit your changes, and [submit a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). diff --git a/README.md b/README.md index abf2908..234f6d0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # PowerGraphics -[![Main - CI](https://github.com/NREL-Sienna/PowerGraphics.jl/actions/workflows/main-tests.yml/badge.svg)](https://github.com/NREL-Sienna/PowerGraphics.jl/actions/workflows/main-tests.yml) -[![codecov](https://codecov.io/gh/NREL-Sienna/PowerGraphics.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/NREL-Sienna/PowerGraphics.jl) -[![Documentation Build](https://github.com/NREL-Sienna/PowerGraphics.jl/workflows/Documentation/badge.svg?)](https://nrel-sienna.github.io/PowerGraphics.jl/stable) -[](https://join.slack.com/t/nrel-sienna/shared_invite/zt-glam9vdu-o8A9TwZTZqqNTKHa7q3BpQ) +[![Main - CI](https://github.com/Sienna-Platform/PowerGraphics.jl/actions/workflows/main-tests.yml/badge.svg)](https://github.com/Sienna-Platform/PowerGraphics.jl/actions/workflows/main-tests.yml) +[![codecov](https://codecov.io/gh/Sienna-Platform/PowerGraphics.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/Sienna-Platform/PowerGraphics.jl) +[![Documentation Build](https://github.com/Sienna-Platform/PowerGraphics.jl/workflows/Documentation/badge.svg?)](https://sienna-platform.github.io/PowerGraphics.jl/stable) +[](https://join.slack.com/t/core-sienna/shared_invite/zt-glam9vdu-o8A9TwZTZqqNTKHa7q3BpQ) [![PowerGraphics.jl Downloads](https://img.shields.io/badge/dynamic/json?url=http%3A%2F%2Fjuliapkgstats.com%2Fapi%2Fv1%2Ftotal_downloads%2FPowerGraphics&query=total_requests&label=Downloads)](http://juliapkgstats.com/pkg/PowerGraphics) -PowerGraphics.jl is a Julia package for plotting results from [PowerSimulations.jl](https://github.com/NREL-Sienna/PowerSimulations.jl). +PowerGraphics.jl is a Julia package for plotting results from [PowerSimulations.jl](https://github.com/Sienna-Platform/PowerSimulations.jl). ## Installation @@ -17,7 +17,7 @@ julia> ] ## Usage -`PowerGraphics.jl` uses [PowerSystems.jl](https://github.com/NREL-Sienna/PowerSystems.jl) and [PowerSimulations.jl](https://github.com/NREL-Sienna/PowerSimulations.jl) to handle the data and execution power system simulations. +`PowerGraphics.jl` uses [PowerSystems.jl](https://github.com/Sienna-Platform/PowerSystems.jl) and [PowerSimulations.jl](https://github.com/Sienna-Platform/PowerSimulations.jl) to handle the data and execution power system simulations. ```julia using PowerGraphics @@ -51,9 +51,9 @@ plot_fuel(res) ## Development -Contributions to the development and enhancement of PowerGraphics is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/PowerGraphics.jl/blob/main/CONTRIBUTING.md) for code contribution guidelines. +Contributions to the development and enhancement of PowerGraphics is welcome. Please see [CONTRIBUTING.md](https://github.com/Sienna-Platform/PowerGraphics.jl/blob/main/CONTRIBUTING.md) for code contribution guidelines. ## License -PowerGraphics is released under a BSD [license](https://github.com/nrel-sienna/PowerGraphics.jl/blob/main/LICENSE). PowerGraphics has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) +PowerGraphics is released under a BSD [license](https://github.com/Sienna-Platform/PowerGraphics.jl/blob/main/LICENSE). PowerGraphics has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory ([NREL](https://www.nrel.gov/)) diff --git a/docs/make.jl b/docs/make.jl index f55d6db..bca0cb2 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -5,9 +5,9 @@ using DocumenterInterLinks links = InterLinks( "Plots" => "https://docs.juliaplots.org/stable/", - "PowerSystems" => "https://nrel-sienna.github.io/PowerSystems.jl/stable/", - "PowerSimulations" => "https://nrel-sienna.github.io/PowerSimulations.jl/stable/", - "InfrastructureSystems" => "https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/", + "PowerSystems" => "https://sienna-platform.github.io/PowerSystems.jl/stable/", + "PowerSimulations" => "https://sienna-platform.github.io/PowerSimulations.jl/stable/", + "InfrastructureSystems" => "https://sienna-platform.github.io/InfrastructureSystems.jl/stable/", "DataFrames" => "https://dataframes.juliadata.org/stable/", ) @@ -40,7 +40,7 @@ makedocs(; ) Documenter.deploydocs(; - repo = "github.com/NREL-Sienna/PowerGraphics.jl.git", + repo = "github.com/Sienna-Platform/PowerGraphics.jl.git", target = "build", branch = "gh-pages", devbranch = "main", diff --git a/docs/src/index.md b/docs/src/index.md index 9b7c57d..b40f6fd 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -7,20 +7,20 @@ CurrentModule = PowerGraphics ## Overview `PowerGraphics.jl` is a [`Julia`](http://www.julialang.org) package for plotting results -from [PowerSimulations.jl](https://nrel-sienna.github.io/PowerSimulations.jl/latest/). +from [PowerSimulations.jl](https://sienna-platform.github.io/PowerSimulations.jl/latest/). ## About Sienna `PowerGraphics.jl` is part of the National Renewable Energy Laboratory's -[Sienna ecosystem](https://nrel-sienna.github.io/Sienna/), an open source framework for +[Sienna ecosystem](https://sienna-platform.github.io/Sienna/), an open source framework for power system modeling, simulation, and optimization. The Sienna ecosystem can be -[found on GitHub](https://github.com/NREL-Sienna/Sienna). It contains three applications: +[found on GitHub](https://github.com/Sienna-Platform/Sienna). It contains three applications: - - [Sienna\Data](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_data.html) enables + - [Sienna\Data](https://sienna-platform.github.io/Sienna/pages/applications/sienna_data.html) enables efficient data input, analysis, and transformation - - [Sienna\Ops](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_ops.html) enables + - [Sienna\Ops](https://sienna-platform.github.io/Sienna/pages/applications/sienna_ops.html) enables enables system scheduling simulations by formulating and solving optimization problems - - [Sienna\Dyn](https://nrel-sienna.github.io/Sienna/pages/applications/sienna_dyn.html) enables + - [Sienna\Dyn](https://sienna-platform.github.io/Sienna/pages/applications/sienna_dyn.html) enables system transient analysis including small signal stability and full system dynamic simulations @@ -29,5 +29,5 @@ programming language. ## Installation -See the [Sienna installation page](https://nrel-sienna.github.io/Sienna/SiennaDocs/docs/build/how-to/install/) +See the [Sienna installation page](https://sienna-platform.github.io/Sienna/SiennaDocs/docs/build/how-to/install/) to install `PowerGraphics.jl` and other Sienna packages. diff --git a/docs/src/reference/developer_guidelines.md b/docs/src/reference/developer_guidelines.md index 59f02e3..e353b21 100644 --- a/docs/src/reference/developer_guidelines.md +++ b/docs/src/reference/developer_guidelines.md @@ -1,12 +1,12 @@ # Developer Guidelines In order to contribute to `PowerGraphics.jl` repository please read the following sections of -[`InfrastructureSystems.jl`](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/) and [`SiennaTemplate.jl`](https://github.com/NREL-Sienna/SiennaTemplate.jl) +[`InfrastructureSystems.jl`](https://sienna-platform.github.io/InfrastructureSystems.jl/stable/) and [`SiennaTemplate.jl`](https://github.com/Sienna-Platform/SiennaTemplate.jl) documentation in detail: - 1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/) - 2. [Documentation Best Practices](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/docs_best_practices/explanation/) - 3. [Contributing Guidelines](https://github.com/NREL-Sienna/SiennaTemplate.jl/blob/main/CONTRIBUTING.md) + 1. [Style Guide](https://sienna-platform.github.io/InfrastructureSystems.jl/stable/style/) + 2. [Documentation Best Practices](https://sienna-platform.github.io/InfrastructureSystems.jl/stable/docs_best_practices/explanation/) + 3. [Contributing Guidelines](https://github.com/Sienna-Platform/SiennaTemplate.jl/blob/main/CONTRIBUTING.md) Pull requests are always welcome to fix bugs or add additional modeling capabilities. diff --git a/docs/src/tutorials/examples.md b/docs/src/tutorials/examples.md index 619f8e2..57f0f09 100644 --- a/docs/src/tutorials/examples.md +++ b/docs/src/tutorials/examples.md @@ -1,3 +1,3 @@ # PowerGraphics.jl Examples -[Example of Bar and Stack Plots on SIIPExamples](https://nbviewer.jupyter.org/github/NREL-Sienna/SIIPExamples.jl/blob/notebook/3_PowerSimulations_examples/04_bar_stack_plots.ipynb) +[Example of Bar and Stack Plots on SIIPExamples](https://nbviewer.jupyter.org/github/Sienna-Platform/SIIPExamples.jl/blob/notebook/3_PowerSimulations_examples/04_bar_stack_plots.ipynb) diff --git a/src/call_plots.jl b/src/call_plots.jl index 94ceada..6c7399a 100644 --- a/src/call_plots.jl +++ b/src/call_plots.jl @@ -60,7 +60,7 @@ plot = plot_demand(res) - `nofill::Bool` : force empty area fill - `stair::Bool`: Make a stair plot instead of a stack plot - `filter_func::Function = `[`PowerSystems.get_available`](@extref PowerSystems InfrastructureSystems.get_available-Tuple{RenewableDispatch}): filter components included in plot -""" # ^ temporary workaround for https://github.com/NREL-Sienna/PowerSystems.jl/issues/1598 +""" # ^ temporary workaround for https://github.com/Sienna-Platform/PowerSystems.jl/issues/1598 function plot_demand(result::Union{IS.Results, PSY.System}; kwargs...) return plot_demand!(_empty_plot(), result; kwargs...) diff --git a/src/definitions.jl b/src/definitions.jl index d494f20..38242e6 100644 --- a/src/definitions.jl +++ b/src/definitions.jl @@ -26,7 +26,7 @@ end Loads color palette yaml from environment, the `DEFAULT_PALETTE_FILE`, or a given file. See -[`color-palette.yaml`](https://github.com/NREL-Sienna/PowerGraphics.jl/blob/main/report_templates/color-palette.yaml) +[`color-palette.yaml`](https://github.com/Sienna-Platform/PowerGraphics.jl/blob/main/report_templates/color-palette.yaml) for an example. # Arguments diff --git a/src/make_report.jl b/src/make_report.jl index 9c39b0a..9fa53e9 100644 --- a/src/make_report.jl +++ b/src/make_report.jl @@ -6,7 +6,7 @@ file based on the `report_design.jmd` (Julia markdown) file that it reads. An example template is available -[here](https://github.com/NREL-Sienna/PowerGraphics.jl/blob/main/report_templates/generic_report_template.jmd) +[here](https://github.com/Sienna-Platform/PowerGraphics.jl/blob/main/report_templates/generic_report_template.jmd) # Arguments - `results::IS.Results`: The results to be plotted