jmyntti / share_tutorials

Some simple Jupyter Notebooks for accessing, querying, and exporting data from SHARE

SHARE API Tutorials - Version 2 with Python 3!

Some simple Jupyter Notebooks for accessing, querying, and exporting data from SHARE, API V2!

For the old notebooks, using the SHARE v1 API and Python 2, see the share_v1 branch.

Use Binder to run the notebooks online! Click here:

pre-requisites:

• Python 3.5
• pip for installing python packages OR
• Miniconda for python package and environment handling

Setup

• Clone this repository to your local machine
  • Here's a guide to cloning from github
  • Fork the repository first to have your own copy and make changes on github!
  • feel free to create a pull request with improvements and suggestions!

Option 1: With conda (recommended)

Prerequisite: Must have Anaconda or miniconda installed.

Linux and OSX:

conda env create -f environment.yml --name share_tutorials
source activate share_tutorials

Windows:

conda env create -f environment_win.yml --name share_tutorials
activate share_tutorials

Option 2: With virtualenv and pip

• Install requirements from requirements.txt inside a virtualenv with:

# After activating your virtualenv
pip install -r requirements.txt

Run the notebooks

• Run the jupyter notebook in a terminal with the command: jupyter notebook
• Click on the notebook you'd like to run
• Run cells individually with the shift+return