Adding loader for Hainsworth dataset

.github/PULL_REQUEST_TEMPLATE/new_loader.md

@@ -0,0 +1,33 @@
+### Title
+
+ Please use the following title: "Adding loader for MyDATASET". If your pull request is work in progress, change your title to "[WIP] Adding loader for MyDATASET" to avoid reviews while the loader is not ready.
+
+### Description
+
+Please include the following information at the top level docstring for the dataset's module mydataset.py:
+
+- [ ] Describe annotations included in the dataset
+- [ ] Indicate the size of the datasets (e.g. number files and duration, hours)
+- [ ] Mention the origin of the dataset (e.g. creator, institution)
+- [ ] Describe the type of music included in the dataset
+- [ ] Indicate any relevant papers related to the dataset
+- [ ] Include a description about how the data can be accessed and the license it uses (if applicable) 
+
+#### Dataset loaders checklist:
+
+- [ ] Create a script in `scripts/`, e.g. `make_my_dataset_index.py`, which generates an index file.
+- [ ] Run the script on the canonical version of the dataset and save the index in `mirdata/indexes/` e.g. `my_dataset_index.json`.
+- [ ] Create a module in mirdata, e.g. `mirdata/my_dataset.py`
+- [ ] Create tests for your loader in `tests/datasets/`, e.g. `test_my_dataset.py`
+- [ ] Add your module to `docs/source/mirdata.rst` and `docs/source/table.rst`
+- [ ] Run `black`, `flake8` and `mypy` (see [Running your tests locally](https://mirdata.readthedocs.io/en/stable/source/contributing.html?highlight=contributing#running-your-tests-locally)).
+- [ ] Run `tests/test_full_dataset.py` on your dataset.
+- [ ] Check that codecov coverage does not decrease.
+
+If your dataset **is not fully downloadable** there are two extra steps you should follow:
+- [ ] Contacting the mirdata organizers by opening an issue or PR so we can discuss how to proceed with the closed dataset.
+- [ ] Show that the version used to create the checksum is the "canonical" one, either by getting the version from the dataset creator, or by verifying equivalence with several other copies of the dataset.
+- [ ] Make sure someone has run `pytest -s tests/test_full_dataset.py --local --dataset my_dataset` once on your dataset locally and confirmed it passes.
+
+#### Please-do-not-edit flag
+To reduce friction, we will make commits on top of contributor's pull requests by default unless they use the `please-do-not-edit` flag. If you don't want this to happen don't forget to add the flag when you start your pull request.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,19 @@
+### Pull request name 
+
+While your working on your PR please add the [WIP] indication in the title, to avoid reviewing before it's ready. Also, please try to have a descriptive title.
+
+### Description
+
+Please include a summary of the change and which issue is fixed. 
+
+Fixes # (issue)
+
+### Type of change
+
+Please add a description and delete options that are not relevant.
+
+- [ ] Change 1 (description)
+- [ ] Change 2 (description)
+
+
+Please describe the tests that you ran to verify your changes if it applies. 

.github/environment-ci.yml

@@ -0,0 +1,41 @@
+name: mirdata-dev
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  # required
+  - pip
+  - chardet>=5.0.0
+  - Deprecated>=1.2.14
+  - h5py>=3.7.0
+  - librosa>=0.10.1
+  - numpy>=1.21.6
+  - openpyxl>=3.0.10
+  - pandas>=1.3.5
+  - pyyaml>=6.0
+  - requests>=2.31.0
+  - scipy>=1.7.3
+  - tqdm>=4.66.1
+  #######
+  - libvorbis
+
+  # optional, but required for testing
+  - pytest>=7.4.3
+  - pytest-pep8>=1.0.6
+  - pytest-cov>=4.1.0
+  - pytest-mock>=3.11.1
+  - pytest-localserver>=0.8.1
+  - pytest-xdist>=3.3.1
+
+  - pip:
+    - attrs>=23.1.0
+    - black>=23.3.0
+    - coveralls>=3.3.1
+    - dali-dataset>=1.1
+    - decorator>=5.1.1
+    - future>=0.18.3
+    - jams>=0.3.4
+    - music21>=7.3.3
+    - pretty_midi>=0.2.10
+    - smart_open[all]>=6.4.0
+    - testcontainers>=3.7.1

.github/environment-lint.yml

@@ -0,0 +1,22 @@
+name: lint
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  # required.
+  - pip
+  - Deprecated >= 1.2.14
+  - flake8>=5.0.4
+  - librosa>=0.10.1
+  - mypy>=0.982
+  - numpy>=1.21.6
+  - pandas>=1.3.5
+  - pytest>=7.4.3
+  - requests>=2.31.0
+  - tqdm>=4.66.1
+  - types-decorator>=5.1.8.3
+
+  - pip:
+    - jams>=0.3.4
+    - types-Deprecated
+    - types-PyYAML

.github/workflows/ci.yml

@@ -0,0 +1,115 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: True
+
+jobs:
+    test:
+        name: "Python ${{ matrix.python-version }} on ${{ matrix.os }}"
+        runs-on: ${{ matrix.os }}
+
+        strategy:
+            fail-fast: false
+            matrix:
+                include:
+                    - os: ubuntu-latest
+                      python-version: "3.7"
+                      envfile: ".github/environment-ci.yml"
+                      channel-priority: "strict"
+
+                    - os: ubuntu-latest
+                      python-version: "3.8"
+                      channel-priority: "strict"
+                      envfile: ".github/environment-ci.yml"
+
+                    - os: ubuntu-latest
+                      python-version: "3.9"
+                      channel-priority: "strict"
+                      envfile: ".github/environment-ci.yml"
+
+                    - os: ubuntu-latest
+                      python-version: "3.10"
+                      channel-priority: "strict"
+                      envfile: ".github/environment-ci.yml"
+
+                    - os: macos-latest
+                      python-version: "3.10"
+                      channel-priority: "strict"
+                      envfile: ".github/environment-ci.yml"
+
+        steps:
+        - uses: actions/checkout@v3
+          with:
+            submodules: true
+
+        - name: Install OS dependencies
+          shell: bash -l {0}
+          run: |
+            case "${{ runner.os }}" in
+            Linux)
+              sudo apt-get update -yy
+              sudo apt-get install -yy wget libsndfile-dev libsox-fmt-mp3 ffmpeg zip
+              ;; 
+            macOS)
+              brew install libsamplerate wget libsndfile sox ffmpeg zip
+              ;;
+            esac
+
+        - name: Cache conda
+          uses: actions/cache@v3
+          env:
+            CACHE_NUMBER: 2      
+          with:
+            path: ~/conda_pkgs_dir
+            key: ${{ runner.os }}-${{ matrix.python-version }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles( matrix.envfile ) }}
+            restore-keys: |
+              ${{ runner.os }}-${{ matrix.python-version }}-conda-${{ env.CACHE_NUMBER }}-
+              ${{ runner.os }}-${{ matrix.python-version }}-conda-
+              ${{ runner.os }}-conda-
+
+        - name: Setup conda
+          uses: conda-incubator/setup-miniconda@v2
+          with:
+            miniforge-variant: Mambaforge
+            miniforge-version: latest
+            use-mamba: true
+            channel-priority: ${{ matrix.channel-priority }}
+            activate-environment: test
+            auto-update-conda: false
+            python-version: ${{ matrix.python-version }}
+            use-only-tar-bz2: false
+
+        - name: Install conda dependencies
+          run: mamba env update -n test -f ${{ matrix.envfile }}
+          if: steps.cache.outputs.cache-hit != 'true'
+
+        - name: Conda info
+          shell: bash -l {0}
+          run: |
+            conda info -a
+            conda list
+
+        - name: Run pytest
+          shell: bash -l {0}
+          run: pytest -n auto -vv --cov-report term-missing --cov-report=xml --cov=mirdata tests
+
+        - name: Upload coverage to Codecov
+          uses: codecov/codecov-action@v3
+          with:
+            token: ${{ secrets.CODECOV_TOKEN }}
+            files: ./coverage.xml
+            directory: ./coverage/reports/
+            flags: unittests
+            env_vars: OS,PYTHON
+            name: codecov-umbrella
+            fail_ci_if_error: true
+            verbose: true

.github/workflows/formatting.yml

@@ -0,0 +1,25 @@
+name: Formatting
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: black on mirdata
+        uses: psf/black@stable
+        with:
+            options: "--check --verbose"
+            src: "mirdata"
+      - name: black on tests
+        uses: psf/black@stable
+        with:
+            options: "--check --verbose"
+            src: "tests"