Skip to content

Commit 27beb98

Browse files
committed
update sample teaching schedule
1 parent ddac04d commit 27beb98

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

paper.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ After these basics, the workshop introduces the concept of functions and writing
3434
This workshop was developed by the Molecular Sciences Software Institute (MolSSI), as part of its mission to enhance software, education, and training in the computational molecular sciences. MolSSI works to improve software practices in CMS, and this workshop gives a light introduction to several topics we advocate as best practices (version control, testing, and documentation). MolSSI's educational mission builds on and uses strategies from the work of Software Carpentry and Data Carpentry.
3535

3636
## Statement of Need
37-
Within chemistry, and many other fields related to CMS, the amount of structured programming training students receive as part of their undergraduate education varies widely. Students may have a stand-alone programming course or no instruction at all. Further, most chemists, even computational chemists who use programming regularly in their research, are rarely trained on teaching programming and often lack resources to provide students this type of training. Thus, most programming training for chemists is ad-hoc, through interactions with mentors and research advisors, or self-taught by learning what they need to know to solve problems in research. The Molecular Sciences Software Institute aims to address this problem by providing resources, training, and workshops to teach students best practices in software development. This will enhance the entire discipline of computational molecular science by making code more stable, reproducible, and maintainable.
37+
Within chemistry, and many other fields related to CMS, the amount of structured programming training students receive as part of their undergraduate education varies widely. Students may have a stand-alone programming course or no instruction at all. Further, most chemists, even computational chemists who use programming regularly in their research, are rarely trained on teaching programming and often lack resources to provide students this type of training. Thus, most programming training for chemists is ad-hoc, through interactions with mentors and research advisors, or self-taught by learning what they need to know to solve problems in research. The Molecular Sciences Software Institute aims to address this problem by providing resources, training, and workshops to teach students best practices in software development. This workshops introduces basics concepts related to Python program to provide a foundation for software best practices advocated by MolSSI for larger software projects.
3838

3939
## Learning Objectives and Contents
4040

@@ -50,13 +50,41 @@ Within chemistry, and many other fields related to CMS, the amount of structured
5050

5151
- **Writing Functions** - This lesson introduces functions, and why they are useful in programming. Students practice by reformatting their geometry analysis project to contain functions.
5252

53-
- **Running code from the Linux Command Line** - This lessons covers moving from the Jupyter notebook to a text editor and running a python script from the command line. Students are taught how to take user input from the command line using the `argparse` module.
53+
- **Running code from the Command Line** - This lessons covers moving from the Jupyter notebook to a text editor and running a python script from the command line. Students are taught how to take user input from the command line using the `argparse` module.
5454

5555
- **Testing Code with pytest** - This lesson gives a very light introduction and unit testing using the `pytest` framework.
5656

5757
- **Version Control and Sharing Code** - This lesson gives an overview of version control using git and hosting code on GitHub.
5858

59-
## Sample Teaching Schedules
59+
## Sample Teaching Schedule
60+
61+
### 1.5 Day Workshop
62+
63+
#### Day 1
64+
65+
| Time | Topic |
66+
|-------------------|---------------------------------------|
67+
11:00 am - 12:00 pm | Help with computer set-up (optional)
68+
1:00 pm - 2:00 pm | Introduction
69+
2:00 pm - 2:45 pm | File parsing
70+
2:45 pm - 3:00 pm | Break
71+
3:00 pm - 3:45 pm | Multiple File Parsing
72+
3:45 pm - 4:45 pm | Working with Tabular Data
73+
4:45 pm - 5:00 pm | Introduce homework assignment
74+
75+
#### Day 2
76+
| Time | Topic |
77+
|-------------------|---------------------------------------|
78+
9:00 am - 9:45 am | Homework Solution
79+
9:45 am - 10:45 am | Plotting and Data Visualization
80+
10:45 am - 11:00 am | Break
81+
11:00 am - 12:00 pm | Writing Functions
82+
12:00 pm - 1:00 pm | Lunch
83+
1:00 pm - 2:00 pm | Moving to the command line
84+
2:00 pm - 3:00 pm | Testing with pytest
85+
3:00 pm - 3:15 pm | Coffee Break
86+
3:15 pm - 4:30 pm | Version control and sharing code
87+
4:30 pm - 5:00 pm | Questions and Feedback
6088

6189
## Future Work
6290

0 commit comments

Comments
 (0)