Skip to content

Update documentation#165

Open
christopherwharrop-noaa wants to merge 33 commits intomainfrom
feature/update-docs
Open

Update documentation#165
christopherwharrop-noaa wants to merge 33 commits intomainfrom
feature/update-docs

Conversation

@christopherwharrop-noaa
Copy link
Collaborator

@christopherwharrop-noaa christopherwharrop-noaa commented Mar 1, 2026

This updates the documentation to a complete first draft. It also updates the licensing for the repository and provides an initial Conda recipe for uploading to conda-forge. Some API changes were also made when creating the documentation exposed some problems. Closes #111

@christopherwharrop-noaa christopherwharrop-noaa changed the title Update pyproject.toml in preparation for pypi packaging Update documentation Mar 1, 2026
@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status: ⚠️ UNKNOWN (Coverage: N/A% | Threshold: 100%)

❌ Coverage report not available


Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

1 similar comment
@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status: ⚠️ UNKNOWN (Coverage: N/A% | Threshold: 100%)

❌ Coverage report not available


Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

1 similar comment
@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 3, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 3, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

2 similar comments
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 41 to 45
"test-local": {
"provider": "localhost",
"cores_per_node": 1,
"max_workers_per_node": 1,
"cores_per_node": 2,
"max_workers_per_node": 2,
"environment": [f"export PYTHONPATH=${{PYTHONPATH}}:{project_root}"],
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

The test configuration hard-codes 2 cores/workers for the localhost provider. This can make the test suite fail or behave unexpectedly on constrained runners (e.g., single-core CI/dev containers). Consider deriving these values from os.cpu_count() (e.g., min(2, cpu_count)), or keep the default at 1 and only request 2 workers in the specific test that needs concurrency.

Copilot uses AI. Check for mistakes.
Comment on lines 66 to 76
@python_task
def transfer_task(
src_ep: str,
dst_ep: str,
src_path: str,
dst_path: str,
timeout: int = 3600,
polling_interval: int = 30,
client: Optional[TransferClient] = None,
recursive: bool = False,
dependencies: Optional[Future] = None,
):
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

transfer_task and delete_task removed the previously documented dependencies parameter. If this was part of the public API, callers will now get a TypeError when passing dependencies=. Consider keeping dependencies as a deprecated alias that maps to Parsl's inputs (or at least raising a clearer error message guiding users to inputs=[...]).

Copilot uses AI. Check for mistakes.
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.

Transition to readthedocs

2 participants