Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add badges (pre-commit, black, DOI badge from Zenodo) #95

Merged
merged 4 commits into from
Jul 13, 2023
Merged

Add badges (pre-commit, black, DOI badge from Zenodo) #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e4e151
Add badges (pre-commit, black, DOI badge from Zenodo), following gymn…
elliottower Jul 12, 2023
55e60f0
Add updated citation from Zenodo
elliottower Jul 12, 2023
774ea12
Update test_dm_control.py
elliottower Jul 12, 2023
c7cfe9c
pre-commit
elliottower Jul 13, 2023
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
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8140744.svg)](https://doi.org/10.5281/zenodo.8140744)

<p align="center">
<img src="https://raw.githubusercontent.com/Farama-Foundation/Shimmy/main/shimmy-text.png" width="500px"/>
</p>
Expand Down Expand Up @@ -94,11 +96,17 @@ Maintenance for this project is also contributed by the broader Farama team: [fa

If you use Shimmy in your research, please cite:
```
@software{shimmy2022github,
author = {{Jun Jet Tai, Mark Towers, Elliot Tower} and Jordan Terry},
title = {Shimmy: Gymnasium and PettingZoo Wrappers for Commonly Used Environments},
url = {https://github.com/Farama-Foundation/Shimmy},
version = {1.0.0},
year = {2022},
@software{jun_jet_tai_2023_8140744,
author = {Jun Jet Tai and
Mark Towers and
Elliot Tower},
title = {{Shimmy: Gymnasium and PettingZoo Wrappers for
Commonly Used Environments}},
month = jun,
year = 2023,
publisher = {Zenodo},
version = {v1.1.0},
doi = {10.5281/zenodo.8140744},
url = {https://doi.org/10.5281/zenodo.8140744}
}
```
3 changes: 3 additions & 0 deletions tests/test_dm_control.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ def test_dm_control_suite_envs():
CHECK_ENV_IGNORE_WARNINGS.append(
'arrays to stack must be passed as a "sequence" type such as list or tuple. Support for non-sequence iterables such as generators is deprecated as of NumPy 1.16 and will raise an error in the future.',
)
CHECK_ENV_IGNORE_WARNINGS.append(
"Conversion of an array with ndim > 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)"
)


@pytest.mark.parametrize("env_id", DM_CONTROL_ENV_IDS)
Expand Down