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

Polish documentation for version 1 #79

Merged
merged 59 commits into from
Jan 9, 2025
Merged
Changes from 1 commit
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
23f3077
Merge branch 'master' into v1.0.0-docs
stella-bourdin Nov 25, 2024
625eabe
Update package flowchart
stella-bourdin Nov 25, 2024
a39b464
Update user guide landing page
stella-bourdin Nov 25, 2024
d90de7f
Add label for cross-referencing
stella-bourdin Nov 25, 2024
da7dced
Modify main title
stella-bourdin Nov 25, 2024
5ffd8f7
Remove user guide pages for module where a link to API is dufficient
stella-bourdin Nov 25, 2024
f3d53d5
Remove interpolation user guide page
stella-bourdin Nov 25, 2024
df06be5
Remove TC user guide page
stella-bourdin Nov 25, 2024
5328cde
Remove accesor user guide page
stella-bourdin Nov 25, 2024
39fc44d
Merge pull request #69 from stella-bourdin/v1.0.0-docs
stella-bourdin Nov 25, 2024
7daa390
Update docstring
stella-bourdin Nov 26, 2024
1589600
Update trackwhere docstring
stella-bourdin Nov 26, 2024
1bf0002
update docstrings
stella-bourdin Nov 26, 2024
c8dc061
Update season docstring
stella-bourdin Nov 26, 2024
d52e21e
Update density dicstring
stella-bourdin Nov 26, 2024
36920c7
Update track stats docstring
stella-bourdin Nov 26, 2024
c53188e
Update docstrings
stella-bourdin Nov 26, 2024
7ad4b0e
Update docstrings
stella-bourdin Nov 26, 2024
2a1d926
Merge pull request #71 from stella-bourdin/v1.0.0-docs
stella-bourdin Nov 26, 2024
d2d73c3
Fix docstrings for decorated functions
leosaffin Nov 26, 2024
274667c
Show subheadings in right sidebar
leosaffin Nov 26, 2024
9cc3c53
Add a changelog
leosaffin Nov 26, 2024
864fc0a
Add sel_id to subset instructions and reduce cell outputs
leosaffin Nov 26, 2024
6b5f986
Add example of track tilt file and gathering vorticity profile from t…
leosaffin Nov 26, 2024
d3a730b
Update dev guide
leosaffin Nov 27, 2024
e49461c
Simplify Readme and move duplicated getting_started guide to ipynb
leosaffin Nov 27, 2024
938fcde
Add ERA20C NATL tracks in examples
stella-bourdin Nov 29, 2024
efc1d6f
Make ERA20C example file link
stella-bourdin Nov 29, 2024
932a191
Update ERA20C example and make runnable
stella-bourdin Nov 29, 2024
a4ced9a
Merge pull request #72 from stella-bourdin/v1.0.0-docs
stella-bourdin Nov 29, 2024
51a6732
Add load function for WiTrack
leosaffin Nov 26, 2024
bf8351b
Add example WiTRACK file and include in tests
leosaffin Dec 6, 2024
29f04d6
Add boxes from Sainsbury 2022 papers as alternative conventions for i…
leosaffin Dec 6, 2024
75168b1
Add documentation of extra "basins" to info.basin
leosaffin Dec 6, 2024
14993dd
Fix accessor pb by removing .copy() in init
stella-bourdin Dec 9, 2024
3ad97ce
Add simple RMW function
stella-bourdin Dec 12, 2024
ebdfdea
Implement beta drift function
stella-bourdin Dec 12, 2024
850f80d
Update init
stella-bourdin Dec 12, 2024
9d77317
Prevent beta_Drift from changing RMW in place
stella-bourdin Dec 12, 2024
4442285
Add beta drift example
stella-bourdin Dec 12, 2024
81b2578
Add RMW figure
stella-bourdin Dec 12, 2024
cb36868
Add RMW test
stella-bourdin Dec 12, 2024
8afa6fe
Add beta_drift test
stella-bourdin Dec 12, 2024
4d53cef
Update landing page
stella-bourdin Jan 6, 2025
d292e53
Add logo
stella-bourdin Jan 6, 2025
0cf8f21
Update examples
stella-bourdin Jan 6, 2025
772614b
Update gitignore to ignore pptx temp files
stella-bourdin Jan 6, 2025
b806b18
Update logo and landing page
stella-bourdin Jan 6, 2025
7d23832
Move logo to images
stella-bourdin Jan 6, 2025
c1fa1ba
Replace upper left handle with logo
stella-bourdin Jan 6, 2025
8fcd15a
Update User guide
stella-bourdin Jan 6, 2025
134c7b6
Reupload demo.ipynb
stella-bourdin Jan 6, 2025
ca0e6a0
Update documentation
stella-bourdin Jan 6, 2025
02b5241
Merge pull request #78 from stella-bourdin/docs
stella-bourdin Jan 6, 2025
b10b2ee
Merge branch 'master' into v1-doc
stella-bourdin Jan 9, 2025
0d0d6dd
Make formatting fixes
stella-bourdin Jan 9, 2025
c9a5a5d
Merge pull request #80 from stella-bourdin/docs
stella-bourdin Jan 9, 2025
16c2fd6
ruff format
stella-bourdin Jan 9, 2025
891c919
Merge pull request #81 from stella-bourdin/docs
stella-bourdin Jan 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add documentation of extra "basins" to info.basin
leosaffin authored and stella-bourdin committed Jan 6, 2025
commit 75168b11e8afcb12072ea3412143fa084c797e43
18 changes: 16 additions & 2 deletions huracanpy/info/_geography.py
Original file line number Diff line number Diff line change
@@ -48,8 +48,22 @@ def basin(lon, lat, convention="WMO-TC", crs=None):
lat : xarray.DataArray
Latitude series
convention : str
Name of the basin convention you want to use
* WMO
Name of the basin convention you want to use.
* **WMO-TC** - WMO defined tropical cyclone basins
* **Sainsbury2022JCLI** - Definitions from
(https://doi.org/10.1175/JCLI-D-21-0712.1) North Atlantic split up into:

* Main development region (MDR)
* Subtropical development region (SUB)
* Western basin / Caribbean sea (WEST)

* **Sainsbury2022MWR** - Definitions from
(https://doi.org/10.1175/MWR-D-22-0111.1). Extratropical transition in
North Atlantic divided into:

* Europe
* NoEurope

crs : cartopy.crs.CRS, optional
The coordinate reference system of the lon, lat inputs. The basins are defined
in PlateCarree (-180, 180), so this will transform lon/lat to this projection