diff --git a/README.md b/README.md index d00579c..00f303c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Development is conducted using a [gitflow](https://www.atlassian.com/git/tutoria ## How to start? -### # Getting software requirements +#### Getting software requirements The following requirements are needed to run various bits: - [Anacond](https://www.anaconda.com/download/): Used for processing and analysing data. The Anaconda distribution is used for managing environments and is available for Windows, Mac and Linux. Jupyter notebooks are used for exploratory analyis and communication. - [QGIS](https://www.qgis.org/en/site/forusers/download): Used for looking at raw LIDAR pre/post storm surveys and extracting dune crests/toes @@ -18,7 +18,7 @@ The following requirements are needed to run various bits: - git #### Getting the repository -Clone the repository: +Clone the repository onto into your local environment: ``` git clone http://git.wrl.unsw.edu.au:3000/chrisl/nsw-2016-storm-impact.git cd nsw-2016-storm-impact @@ -34,9 +34,20 @@ make venv-requirements-install You can see what these commands are actually running by inspecting the `Makefile`. #### Pull data +The actual raw, interim and processed data are not tracked by the repository as part of good git practices. A copy of the raw data is stored on the WRL Coastal J:\ drive and can be copied using the following command. +``` +make pull-data +``` +If you have updated the data and want to copy it back to the J:\ drive, use the following command. Note that it is probably not a good idea to modify data stored in `./data/raw`. +``` +make push-data +``` #### View notebooks - +Jupyter notebooks have been set up to help explore the data. Once you have set up your environment and pulled the data, this is probably a good place to start as you. To run the notebook, use the following command and navigate to the `./notebooks` folder. +``` +jupyter notebook +``` ## Available data Raw, interim and processed data used in this analysis is kept in the `/data/` folder. Data is not tracked in the repository due to size constraints, but stored locally. A mirror is kept of the coastal folder J drive which you can