Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.23 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.23 KB

Property Fundamentals

Investigating the automated collection and analysis of housing data from any location within the UK.

Project based on the cookiecutter data science project template. #cookiecutterdatascience

Installation

Use the following command to clone the respository:

cd your/repo/directory
git clone https://github.com/edgorman/Property-Fundamentals

Create your python environment using the environment.yaml file:

conda env create --file environment.yml

And then activate it using conda:

conda activate property-fundamentals

Usage

The 'data' folder stores any data that is used within the project.

The 'docs' folder stores any extra information that is useful to know.

The 'models' folder stores any machine learning models.

The 'notebooks' folder stores any development scripts.

To run the notebooks, activate your environment using conda and then type 'jupyter notebook' into the same CLI.

The 'property-fundamentals' folder stores any code written for the project.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.