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.

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

Split scenario and gym-ignition Python packages #346

Merged
merged 15 commits into from
May 22, 2021

Conversation

diegoferigo
Copy link
Member

@diegoferigo diegoferigo commented May 7, 2021

Closes #344. After this change, it should be more clear that gym-ignition is meant for RL applications, and scenario for a more broad use that is not related to RL. Those interested in just scenario can avoid to install also gym-ignition.

  • Created new package (with setup.py) in the scenario folder, former cpp.
  • gym-ignition pure Python package now depends from scenario.
  • Update Docker images (currently only used in the website pipeline).

CI/CD pipeline changes:

  • Split workflow in multiple jobs
  • The workflow runs on default runners, it will be easier to add multiplatform support in the future
  • The colcon workspace (nightly channel) is built only once and it gets cached even if there are build or test errors
  • The new Build and Test job can be integrated more easily with conda (Test conda installation #279, Add workflow using conda to install dependencies #313)
  • Create scenario wheels for both Python 3.8 and 3.9
  • New complete artifact archive with both sdist and wheels for scenario and gym-ignition

Screenshot_20210507_154215

TODO:

  • Finalize new scenario README that will be included in the new PyPI package
  • Update installation instructions
  • Clean docker images
  • Fix website workflow
  • Claim the scenario PyPI package (PEP 541 Request: scenario pypi/support#1082) Using scenar-io while waiting.
  • Check if the PyPI token works for both scenario and gym-ignition, otherwise generate a new one

@diegoferigo
Copy link
Member Author

Waiting the decision on the PyPI name in the dedicated issue, maybe we can start moving this forward with the scenar-io name. The import will remain the same (scenario), it's just the PyPI package that will have a temporarily name. I think until everything remains in devel this should be fine.

@diegoferigo diegoferigo force-pushed the feature/split_scenario branch 2 times, most recently from 610cedf to f5fc0f1 Compare May 20, 2021 22:04
@diegoferigo diegoferigo force-pushed the feature/split_scenario branch 2 times, most recently from 895dbdd to da53b65 Compare May 21, 2021 08:41
@diegoferigo diegoferigo force-pushed the feature/split_scenario branch 3 times, most recently from 1e18c60 to 3445566 Compare May 21, 2021 14:25
@diegoferigo diegoferigo marked this pull request as ready for review May 21, 2021 15:16
@diegoferigo diegoferigo force-pushed the feature/split_scenario branch 2 times, most recently from a351ac7 to c83200d Compare May 21, 2021 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Split setuptools packaging of gym-ignition and scenario
2 participants