These tutorials are compatible with SHARE v2 and use Python 3. For the old, SHARE v1-compatible notebooks, see the share_v1 branch.

---

SHARE API v2 Tutorials

Example Jupyter Notebooks for accessing, querying, and exporting data from SHARE v2.

Use Binder to run the notebooks online! Click here:

Pre-requisites

• Miniconda (make sure to download the latest Python 3 version) for python package and environment handling (recommended) OR virtualenv

Setup

First, clone this repository to your local machine

git clone https://github.com/erinspace/share_tutorials.git
cd share_tutorials

Option 1: With conda (recommended)

Prerequisite: Must have Anaconda or miniconda installed.

Linux and OSX:

conda env create -f environment.yml
source activate share_tutorials

Windows:

conda env create -f environment_win.yml
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

Contributing

• Fork the repository
• Create a pull request with improvements and suggestions!