Learning modules

This GitHub repository contains a collection of computational learning modules that I have created, largely with Jupyter notebooks. The modules are grouped into files by domain, where

• mse = materials science and engineering

• python = Python programming language

The data folder contains all the data files referenced across the modules. The fig folder contains all the figures referenced across the modules.

Usage

Most of the Jupyter notebooks have an interactive component that requires dynamic rendering. There are several ways to do this, and I give two below:

1: Google Colaboratory

This method is nice because it doesn't require you to have Git or Python on your computer, and you can save a copy of each notebook on your Google account. I recommend this option.

1. Click through the folders until you've opened the specific notebook you want to render.
2. In a different tab, go to https://colab.research.google.com and click File > Open notebook > GitHub.
3. Copy and paste the notebook's URL into the blank space and you should be able to run the notebook.

2: Cloning the repo

If you're familiar with Git and have Python 3.6+ installed on your computer, this is another option.

1. Clone the repository.
2. Install the libraries in requirements.txt so that you can run all the notebooks. You can do this with:

   pip install -r requirements.txt 

3. Load Jupyter (jupyter notebook) and run the notebooks.

Python background

Since these Jupyter notebooks require some degree of Python proficiency, you might want to brush up on your Python fundamentals before jumping in. There are existing resources from the Materials Project and UC Berkeley Physics department, as well as several good tutorials online.

Acknowledgements

By sharing these files publicly on GitHub under a MIT license, I'm pretty much giving you free rein to do whatever you wish with the code. If you found the modules helpful, do spread the word to your friends/classmates. A shout-out would be appreciated, but your learning is my top priority. If you need a more formal citation, something like the following could work:

Enze Chen, Learning modules, (2020), GitHub, https://github.com/enze-chen/learning_modules.

or in BibTeX:

@misc{Chen2020,
    author = {Chen, Enze},
    title = {Learning modules},
    year = {2020},
    publisher = {{GitHub}},
    howpublished = {\url{https://github.com/enze-chen/learning_modules}},
}

Contributing

If you have any questions about any of these modules or have an idea for a new module, please let me know! Email, GitHub issue/pull request, anything works.