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

Argo #2

Merged
merged 30 commits into from
Dec 15, 2023
Merged

Argo #2

merged 30 commits into from
Dec 15, 2023

Conversation

Theodore-Chatziioannou
Copy link
Contributor

@Theodore-Chatziioannou Theodore-Chatziioannou commented Dec 13, 2023

Initial commit of the gtfs_skims (or argo) library.

Checklist

Any checks which are not relevant to the PR can be pre-checked by the PR creator.
All others should be checked by the reviewer(s).
You can add extra checklist items here if required by the PR.

  • CHANGELOG updated
  • Tests added to cover contribution
  • Documentation updated

@brynpickering
Copy link
Collaborator

What does ARGO stand for?

Copy link
Collaborator

@brynpickering brynpickering left a comment

Choose a reason for hiding this comment

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

Looks really good - Glad to see you're following the template structure and documenting+testing as you go along.

My comments are mostly minor details about design choice, some of which you can happily ignore if you wish.

I think this repo would benefit from a YAML schema to go along with the config file. This ensures that the config file is correctly structured (including data types etc) and can even be rendered in the documentation so that users can read what the parameters are.

You can find an example YAML schema here: https://github.com/calliope-project/euro-calliope/blob/develop/config/schema.yaml and here: https://github.com/calliope-project/calliope/blob/main/src/calliope/config/math_schema.yaml

And process to render it in the docs, e.g.: https://github.com/calliope-project/euro-calliope/blob/develop/lib/eurocalliopelib/docs/schema.py

I can help on that in a later PR if it helps (would be good to have an example to then use in other repos with config files)

docs/index.md Outdated Show resolved Hide resolved
gtfs_skims/cli.py Outdated Show resolved Hide resolved
gtfs_skims/cli.py Outdated Show resolved Hide resolved
gtfs_skims/connectors.py Outdated Show resolved Hide resolved
gtfs_skims/connectors.py Show resolved Hide resolved
gtfs_skims/utils.py Outdated Show resolved Hide resolved
gtfs_skims/variables.py Show resolved Hide resolved
requirements/base.txt Show resolved Hide resolved
tests/__init__.py Outdated Show resolved Hide resolved
tests/test_data/outputs/calendar.parquet.gzip Outdated Show resolved Hide resolved
Theodore.Chatziioannou added 2 commits December 15, 2023 09:16
@Theodore-Chatziioannou
Copy link
Contributor Author

@brynpickering I like the idea of writing a config schema as a separate PR. If you are happy with the updates, let's merge this PR and I will open another.

@brynpickering
Copy link
Collaborator

@Theodore-Chatziioannou I tested locally and came across an issue I've had in GeNet (see arup-group/genet#213). It's related to SSL certs that seems to be a bug. The fix suppresses PROJ's attempt to make a network connection and will likely circumvent other people within the org coming across a similar issue when running it locally.

@Theodore-Chatziioannou
Copy link
Contributor Author

@neilmt @val-ismaili I am merging this, but it would be good to capture any domain/user feedback separately. Please add any such feedback as github issues.

@Theodore-Chatziioannou Theodore-Chatziioannou merged commit 3dd9368 into main Dec 15, 2023
9 checks passed
@brynpickering brynpickering mentioned this pull request Dec 15, 2023
3 tasks
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