You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
These sections use nearly identical examples. The main difference is the Tutorial section includes more description, while the Examples section condensed the scripts from the tutorials.
We'd like to open a discussion on the aim of each section and use these aims to improve the Tutorial and Examples sections.
Proposed change
TBD
The text was updated successfully, but these errors were encountered:
klywang
changed the title
Add content Tutorial and Examples sections
Add content Tutorial, Examples, and Recipes sections
Apr 17, 2020
klywang
changed the title
Add content Tutorial, Examples, and Recipes sections
Adjust content in the Tutorial, Examples, and Recipes sections
Apr 20, 2020
The aims of the Tutorial, Examples, and Recipies sections are detailed below, according to discussion between @atravitz, @b-butler, @bdice, and @vyasr:
Tutorial
Explanations of concepts between code snippets
More verbose than Examples
Examples
Clear, concise code
Self contained
May include external packages
Templates for more advanced usage of signac rather than instructional
Recipes
How to guides
Includes copy/paste components of code for advanced usages of signac
Proposed Changes
Tutorial
Ensure Tutorial covers all necessary concepts included in the ideal gas code from Examples
Examples
Remove the ideal gas example from Examples
Add direct links to signac-examples repo, links should accompany explanations for the purpose of each example
Issue Description
These sections use nearly identical examples. The main difference is the Tutorial section includes more description, while the Examples section condensed the scripts from the tutorials.
We'd like to open a discussion on the aim of each section and use these aims to improve the Tutorial and Examples sections.
Proposed change
TBD
The text was updated successfully, but these errors were encountered: