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

Split doc #279

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Split doc #279

wants to merge 18 commits into from

Conversation

juliettelavoie
Copy link
Contributor

@juliettelavoie juliettelavoie commented Nov 20, 2024

Pull Request Checklist:

What kind of change does this PR introduce?

  • Creates directory datasets with the data for plot hatch map that was too long to calculate on the fly
  • Splits Getting started and Colours of Figanos in 3 new notebooks to increase speed of RtD.
  • Change default projection to LambertConformal
  • Fix bug in projection for scattermap
  • Create gallery wall

Does this PR introduce a breaking change?

New default projection

Other information:

  1. I name the new directory datasets because data already exist with info for the colours.
  2. I only put the problematic data there. Let me know if I should put more.
  3. Let me know if there are some examples that I left out of the Gallery walll that you would want me to add.
  4. If you know a way to hide the last line a cell, let me know. I would prefer to hide the plt.savefig but I haven't been able to make it work.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Zeitsperre
Copy link
Contributor

@juliettelavoie

This is looking great!

The docs are failing for an unrelated reason (lack of a UserAgent in our request calls). The fix needs to be determined first before we can build docs on RTD. Don't spend time on that.

Copy link
Collaborator

@sarahclaude sarahclaude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks Juliette

Copy link
Contributor

@Zeitsperre Zeitsperre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new documentation with gallery looks incredible! Well done!

I'm wondering though what the problem is with having a /data in the top-level here. Is there some function that already creates this folder on install?

docs/notebooks/figanos_misc.ipynb Outdated Show resolved Hide resolved
docs/notebooks/figanos_maps.ipynb Outdated Show resolved Hide resolved
Comment on lines 401 to 405
"\n",
"ens_stats = xr.open_dataset('../../datasets/hatchmap-ens_stats.nc').prcptot_mean\n",
"sup_8 = xr.open_dataset('../../datasets/hatchmap-sup_8.nc').changed\n",
"inf_5 = xr.open_dataset('../../datasets/hatchmap-inf_5.nc').changed\n",
"\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There will be a new functionality in xclim to better support fetching datasets from other repositories and caching them as needed.

Seeing as xclim is required to build the docs, I don't see the value in creating a testdata fetching mechanism specific to figanos.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure I understand the comment ?

@juliettelavoie
Copy link
Contributor Author

The new documentation with gallery looks incredible! Well done!

I'm wondering though what the problem is with having a /data in the top-level here. Is there some function that already creates this folder on install?

There is already a data folder in src/figanos that has other types of data (IPCC colormaps). I thought it would lead to mix ups if they were named the same thing even if they are not at the same level.

@juliettelavoie
Copy link
Contributor Author

@Zeitsperre I added the test dat in data as we discussed. I will let you change the config for pooch. After that I just use fetch to access it ?

@Zeitsperre
Copy link
Contributor

@juliettelavoie Yes, exactly. I'll set things up so that the testing data is only fetched when running the notebooks and skipped on installation. Thanks again for your patience!

@github-actions github-actions bot added the CI Continuous Integration label Nov 21, 2024
@juliettelavoie
Copy link
Contributor Author

maybe time to come back to the "if it ain't broke" method :P

@Zeitsperre
Copy link
Contributor

@juliettelavoie I wish there was an emoji for this:

image

@@ -0,0 +1,493 @@
{
Copy link
Contributor Author

@juliettelavoie juliettelavoie Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On dirait le que le metadata  "nbsphinx": "hidden" pour cacher cette cellule dans RtD a été enlevé


Reply via ReviewNB

@@ -0,0 +1,493 @@
{
Copy link
Contributor Author

@juliettelavoie juliettelavoie Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line #45.    # plt.savefig("images/station_map.png", bbox_inches='tight')

mais les images ne sont pas save dans images mais dans _static/_gallery, non ?


Reply via ReviewNB

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

which is the default projection ?
3 participants