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

Add Simulator tutorial notebook #85

Merged
merged 15 commits into from
May 6, 2024
Merged

Conversation

corentinlger
Copy link
Collaborator

@corentinlger corentinlger commented Apr 29, 2024

Description

  • Added simulator tutorial notebook
  • Added an explanation on tutorials in the README
  • Added saving functions in simulator
  • Renamed 'nve_idx' 'ent_idx'

Related Issue (if applicable)

#28

How to Test

Follow the steps in the new simulator_tutorial notebook.

Check the server-client connection still works fine.

notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
Copy link
Collaborator

@clement-moulin-frier clement-moulin-frier left a comment

Choose a reason for hiding this comment

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

Thanks @corentinlger , a few comments in the code

Also, it will be useful to add a short description of all tutorials we already have in the README and in which order it is recommended to follow them. Maybe first the web_interface_tutorial.md ; then the quickstart_tutorial.ipynb ; and then this one

notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
notebooks/simulator_tutorial.ipynb Outdated Show resolved Hide resolved
@corentinlger corentinlger changed the title [WIP] Simulator tuto notebook Add Simulator tutorial notebook May 6, 2024
Copy link
Collaborator Author

@corentinlger corentinlger left a comment

Choose a reason for hiding this comment

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

I double checked the code and played with the simulator in interface mode and it doesn't seem to be errors. I merge the PR.

@corentinlger corentinlger merged commit bf118d6 into main May 6, 2024
2 checks passed
@corentinlger corentinlger deleted the simulator_tuto_notebook branch June 3, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants