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

Frontends #17

Open
matthewturk opened this issue Feb 22, 2018 · 3 comments
Open

Frontends #17

matthewturk opened this issue Feb 22, 2018 · 3 comments
Assignees

Comments

@matthewturk
Copy link
Member

Currently stubbed out in content/30.abstracting_simulation_types.md (I guess?)

@matthewturk
Copy link
Member Author

I'm thinking that what we actually should do is have a full file of just basic frontend information. Perhaps number it 33, so it comes after the bitmaps and simulation types, and each frontend should have a subsection where we describe:

  1. Name of the frontend -- one entry for each directory, and within that, specify different frontends as sub-items
  2. Roughly, what type of data it contains (i.e., the indexing scheme)
  3. Any historical information about the addition to the code -- if it had any major attendant features for instance
  4. Special considerations about it, or specific things it does differently
  5. (maybe?) Some papers using this frontend to do analysis in yt

@matthewturk
Copy link
Member Author

My current plan is to build out a template in 33.data-formats-and-frontends.md using jinja2, and then add the --template-variables-path argument to build.sh to read in a yaml file, which will then be supplied to the jinja2 template engine during the build. In that file I'll put the frontend information.

@matthewturk
Copy link
Member Author

This is being addressed in #94

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants