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

Fix yaml issues with BBH ID example nb #6280

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

vaishakp
Copy link
Contributor

@vaishakp vaishakp commented Sep 7, 2024

Proposed changes

  1. Fix loading and writing of yaml files with multiple yaml documents in the same stream. Previously, the existing tutorial presumably worked with a single document yaml stream. The latest BinaryBlackHole.yaml has multiple docs. This change allows such streams to be read and edited in this example notebook.

  2. Make minor changes in path names to make it more informative.

Upgrade instructions

Code review checklist

  • The code is documented and the documentation renders correctly. Run
    make doc to generate the documentation locally into BUILD_DIR/docs/html.
    Then open index.html.
  • The code follows the stylistic and code quality guidelines listed in the
    code review guide.
  • The PR lists upgrade instructions and is labeled bugfix or
    new feature if appropriate.

Further comments

Fix loading and writing of multiple yaml documents
in the same stream. Previously, the existing tutorial
presumably worked with a single document yaml stream.
The current `BinaryBlackHole.yaml` has multiple docs.
This change allows such streams to be read and edited
in this example notebook.

Make minor changes in path names to make it more informative.
@nilsvu
Copy link
Member

nilsvu commented Sep 7, 2024

Hey Vaishak! Thanks for looking at this. Indeed this tutorial is very out of date. I was going to replace it by the one from SXScon.

@vaishakp
Copy link
Contributor Author

vaishakp commented Sep 8, 2024

Hey Vaishak! Thanks for looking at this. Indeed this tutorial is very out of date. I was going to replace it by the one from SXScon.

The one from SXSCon is nice and easy for BBH ID+evolution at the highest level. I however find that this one is informative and could be preserved as an ID example that works at a slightly lower level, working directly with the input files. In my opinion, it will be useful to keep both.

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