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

initial documentation #63

Merged
merged 11 commits into from
Nov 12, 2024
Merged

initial documentation #63

merged 11 commits into from
Nov 12, 2024

Conversation

Hussein-Mahfouz
Copy link
Collaborator

Start on #62

@Hussein-Mahfouz Hussein-Mahfouz linked an issue Oct 31, 2024 that may be closed by this pull request
14 tasks
@sgreenbury sgreenbury mentioned this pull request Nov 7, 2024
- We use the `National Travel Survey, 2002-2023` dataset (SN: 5340)
- Step 3: Download TAB file format

`travel_times/`
Copy link
Collaborator

Choose a reason for hiding this comment

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

As discussed, add information on dataframe structure (i.e. expected columns)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done in 2ca4d10

- oa_england.geojson
- study_area_zones.geojson

`centroids/`
Copy link
Collaborator

Choose a reason for hiding this comment

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

As discussed, add data source

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done in 2ca4d10

```
and replace `west-yorkshire` and `2020` with your preferred option.

`boundaries/`
Copy link
Collaborator

Choose a reason for hiding this comment

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

As discussed, add data source

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done in 2ca4d10

│   ├── interim
│   │   ├── assigning (Generated in Script 3)
│   │   └── matching (Generated in Script 2)
│   └── processed
Copy link
Collaborator

@sgreenbury sgreenbury Nov 8, 2024

Choose a reason for hiding this comment

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

As discussed, I'll aim to update the notebooks and scripts to read/output files to match this structure (#53)

@Hussein-Mahfouz
Copy link
Collaborator Author

I've updated the config/README and the data/external/README. This is ready to merge after implementation of #53. I will merge it Tuesday so that it is ready before the presentation

@Hussein-Mahfouz
Copy link
Collaborator Author

Merging now, #53 can be in a different PR

@Hussein-Mahfouz Hussein-Mahfouz merged commit 4b4f553 into main Nov 12, 2024
4 checks passed
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.

Documentation for repo
2 participants