Ask Me
Vincent Scalfani
Contact:
Science and Engineering Librarian
109 Rodgers Library
205-348-5806
109 Rodgers Library
205-348-5806
Scripting and Documentation Workflows
With any informatics or data research project, it can be helpful to develop a scripting and documentation workflow to help document your research methods. This guide highlights resources for scripting and documentation workflow tools for Python, Unix Shell, Matlab, and Mathematica.
Version Control
- git DocumentationDocumentation and tutorials for git version control.
- GitHub Docs: Hello WorldIntroduction to getting started with GitHub.
- Software Carpentry: Version Control with GitSoftware Carpentry's tutorials on Git.
- GitLab basics GuidesVarious tutorials from GitLab on getting started with GitLab and git.
- Wikipedia: Comparison of Git GUIsIf you are interested in using a Git GUI application, Wikipedia has a comparison table.
Computational Notebooks
- Jupyter Notebooks and JupyterLabPopular computational notebook for Python, but can also be used with other programming languages.
- IPythonInteractive shell for Python, can be used as a computational notebook in a Unix terminal window.
- Matlab Live ScriptMatlab based computational notebooks.
- Wolfram Computational NotebooksMathematica computational notebooks.
Markup Languages
- Wikipedia: Comparison of document-markup languagesNice table overview of different markup languages. If you are unsure where to begin, consider starting with Markdown.
Documentation Preparation Tools
- Jupyter BookUseful for creating online books from Jupyter Notebook, reStructuredtext, and markdown files.
- SphinxPopular documentation preparation software for reStructuredText markup.
- GNU troff (groff)Documentation preparation system used for manual pages in GNU software.