Dataexample update

[hrobarts]

Changes

Use zenodo_get for the data download and validation

Testing you performed

Updated download_data tests

• Mock zip file when zenodo_get is called
• Create the mock zip file in the CIL data folder rather than tmp folder because we don't always have access to unzip files in the tmp folder

Related issues/links

depends on dvolgyes/zenodo_get#25

Checklist

• I have performed a self-review of my code
• I have added docstrings in line with the guidance in the developer guide
• I have updated the relevant documentation
• I have implemented unit tests that cover any new or modified functionality
• CHANGELOG.md has been updated with any functionality change
• Request review from all relevant developers
• Change pull request label to 'Waiting for review'

Contribution Notes

Please read and adhere to the developer guide and local patterns and conventions.

• The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in CIL (the Work) under the terms and conditions of the Apache-2.0 License
• I confirm that the contribution does not violate any intellectual property rights of third parties

[lauramurgatroyd]

It looks good, I have just suggested some changes to docs and I think the unit tests could be expanded a bit.

I think it would be nice to add further documentation with examples of how to use it. I just tested trying to get the walnut data locally.

I was expecting to be able to do dataexample.WALNUT.get but I think that was wrong - I had to use dataexample.WALNUT.download_data

[hrobarts]

It looks good, I have just suggested some changes to docs and I think the unit tests could be expanded a bit.

I think it would be nice to add further documentation with examples of how to use it. I just tested trying to get the walnut data locally.

I was expecting to be able to do dataexample.WALNUT.get but I think that was wrong - I had to use dataexample.WALNUT.download_data

Thank you for the review Laura! You can just use dataexample.WALNUT.get(data_dir) if the data is already in data_dir but otherwise you have to use dataexample.WALNUT.download_data we decided it's best to be really explicit if we're downloading large datasets to the users computer. I agree this is not super clear so I will add some examples.

[lauramurgatroyd]

It looks good, I have just suggested some changes to docs and I think the unit tests could be expanded a bit.
I think it would be nice to add further documentation with examples of how to use it. I just tested trying to get the walnut data locally.
I was expecting to be able to do dataexample.WALNUT.get but I think that was wrong - I had to use dataexample.WALNUT.download_data

Thank you for the review Laura! You can just use dataexample.WALNUT.get(data_dir) if the data is already in data_dir but otherwise you have to use dataexample.WALNUT.download_data we decided it's best to be really explicit if we're downloading large datasets to the users computer. I agree this is not super clear so I will add some examples.

Ok, that makes sense, but yes examples would be great!

[hrobarts]

I've updated the docs to describe what the remote datasets are and how to use them:

Also removed the test checking if the zenodo record exists.