diff --git a/.github/workflows/cross-package-test.yml b/.github/workflows/cross-package-test.yml index 2875945..3e3d634 100644 --- a/.github/workflows/cross-package-test.yml +++ b/.github/workflows/cross-package-test.yml @@ -2,7 +2,7 @@ name: CrossPackageTest on: push: - branches: [master] + branches: [main] tags: [v*] pull_request: diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 261b424..d417ae8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,7 +3,7 @@ name: Documentation on: push: branches: - - master + - main - 'release-' tags: '*' pull_request: @@ -12,7 +12,7 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: julia-actions/setup-julia@v1 with: version: '1.6' diff --git a/.github/workflows/format-check.yml b/.github/workflows/format-check.yml index 75786f5..cf2bed0 100644 --- a/.github/workflows/format-check.yml +++ b/.github/workflows/format-check.yml @@ -3,7 +3,7 @@ name: Format Check on: push: branches: - - 'master' + - 'main' - 'release-' tags: '*' pull_request: diff --git a/.github/workflows/main-tests.yml b/.github/workflows/main-tests.yml index e78f8d2..7a446e7 100644 --- a/.github/workflows/main-tests.yml +++ b/.github/workflows/main-tests.yml @@ -18,7 +18,7 @@ jobs: os: [ubuntu-latest, windows-latest, macOS-latest] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: julia-actions/setup-julia@latest with: version: ${{ matrix.julia-version }} diff --git a/.github/workflows/pr_testing.yml b/.github/workflows/pr_testing.yml index 2debe86..dc70d20 100644 --- a/.github/workflows/pr_testing.yml +++ b/.github/workflows/pr_testing.yml @@ -15,7 +15,7 @@ jobs: os: [ubuntu-latest, windows-latest, macOS-latest] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: julia-actions/setup-julia@latest with: version: ${{ matrix.julia-version }} diff --git a/README.md b/README.md index 4f84f5e..eefca2c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # SIIP-Template -[![Master - CI](https://github.com/NREL-Sienna/Sienna-PACKAGE.jl/workflows/Master%20-%20CI/badge.svg)](https://github.com/NREL-Sienna/Sienna-PACKAGE.jl/actions/workflows/main-tests.yml) -[![codecov](https://codecov.io/gh/NREL-Sienna/Sienna-PACKAGE.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/NREL-SIIP/SIIP-PACKAGE.jl) +[![main - CI](https://github.com/NREL-Sienna/Sienna-PACKAGE.jl/workflows/main%20-%20CI/badge.svg)](https://github.com/NREL-Sienna/Sienna-PACKAGE.jl/actions/workflows/main-tests.yml) +[![codecov](https://codecov.io/gh/NREL-Sienna/Sienna-PACKAGE.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/NREL-SIIP/SIIP-PACKAGE.jl) [![Documentation Build](https://github.com/NREL-Sienna/Sienna-PACKAGE.jl/workflows/Documentation/badge.svg?)](https://nrel-sienna.github.io/Sienna-PACKAGE.jl/stable) [](https://join.slack.com/t/nrel-siip/shared_invite/zt-glam9vdu-o8A9TwZTZqqNTKHa7q3BpQ) [![Sienna-PACKAGE.jl Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/SIIP-PACKAGE)](https://pkgs.genieframework.com?packages=Sienna-PACKAGE) @@ -16,8 +16,8 @@ This repository contains the template files for a dummy package called SIIP-PACK ## Development -Contributions to the development and enahancement of Sienna-PACKAGE is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/Sienna-PACKAGE.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines. +Contributions to the development and enahancement of Sienna-PACKAGE is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/Sienna-PACKAGE.jl/blob/main/CONTRIBUTING.md) for code contribution guidelines. ## License -SIIP-PACKAGE is released under a BSD [license](https://github.com/NREL/SIIP-PACKAGE/blob/master/LICENSE). Sienna PACKAGE has been developed as part of A PROJECT at the U.S. Department of Energy's National Renewable Energy Laboratory ([NREL](https://www.nrel.gov/)) +SIIP-PACKAGE is released under a BSD [license](https://github.com/NREL/SIIP-PACKAGE/blob/main/LICENSE). Sienna PACKAGE has been developed as part of A PROJECT 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 949908c..054e9d6 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -20,7 +20,7 @@ deploydocs( repo="github.com/NREL-SIIP/SIIP-PACKAGE.git", target="build", branch="gh-pages", - devbranch="master", + devbranch="main", devurl="dev", push_preview=true, versions=["stable" => "v^", "v#.#"], diff --git a/src/PowerSystemsInvestmentsPortfolios.jl b/src/PowerSystemsInvestmentsPortfolios.jl new file mode 100644 index 0000000..2c2ea1c --- /dev/null +++ b/src/PowerSystemsInvestmentsPortfolios.jl @@ -0,0 +1,27 @@ +module PowerSystemsInvestmentsPortfolios + +import InfrastructureSystems +import PowerSystems + +export Portfolio +export SupplyTechnology +export TransportTechnology +export DemandTechnology + +const PSY = PowerSystems +const IS = InfrastructureSystems + +include("demand.jl") +include("supply.jl") +include("transport.jl") +include("storage.jl") +include("portfolio.jl") + +using DocStringExtensions + +@template (FUNCTIONS, METHODS) = """ + $(TYPEDSIGNATURES) + $(DOCSTRING) + """ + +end diff --git a/src/SIIP-PACKAGE.jl b/src/SIIP-PACKAGE.jl deleted file mode 100644 index 6a9ae3a..0000000 --- a/src/SIIP-PACKAGE.jl +++ /dev/null @@ -1,11 +0,0 @@ -module SIIP --PACKAGE - -using DocStringExtensions - -@template (FUNCTIONS, METHODS) = """ - $(TYPEDSIGNATURES) - $(DOCSTRING) - """ - -end diff --git a/src/demand.jl b/src/demand.jl new file mode 100644 index 0000000..caec2e2 --- /dev/null +++ b/src/demand.jl @@ -0,0 +1,8 @@ +struct DemandTechnology{T <: PSY.Device} <: IS.Component + name::String + power_systems_type::PSY.Device + capital_cost::Float64 + ext::Dict{String, Any} + time_series_container::InfrastructureSystems.TimeSeriesContainer + internal::InfrastructureSystemsInternal +end diff --git a/src/portfolio.jl b/src/portfolio.jl new file mode 100644 index 0000000..a0b2887 --- /dev/null +++ b/src/portfolio.jl @@ -0,0 +1,6 @@ +struct Portfolio <: IS.InfrastructureSystemsType + aggregation::Type{<: Union{PSY.ACBus, PSY.AggregationTopology}} + discount_rate::Float64 + data::IS.SystemData + time_series_container::InfrastructureSystems.TimeSeriesContainer +end diff --git a/src/storage.jl b/src/storage.jl new file mode 100644 index 0000000..4265884 --- /dev/null +++ b/src/storage.jl @@ -0,0 +1,12 @@ +struct StorageTechnology{T <: PSY.Storage} <: IS.Component + name::String + power_systems_type::PSY.Device + capital_cost::Float64 + battery_chemistry::String # Implement Chemistry Type Enums in PowerSystems + prime_mover::PSY.Primer_mover + capital_cost::Float64 + operational_cost::PSY.OperationalCost + ext::Dict{String, Any} + time_series_container::InfrastructureSystems.TimeSeriesContainer + internal::InfrastructureSystemsInternal +end diff --git a/src/supply.jl b/src/supply.jl new file mode 100644 index 0000000..c84a857 --- /dev/null +++ b/src/supply.jl @@ -0,0 +1,12 @@ +struct SupplyTechnology{T <: PSY.Device} <: IS.Component + name::String + power_systems_type::Type{T} + fuel::PSY.ThermalFuels + prime_mover::PSY.Primer_mover + capacity_factor::Float64 + capital_cost::Float64 + operational_cost::PSY.OperationalCost + ext::Dict{String, Any} + time_series_container::InfrastructureSystems.TimeSeriesContainer + internal::InfrastructureSystemsInternal +end diff --git a/src/transport.jl b/src/transport.jl new file mode 100644 index 0000000..f7ac963 --- /dev/null +++ b/src/transport.jl @@ -0,0 +1,8 @@ +struct TransportTechnology{T <: PSY.Device} <: IS.Component + name::String + power_systems_type::Type{T} + capital_cost::Float64 + ext::Dict{String, Any} + time_series_container::InfrastructureSystems.TimeSeriesContainer + internal::InfrastructureSystemsInternal +end