This repository contains a Jupyter notebook and ancillary files demonstrating the simulation of one year of weather data using the Python programming language and various associated technologies in part fulfillment of requirements for the Programming for Data Analysis module of the HDipSc in Computing in Data Analytics at the Galway-Mayo Institute of Technology (GMIT).
The repository contains one Jupyter notebook;
The rest of the contents of the repository support that notebook. They are:
- README.md; this file
- requirements.txt; a list of Python packages required to run the notebook
- .gitignore; a git support file which may be safely ignored
- data/; a directory containing the source data for this project, as well as the data key and licence.
Nothing extra is required to view the contents of the repository on github or nbviewer or binder. However see below for discussion of the limitations of these formats.
To run these notebooks locally Python v3.9+ with Pip or some other package manager is the minimum requirement. In order to clone this repository - the easiest way to acquire the code - git v.2+ is required.
Assuming Python is installed then the Python packages listed in requirements.txt are required. These can usually be installed in one go using the requirements.txt file with pip or, presumably, any other Python package manager. See below for details.
There are three ways to consume the notebook in this repository:
-
View here on github by simply clicking on simulation.ipynb, or on nbviewer by clicking on button below:
This is fine if viewing is all that is required, but if interactivity is necessary or desirable then options 2 or 3 should be considered.
-
View and interact with the notebook on binder by clicking on the button below:
This will give access to the entire repository via a JupyterLab session. The code in the notebooks can be changed and executed or new notebooks can be started to experiment with the data, which is, of course, also accessible from the binder session.
-
Clone the repository and run a Jupyter server locally by following these steps (these steps have been tested on a Linux system, some details may differ if using a different operating system):
- Ensure that Python v3.9+, Pip, and git v.2+ are all installed.
- Clone the repository by typing
git clone git@github.com:fod/simulation.gitinto a terminal. - The repository will be downloaded. When it is complete, enter the simulation directory and create a Python virtual environment in a directory called
.venvwithpython -m venv .venv - Activate the virtual environment with
source .venv/bin/activate - Next install the required packages with
pip install requirements.txt - Finally, start a jupyter server by typing
jupyter-lab. A jupyter lab session should launch in a browser window. If it doesn't, a link which can be pasted into a browser address bar is printed in the terminal.
