Reorganize this repo into categories that reflect *real* work flows
Closed this issue · 6 comments
The current directory structure is:
- EXP-native
- External simulations
This is way too vague. And the many of the example work flows in EXP-native are applicable to all simulations. So I propose coming up with a new directory structure whose titles explicitly help us (and new users) find the examples they need. Here is a draft list.
- Coefficients
- Basis viewing
- Movies
- mSSA
- Cosmological
- Halo structure
- Disk structure
- Streams
- Satellites
- Spirals
Thoughts and comments?
I think these are great!
Maybe these could be divided into tutorials and how-to-guides. Coefficients, Basis viewing, mSSA, and Movies/visualizations could go under the first category and under tutorials we can add generic examples for Halo, Disk, streams, satellites, spirals, etc..
I don't understand the distinction between "how-to" and "tutorials" here. I think of them all as example workflows that do both. E.g. someone could use the examples to learn what pyEXP does (tutorial?) and as building blocks for new workflows ("how to . . . "). Can you say more about the categories you envision?
Yes, "tutorials" could be common things that users do for a variety of tasks, .e.g., computing coefficients and visualize them. While "how-to-guides" could be more specific to some common dynamics problems. For examples how-to analyze a Cosmological simulation using pyEXP. The "how-to-guides" will use of many of the things learned in the "tutorials". This could be a useful reference: https://diataxis.fr/tutorials-how-to/
Okay, I think I see your point now. You'd like to see a separate top-level "tutorial" category that is a place to learn the core features, concepts and paradigms of pyEXP. These would tend to be longer and instructive as in the sample
and cosine
series current in in EXP-naive
. And a "how-to" that would be cook-book snippets for particular tasks. So everyone would read the tutorials when they start out and then pick and choose the the 'how-to' examples based on research topic. I think that's a good idea.
Yes, exactly I think that will be useful.
Closing this. I think that we've addressed this now.