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

Ag3.x data access guide #55

Merged
merged 15 commits into from
Nov 17, 2023
Merged

Ag3.x data access guide #55

merged 15 commits into from
Nov 17, 2023

Conversation

ahernank
Copy link
Collaborator

@ahernank ahernank commented Mar 20, 2023

Include a single page that describes both the data cloud access and the downloads for Ag3.1

Note:

  • We still need to update malariagen_data to include the 3.1 release.
  • I have used wget and gsutil commands here to be consistent with the other guides in vector-data but in the PUG we use curl commands instead.
  • It would be good to link the study website page (when it is live) to this access guide.

For my local setup to work, I had to modify the environment to include:

  • jsonschema>=3 (this is included in the requirements to deploy but I also required it to solve the initial environment)
  • pip install nbconvert==5.6.1 (issue described here but solved by downgrading the version)
  • pip install jinja2==3.0.3 (issue described here)

As these seem to be local requirements, I have not changed any of the environment configurations to include these.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@ahernank
Copy link
Collaborator Author

cc @alimanfoo, @leehart

@ahernank
Copy link
Collaborator Author

ahernank commented Oct 12, 2023

This is the same version we looked at together a while ago, where we deprecate the analysis NBs in favour of the training course website examples.

@leehart @alimanfoo @cclarkson It would be great to know if you have any comments on the Ag3.1 Data Access guide here, as this will serve as template for the other .x release pages.

After these, I can include the rest of the guides on this PR, and then deal with Af on a separate one, as we currently do not have any Af references at all the user guide.

@ahernank
Copy link
Collaborator Author

ahernank commented Nov 9, 2023

Updated with the comments from our meeting, please let me know if there any other suggestions.

@leehart, I've also linked the new API docs to simplify the API section on the docs, please let me know if you'd like any changes here.

@ahernank ahernank changed the title Agv3.1 data access guide Ag3.x data access guide Nov 10, 2023
@alimanfoo
Copy link
Member

Hi @ahernank, just had a quick scan and noticed there is an ag3/ag3.0 page in the TOC but I didn't see a corresponding notebook file? Did I miss something?

@ahernank
Copy link
Collaborator Author

Thanks @alimanfoo, sorry. Fixed now, this file was just renamed from intro to ag3.0 to avoid confusion.

@ahernank
Copy link
Collaborator Author

I'll be merging this one shortly, unless there are any concerns but will keep an eye in case we need any edits after deploying the new version.

@ahernank ahernank merged commit c735fa9 into malariagen:master Nov 17, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants