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.

Sign up for GitHub

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

Jump to bottom

12 documentation page #33

Merged
merged 50 commits into from
Jan 9, 2025
Merged

12 documentation page #33

merged 50 commits into from
Jan 9, 2025

Conversation

rogerkuou
Copy link
Member

@rogerkuou rogerkuou commented Dec 20, 2024 •
edited
Loading

Fix #12 and #13

rogerkuou and others added 30 commits December 20, 2024 13:44
@rogerkuou
rebase to renaming depsi to pydepsi
078094f
@rogerkuou
Add docs for nad block function
e61dd36
@rogerkuou
add grapgh viz for dev dependency
cf44ab1
@rogerkuou
add option to persist computed variable
8c3b38d 
force no chunk in time
@rogerkuou
1. add nmad
d595b2e 
2. remove t_order and replace with dim="time"
@rogerkuou
drop multi index
cc1eb6d
@rogerkuou
add unit tests
fa68b35
@rogerkuou
update documentation
7f030ad
@rogerkuou
add example script
a35351b
@rogerkuou
update example script
3c4eb01
@rogerkuou
Apply suggestions from code review
71d334d
@rogerkuou
change input parameters
8c7441a
@rogerkuou
update example script with new from_ds command in sarxarray
9aef1f8
@rogerkuou
Update examples/scripts/script_ps_selection.py
1c30153
@rogerkuou
Conformed to ruff checks.
cb0af3b
@rogerkuou
Removed min_length argument from network.py
cadd27c
@rogerkuou
Renamed groups to partitions in network.py
5f5f96c
@rogerkuou
Renamed max_links argument to min_links in network.py
96d9c3a 
Also adjusted comments to reflect this change.
@rogerkuou
Replaced prints on invalid network argumants by logger messages.
be92083
@rogerkuou
Removed comment about possible shorter implementation.
f591ad4
@rogerkuou
Added coordinates return to generate_arcs docstring.
0b381a9
@rogerkuou
Added comment in get_distance to justify its existence.
67b4c9e
@rogerkuou
Renamed network.get_distance to _get_distance
ac3ea8b
@rogerkuou
based on Thijs's work, add unitest, merge chunks in the data file for…
4ab76d3 
… testing
@rogerkuou
Replaced network generation logging warnings by logging errors.
8c4dc1a
@rogerkuou
Updated GitHub action build
f3893f5
@rogerkuou
initial implementation of sparse subset
75cfe73
@rogerkuou
add tests classification
5435db7
@rogerkuou
remove screen print
87f3860
@rogerkuou
more unit test
9b31516
@rogerkuou
Copy link
Member Author

Hi @SarahAlidoost, as discussed I made a template doc page with mkdocs, adding a usage example for ifg_to_slc function. For now I mannually deployed the doc to the Github page. But in practice we would like this to be triggered by the GH action added in this PR.
Feel free to take a look after holiday. And have a nice one!

This was linked to issues Dec 23, 2024
documentation page #12
Closed
developer guide #13
Closed
SarahAlidoost
SarahAlidoost reviewed Jan 6, 2025
View reviewed changes
mkdocs.yml Outdated Show resolved Hide resolved
SarahAlidoost
SarahAlidoost reviewed Jan 6, 2025
View reviewed changes
mkdocs.yml Outdated Show resolved Hide resolved
SarahAlidoost
SarahAlidoost reviewed Jan 6, 2025
View reviewed changes
docs/api_reference.md Outdated Show resolved Hide resolved
SarahAlidoost
SarahAlidoost reviewed Jan 6, 2025
View reviewed changes
docs/api_reference.md Outdated Show resolved Hide resolved
SarahAlidoost
SarahAlidoost reviewed Jan 6, 2025
View reviewed changes
docs/api_reference.md Outdated Show resolved Hide resolved
SarahAlidoost
SarahAlidoost requested changes Jan 6, 2025
View reviewed changes
Copy link
Member

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

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

@rogerkuou thanks for adding the documentation. I could preview it locally and left some comments.

rogerkuou and others added 2 commits January 7, 2025 16:47
@rogerkuou
Copy link
Member Author

Hi @SarahAlidoost, thanks a lot for the review! I adapted your comments. Can you take another look?

SarahAlidoost
SarahAlidoost approved these changes Jan 8, 2025
View reviewed changes
Copy link
Member

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

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

@rogerkuou the changes looks good, thanks for addressing the comments.

@rogerkuou rogerkuou merged commit 67592c0 into main Jan 9, 2025
9 checks passed
@rogerkuou rogerkuou mentioned this pull request Jan 9, 2025
Merged
@rogerkuou rogerkuou deleted the 12_documentation_page branch January 10, 2025 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SarahAlidoost SarahAlidoost SarahAlidoost approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

developer guide documentation page
2 participants
@rogerkuou @SarahAlidoost