Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@jd-lara
jd-lara authored Nov 23, 2024
1 parent c5b11e4 commit dcb927a
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@

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

## About this package

PRASInterface.jl is a Julia package that provides an interface to (the unregistered package) [PRAS.jl](https://nrel.github.io/PRAS/) employing PowerSystem.jl's System data model. This package facilitates executing and analyzing the resource adequacy of a bulk power system using Monte Carlo methods with Julia.

For information on using the package check the [documentation]([https://nrel-sienna.github.io/PowerSystems.jl/dev/](https://nrel-sienna.github.io/PRASInterface.jl/dev)).

## Development

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

3 comments on commit dcb927a

@jd-lara
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/120021

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" dcb927a69268e3a776172e4c1c5d8bc83bfadaf2
git push origin v0.1.0

@jd-lara
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JuliaRegistries/General#120021 (comment)

Please sign in to comment.