Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Data download script #60

Open
1 of 4 tasks
shanemcq18 opened this issue May 22, 2024 · 1 comment
Open
1 of 4 tasks

Data download script #60

shanemcq18 opened this issue May 22, 2024 · 1 comment
Labels
documentation Changes to or problems with the package documenation

Comments

@shanemcq18
Copy link
Member

shanemcq18 commented May 22, 2024

Data files used in the examples live on the data branch. We should have a script in the docs/ folder that downloads the data and puts it in the correct place so that the tutorials can be executed locally. This will also enable testing the documentation compilation through GitHub Actions (we had an action previously but it would pass even if a notebook cell failed to execute).

TODO:

  • Write the script
  • Update contributor guidelines
  • Remove .pre-commit.yaml from the data branch?
  • Reinstate GitHub Action for checking that the documentation compiles (there is also a LaTeX issue with plot labels, fix this too)
@shanemcq18 shanemcq18 added the documentation Changes to or problems with the package documenation label May 22, 2024
@shanemcq18
Copy link
Member Author

.pre-commit.yaml removed from data branch in 463a19c.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes to or problems with the package documenation
Development

No branches or pull requests

1 participant