hw2_aap's Introduction

hw2_aap

Information on using this cookiecutter

Development workflows

Create new project

You've already done this if you are reading this file. You ran:

cookiecutter gh:slidwell44/cookiecutter-datascience-simple

Put project under version control

Let's get version control set up. You don't absolutely have to do this, but you should. For the local repository, do;

git init
git add .
git commit -m "Initial commit"

For the remote repository, make a github repository named hw2_aap, then do;

git remote add origin [email protected]:slidwell44/hw2_aap.git
git branch -M main
git push -u origin main

Great. Using version control is good.

Folder structure

Here's the folder structure that gets created by cookiecutter-datascience-simple:

├── hw2_aap	<- Your notebooks and scripts will live in the main project folder
	│   .gitignore					<- Common file types for git to ignore
	│   README.md					<- The top-level README for developers (you) using this project
	│   template-nb.ipynb			<- A Jupyter notebook template
	│
	├───data						<- Final and intermediate data
	│   └───raw						<- The original, immutable data dump
	│
	├───docs
	│       notes.md				<- Simple markdown template for project notes
	│
	└───output
			readme.md				<- Guidance for using this folder

Documentation

In this very simple project structure template, we've just included a markdown file with some typical section headings to use for project notes. Expand as desired. Later in the semester we will learn how to use Sphinx with restructuredText to write and generate documentation.

Recommend Projects