{"id":22562336,"url":"https://github.com/mdietrichstein/digitalpreservation-dmp","last_synced_at":"2025-03-28T12:43:01.466Z","repository":{"id":73366378,"uuid":"125386835","full_name":"mdietrichstein/digitalpreservation-dmp","owner":"mdietrichstein","description":"👽 Exploring the connection between alcohol consumption and the number of ufo sightings in the USA 👽","archived":false,"fork":false,"pushed_at":"2018-03-29T12:22:42.000Z","size":5454,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-20T09:53:47.554Z","etag":null,"topics":["alcohol","datamanagement","datascience","digitalpreservation","dmp","doi","mulder","orcid","ufo","xfiles"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mdietrichstein.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-03-15T15:22:00.000Z","updated_at":"2018-03-29T12:22:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"ecfd9953-96d4-40a6-b2f9-33613c672c43","html_url":"https://github.com/mdietrichstein/digitalpreservation-dmp","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdietrichstein%2Fdigitalpreservation-dmp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdietrichstein%2Fdigitalpreservation-dmp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdietrichstein%2Fdigitalpreservation-dmp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdietrichstein%2Fdigitalpreservation-dmp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mdietrichstein","download_url":"https://codeload.github.com/mdietrichstein/digitalpreservation-dmp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246034275,"owners_count":20712851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alcohol","datamanagement","datascience","digitalpreservation","dmp","doi","mulder","orcid","ufo","xfiles"],"created_at":"2024-12-07T22:12:36.610Z","updated_at":"2025-03-28T12:43:01.434Z","avatar_url":"https://github.com/mdietrichstein.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![DOI](https://zenodo.org/badge/125386835.svg)](https://zenodo.org/badge/latestdoi/125386835)\n\n# Correlating Alcohol Consumption and UFO Sightings in the USA\n\nThis experiment aims to explore the connection between the alcohol consumption per capita and the number of ufo sightings in the USA.\n\n## Prerequisites\n\nPrior to running the experiment make sure that the following folders exist:\n\n* `data/raw` - Folder to store the external datasets\n* `data/processed` - Folder to store the intermediate dataset in\n* `reports/figures` - Target folder for generated correlation plot\n\n## Data Sources\n\n* Ufo Sightings: Sigmond Axel. (2014). ufo-reports (Version commit-c0915f18186e5e2227083702049a838258001a2a) [Data set]. Zenodo. http://doi.org/10.5281/zenodo.1205624\n* Alcohol Consumption: OECD (2018), Alcohol consumption (indicator). doi: 10.1787/e6895909-en (Accessed on 22 March 2018) via https://data.oecd.org/healthrisk/alcohol-consumption.htm\n\nThe cited datasources have already been added to this repository. \n\nFollow these instructions if you want to use updated versions of these datasource:\n\n1. Download CSV files to folder `data/raw`\n2. Set paths to CSV files in notebook `01_data-preprocessing.ipynb` by changing the values of `UFO_SIGHTINGS` and `ALC_CONSUMPTION`\n\n\n## Running the code\n\nTo run the code in this repository you will need to have access to a machine running `python` (at least version `3.5`) and pip.\n\nRun `pip install -r requirements.txt` to install the required dependencies.\n\nOnce the dependencies have been installed, start the jupyter notebook server via `jupyter notebook` and open `http://localhost:8888`. \n\nIn the `notebooks` folder you'll find the following notebooks:\n\n**01_data-preprocessing.ipynb**\n\nRunning this notebook generates a dataset consisting of the number of ufo sightings and the alcohol consumption in the usa per year by preprocessing and accumulating the data provided by the datasources mentioned above.\n\nThe resulting dataset is located at `data/processed/ufo_alcohol.csv`\n\n**02_visualization.ipynb**\n\nThis notebook takes the data generated by running `01_data-preprocessing.ipynb` as input  and generates a plot to visualize correlations between the data points.\n\nThe resulting plot is stored at `reports/figures/correlation.png`\n\n\n### Docker\n\nRun `docker build .` to create a docker image of this repository. The resulting image exposes the jupyter notebook on port `8888`.\n\nBoot a docker container via `docker run -i -p 8888:8888 \u003cIMAGE_ID\u003e` to start a jupyter instance. The resulting console output will show the url you can open in your browser to take a look at the code, e.g.\n\n```\n Copy/paste this URL into your browser when you connect for the first time,\n    to login with a token:\n        http://0.0.0.0:8888/?token=\u003cSOME_TOKEN\u003e\n```\n\n## Architecture\n![System Architecture Diagram](https://raw.githubusercontent.com/mdietrichstein/digitalpreservation-dmp/a117d99b00ec7def31bff4b79f9f6933badecce2/documentation/architecture.png \"System Architecture Diagram\")\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdietrichstein%2Fdigitalpreservation-dmp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdietrichstein%2Fdigitalpreservation-dmp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdietrichstein%2Fdigitalpreservation-dmp/lists"}