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

Organization of Apps #2

Open
lheagy opened this issue Jan 23, 2017 · 1 comment
Open

Organization of Apps #2

lheagy opened this issue Jan 23, 2017 · 1 comment

Comments

@lheagy
Copy link
Member

lheagy commented Jan 23, 2017

Naming Conventions

The nested folder structure is difficult to navigate. To overcome this, I propose bringing all notebooks into the notebooks directory. In this case, we need a reasonable naming convention to be able to easily navigate through the apps. Overall, I think the naming convention in the dcApps is intuitive and easy to navigate, so I suggest we use

Physics_Model(_Assumption).ipynb

eg. for the DC apps, the Physics is DC, the Model is Plate or Cylinder and the Assumption is 2D or 2_5D (assumption might not be applicable in all cases).

thoughts @sgkang, @thast, @micmitch, @dccowan ?

Images

can we put all images in the images folder instead of including them in the notebooks folder?

Index.ipynb

to make sure that people can navigate to the apps from the index notebook, the index notebook should contain the title of the app and a short description of the app (can include an image!). Links are relative links eg:

[DC_Cylinder_2D.ipynb](notebooks/DC_Cylinder_2D.ipynb)
@micmitch
Copy link
Contributor

Sounds like a good plan to me.

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

2 participants