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

Organize Notebooks into Category-Specific Folders #25

Open
ahnaf-tahmid-chowdhury opened this issue Oct 26, 2024 · 0 comments
Open

Organize Notebooks into Category-Specific Folders #25

ahnaf-tahmid-chowdhury opened this issue Oct 26, 2024 · 0 comments

Comments

@ahnaf-tahmid-chowdhury
Copy link

Description

Currently, all notebooks in this repository are placed in the root folder. The examples in the OpenMC documentation are organized into specific categories, such as Model Building, Reactor Examples, Other Examples, Tallies and Visualization, Nuclear Data, Features, Multigroup Cross Section Generation, Multigroup Mode, and Unstructured Mesh. It would be beneficial to mirror this structure in the repository by placing notebooks into corresponding folders.

Proposed Change

  • Create folders for each category as listed in the OpenMC documentation:
  • Move the relevant notebooks into these category-specific folders.
  • Update any paths or references within the notebooks to ensure functionality remains intact after the reorganization.

Benefits

  • Improves the navigability and user experience of the repository by allowing users to quickly find notebooks relevant to their needs.
  • Aligns the repository structure with the OpenMC documentation, making it easier for users to reference examples.
  • Simplifies cloning and integrating the repository with environments like NukeLab without requiring modifications.
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

No branches or pull requests

1 participant