Skip to content

Commit

Permalink
more setup
Browse files Browse the repository at this point in the history
  • Loading branch information
jd-lara committed Feb 29, 2024
1 parent 92d27ef commit 577bd41
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions .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 SIIP-PACKAGE.jl, please take note of the following when making a PR:
Thanks for opening a PR to PowerSystemsInvestmentsPortfolios.jl, please take note of the following when making a PR:

Check the [contributor guidelines](https://nrel-siip.github.io/SIIP-PACKAGE.jl/stable/code_base_developer_guide/developer/)
Check the [contributor guidelines](https://nrel-siip.github.io/PowerSystemsInvestmentsPortfolios.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/SIIP-PACKAGE.jl">sign the Contributor License Agreement</a>.
- To get started, <a href="https://www.clahub.com/agreements/NREL/PowerSystemsInvestmentsPortfolios.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/).
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# SIIP-Template

[![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)
[![codecov](https://codecov.io/gh/NREL-Sienna/Sienna-PACKAGE.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/NREL-SIIP/PowerSystemsInvestmentsPortfolios.jl)
[![Documentation Build](https://github.com/NREL-Sienna/Sienna-PACKAGE.jl/workflows/Documentation/badge.svg?)](https://nrel-sienna.github.io/Sienna-PACKAGE.jl/stable)
[<img src="https://img.shields.io/badge/slack-@Sienna/SiennaPACKAGE-sienna.svg?logo=slack">](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)
[![Sienna-PACKAGE.jl Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/PowerSystemsInvestmentsPortfolios)](https://pkgs.genieframework.com?packages=Sienna-PACKAGE)


This repository contains the template files for a dummy package called SIIP-PACKAGE. IT contains the required files for
This repository contains the template files for a dummy package called PowerSystemsInvestmentsPortfolios. IT contains the required files for

- Testing
- Documentation
Expand All @@ -20,4 +20,4 @@ Contributions to the development and enahancement of Sienna-PACKAGE is welcome.

## License

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/))
PowerSystemsInvestmentsPortfolios is released under a BSD [license](https://github.com/NREL/PowerSystemsInvestmentsPortfolios/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/))
6 changes: 3 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ pages = OrderedDict(
)

makedocs(
modules=[SIIP-PACKAGE],
modules=[PowerSystemsInvestmentsPortfolios],
format=Documenter.HTML(prettyurls=haskey(ENV, "GITHUB_ACTIONS")),
sitename="SIIP-PACKAGE.jl",
sitename="PowerSystemsInvestmentsPortfolios.jl",
authors="Freddy Mercury, Nikola Tesla, Leonard Bernestein",
pages=Any[p for p in pages],
)

deploydocs(
repo="github.com/NREL-SIIP/SIIP-PACKAGE.git",
repo="github.com/NREL-SIIP/PowerSystemsInvestmentsPortfolios.git",
target="build",
branch="gh-pages",
devbranch="main",
Expand Down
12 changes: 6 additions & 6 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# PowerSystems.jl
# PowerSystemsInvestmentsPortfolio.jl

```@meta
CurrentModule = SIIP_PACKAGE
CurrentModule = PowerSystemsInvestmentsPortfolios
```

## Overview

`PSIIP-PACKAGE .jl` is a [`Julia`](http://www.julialang.org) package that provides blah blah
`PowerSystemsInvestmentsPortfolios .jl` is a [`Julia`](http://www.julialang.org) package that provides blah blah

------------
SIIP-PACKAGE has been developed as part of the Scalable Integrated Infrastructure Planning
(SIIP) initiative at the U.S. Department of Energy's National Renewable Energy
* * *

PowerSystemsInvestmentsPortfolios has been developed as part of XXX initiative at the U.S. Department of Energy's National Renewable Energy
Laboratory ([NREL](https://www.nrel.gov/)).
2 changes: 1 addition & 1 deletion docs/src/quick_start_guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Quick Start Guide

SIIP-PACKAGE.jl is structured to enable stuff
PowerSystemsInvestmentsPortfolios.jl is structured to enable stuff
2 changes: 1 addition & 1 deletion src/portfolio.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
struct Portfolio <: IS.InfrastructureSystemsType
aggregation::Type{<: Union{PSY.ACBus, PSY.AggregationTopology}}
aggregation::Type{<:Union{PSY.ACBus, PSY.AggregationTopology}}
discount_rate::Float64
data::IS.SystemData
time_series_container::InfrastructureSystems.TimeSeriesContainer
Expand Down
2 changes: 1 addition & 1 deletion test/runtests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ function run_tests()
end

# Testing Topological components of the schema
@time @testset "Begin SIIP-PACKAGE tests" begin
@time @testset "Begin PowerSystemsInvestmentsPortfolios tests" begin
@includetests ARGS
end

Expand Down

0 comments on commit 577bd41

Please sign in to comment.