Skip to content

Commit

Permalink
synch with dev_1.11.0
Browse files Browse the repository at this point in the history
Signed-off-by: DONNOT Benjamin <[email protected]>
  • Loading branch information
BDonnot committed Oct 23, 2024
2 parents 24f3c3c + ef563d5 commit 6c838ce
Show file tree
Hide file tree
Showing 148 changed files with 3,007 additions and 364 deletions.
11 changes: 10 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ jobs:
abi: cp312,
version: '3.12',
}
# - {
# name: cp313, # issue with pandapower atm
# abi: cp313,
# version: '3.13',
# }

steps:

Expand Down Expand Up @@ -121,11 +126,15 @@ jobs:
name: cp312,
version: '3.12',
}
# - { # issue with pandapower atm
# name: cp313,
# version: '3.13',
# }

steps:

- name: Checkout sources
uses: actions/checkout@v1
uses: actions/checkout@v3
with:
submodules: true

Expand Down
462 changes: 260 additions & 202 deletions CHANGELOG.rst

Large diffs are not rendered by default.

128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
67 changes: 67 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Contribution

We welcome contributions from everyone.

If you want to contribute, a good starting point is to get in touch with us through:
- github (discussion, issues or pull-request)
- the project [discord](https://discord.gg/cYsYrPT)
- mail (see current corresponding author from the grid2op package on pypi here https://pypi.org/project/Grid2Op/)

Contribution can take different forms:

- reporting bugs
- improving the documentation
- improving the code examples (notebooks or example in the doc)
- fixing some reported issues (for example at https://github.com/rte-france/Grid2Op/issues )
- adding a new functionality to grid2op (or increase its speed)
- extend grid2op

# On which topic to contribute ?

If you want to contribute but are not sure were to start you can, for example:

- tackle an opened issue tagged as `good first issue`
- try to solve an opened issue marked with `helps wanted`
- there are also some contribution ideas written in the `Work "in progress"` section of the `CHANGELOG.rst`
at the top level of the github repo.

In any case, if you are not sure about what is written here, feel free to ask in the grid2op [github discussion](https://github.com/orgs/Grid2op/discussions),
in the [grid2op discord](https://discord.gg/cYsYrPT) or by contacting by mail the person in charge of the [pypi package](https://pypi.org/project/Grid2Op/).

# What to do concretely ?

For smaller changes (including, but not limited to the reporting of a bug or a contribution to the explanotory notebooks or the documentations)
a simple "pull request" with your modifications by detailing what you had in mind and the goal of your changes.

In case of a major change (or if you have a doubt on what is "a small change"), please open an issue first
to discuss what you would like to change and then follow as closely as possible the guidelines below. This is to ensure
first that no other contribution is this direction is being currently made but also to make sure that it
does not conflicts with some core ideas of the project.

# Guidelines for contributing to the codebase

For larger contributions, you can follow the given :

1. fork the repository located at <https://github.com/rte-france/Grid2Op>
2. synch your fork with the "latest developement branch of grid2op". For example, if the latest grid2op release
on pypi is `1.10.3` you need to synch your repo with the branch named `dev_1.10.4` or `dev_1.11.0` (if
the branch `dev_1.10.4` does not exist). It will be the highest number in the branches `dev_*` on
grid2op official github repository.
3. implement your functionality / code your modifications, add documentation or any kind of contribution
4. make sure to add tests and documentation if applicable
5. once it is developed, synch your repo with the last development branch again (see point 2 above) and
make sure to solve any possible conflicts
6. write a pull request and make sure to target the right branch (the "last development branch")

# When will it be merged ?

A contribution will be merged once approved by the maintainers (this is why it is recommended to first
get in touch with the team)

Code in the contribution should pass all the current tests, have some dedicated tests for the new feature (if applicable)
and documentation (if applicable).

If you contribute to some grid2op notebooks, please make sure to "clear all outputs"
before making the pull request.

New contributions should respect the "**Code of Conduct**" of grid2op.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ WORKDIR /Grid2Op
RUN git pull
RUN git remote update
RUN git fetch --all --tags
RUN git checkout "tags/v1.10.3" -b "v1.10.3-branch"
RUN git checkout "tags/v1.10.5" -b "v1.10.5-branch"
# Install Dependencies
RUN pip3 install .[optional,challenge]
WORKDIR /
Expand Down
Loading

0 comments on commit 6c838ce

Please sign in to comment.