Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Thanks for opening a PR to StorageSystemsSimulations.jl, please take note of the following when making a PR:

Check the [contributor guidelines](https://nrel-sienna.github.io/StorageSystemsSimulations.jl/stable/code_base_developer_guide/developer/)
Check the [contributor guidelines](https://sienna-platform.github.io/StorageSystemsSimulations.jl/stable/code_base_developer_guide/developer/)
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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, <a href="https://www.clahub.com/agreements/NREL-Sienna/StorageSystemsSimulations.jl">sign the Contributor License Agreement</a>.
- To get started, <a href="https://www.clahub.com/agreements/Sienna-Platform/StorageSystemsSimulations.jl">sign the Contributor License Agreement</a>.
- Please do your best to adhere to our [coding style guide](docs/src/developer/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/).
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# StorageSystemsSimulations.jl

[![Main - CI](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/actions/workflows/main-tests.yml/badge.svg)](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/actions/workflows/main-tests.yml)
[![codecov](https://codecov.io/gh/NREL-Sienna/StorageSystemsSimulations.jl/branch/main/graph/badge.svg?token=sML4kPw4Z9)](https://codecov.io/gh/NREL-Sienna/StorageSystemsSimulations.jl)
[![Documentation](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/workflows/Documentation/badge.svg)](https://nrel-sienna.github.io/StorageSystemsSimulations.jl/stable/)
[<img src="https://img.shields.io/badge/slack-@Sienna/PSY-sienna.svg?logo=slack">](https://join.slack.com/t/nrel-sienna/shared_invite/zt-glam9vdu-o8A9TwZTZqqNTKHa7q3BpQ)
[![Main - CI](https://github.com/Sienna-Platform/StorageSystemsSimulations.jl/actions/workflows/main-tests.yml/badge.svg)](https://github.com/Sienna-Platform/StorageSystemsSimulations.jl/actions/workflows/main-tests.yml)
[![codecov](https://codecov.io/gh/Sienna-Platform/StorageSystemsSimulations.jl/branch/main/graph/badge.svg?token=sML4kPw4Z9)](https://codecov.io/gh/Sienna-Platform/StorageSystemsSimulations.jl)
[![Documentation](https://github.com/Sienna-Platform/StorageSystemsSimulations.jl/workflows/Documentation/badge.svg)](https://sienna-platform.github.io/StorageSystemsSimulations.jl/stable/)
[<img src="https://img.shields.io/badge/slack-@Sienna/PSY-sienna.svg?logo=slack">](https://join.slack.com/t/core-sienna/shared_invite/zt-glam9vdu-o8A9TwZTZqqNTKHa7q3BpQ)


For information on using the package, see the [stable documentation](https://nrel-sienna.github.io/StorageSystemsSimulations.jl/stable/). Use the [in-development documentation](https://nrel-sienna.github.io/StorageSystemsSimulations.jl/dev/) for the version of the documentation which contains the unreleased features.
For information on using the package, see the [stable documentation](https://sienna-platform.github.io/StorageSystemsSimulations.jl/stable/). Use the [in-development documentation](https://sienna-platform.github.io/StorageSystemsSimulations.jl/dev/) for the version of the documentation which contains the unreleased features.

## Development

Contributions to the development and enhancement of StorageSystemsSimulations is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.
Contributions to the development and enhancement of StorageSystemsSimulations is welcome. Please see [CONTRIBUTING.md](https://github.com/Sienna-Platform/StorageSystemsSimulations.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.

## License

StorageSystemsSimulations is released under a BSD [license](https://github.com/NREL-Sienna/StorageSystemsSimulations/blob/master/LICENSE). StorageSystemsSimulations has been developed as part of ... at the U.S. Department of Energy's National Renewable Energy Laboratory ([NREL](https://www.nrel.gov/))
StorageSystemsSimulations is released under a BSD [license](https://github.com/Sienna-Platform/StorageSystemsSimulations/blob/master/LICENSE). StorageSystemsSimulations has been developed as part of ... at the U.S. Department of Energy's [National Laboratory of the Rockies (NLR)](https://www.nlr.gov/), formerly known as NREL.
6 changes: 3 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ using DocumenterInterLinks
using Literate

# UPDATE FOR CURRENT MODULE NAME HERE
const _DOCS_BASE_URL = "https://nrel-sienna.github.io/StorageSystemsSimulations.jl/stable"
const _DOCS_BASE_URL = "https://sienna-platform.github.io/StorageSystemsSimulations.jl/stable"

links = InterLinks(
"PowerSimulations" => "https://nrel-sienna.github.io/PowerSimulations.jl/stable/",
"PowerSimulations" => "https://sienna-platform.github.io/PowerSimulations.jl/stable/",
)

include(joinpath(@__DIR__, "make_tutorials.jl"))
Expand Down Expand Up @@ -45,7 +45,7 @@ makedocs(;
)

deploydocs(;
repo="github.com/NREL-Sienna/StorageSystemsSimulations.jl.git",
repo="github.com/Sienna-Platform/StorageSystemsSimulations.jl.git",
target="build",
branch="gh-pages",
devbranch="main",
Expand Down
16 changes: 8 additions & 8 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ CurrentModule = StorageSystemsSimulations
## Overview

`StorageSystemsSimulations.jl` is a
[`PowerSimulations.jl`](https://nrel-sienna.github.io/PowerSimulations.jl/stable/)
[`PowerSimulations.jl`](https://sienna-platform.github.io/PowerSimulations.jl/stable/)
extension to support formulations and models related to energy storage.

Operational Storage Models can have multiple combinations of different restrictions.
Expand All @@ -18,15 +18,15 @@ implementations for different attributes defined in [`PowerSimulations.DeviceMod
## About Sienna

`StorageSystemsSimulations.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

Expand All @@ -35,7 +35,7 @@ programming language. `StorageSystemsSimulations.jl` is part of Sienna\Ops.

## Installation and Quick Links

- [Sienna installation page](https://nrel-sienna.github.io/Sienna/SiennaDocs/docs/build/how-to/install/):
- [Sienna installation page](https://sienna-platform.github.io/Sienna/SiennaDocs/docs/build/how-to/install/):
Instructions to install `StorageSystemsSimulations.jl` and other Sienna\Ops packages
- [Sienna Documentation Hub](https://nrel-sienna.github.io/Sienna/SiennaDocs/docs/build/index.html):
- [Sienna Documentation Hub](https://sienna-platform.github.io/Sienna/SiennaDocs/docs/build/index.html):
Links to other Sienna packages' documentation
6 changes: 3 additions & 3 deletions docs/src/reference/developer_guidelines.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Guidelines for Developers

In order to contribute to `StorageSystemsSimulations.jl` repository please read the following sections of
[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl)
[`InfrastructureSystems.jl`](https://github.com/Sienna-Platform/InfrastructureSystems.jl)
documentation in detail:

1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/)
2. [Contributing Guidelines](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/blob/master/CONTRIBUTING.md)
1. [Style Guide](https://sienna-platform.github.io/InfrastructureSystems.jl/stable/style/)
2. [Contributing Guidelines](https://github.com/Sienna-Platform/StorageSystemsSimulations.jl/blob/master/CONTRIBUTING.md)

Pull requests are always welcome to fix bugs or add additional modeling capabilities.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/tutorials/single_stage_model.jl
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ using HiGHS ## solver
# !!! note
#
# `PowerSystemCaseBuilder.jl` is a helper library that makes it easier to reproduce examples in the documentation and tutorials. Normally you would pass your local files to create the system data instead of calling the function `build_system`.
# For more details visit [`PowerSystemCaseBuilder.jl`](https://nrel-sienna.github.io/PowerSystemCaseBuilder.jl/stable)
# For more details visit [`PowerSystemCaseBuilder.jl`](https://sienna-platform.github.io/PowerSystemCaseBuilder.jl/stable)

c_sys5_bat = build_system(
PSITestSystems,
Expand Down
Loading