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

Gantt chart: misc fixes and documentation #363

Merged
merged 8 commits into from
Jan 10, 2024
Merged
Changes from 1 commit
Commits
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
sappelhoff committed Jan 10, 2024
commit 5684a3aeb98e12115e44b0234b6eaaf3097327eb
11 changes: 11 additions & 0 deletions tools/README.md
Original file line number Diff line number Diff line change
@@ -17,3 +17,14 @@ This README file describes the tools under the `/tools` directory of the bids-we
1. Clean up, check the newly added files, commit

## Update the Gantt chart of completed BEPs

There are two ways of creating Gantt charts for a BIDS timeline.
First install all Python requirements under `tools/requirements.txt`.
Then, use one of the following two methods:

1. `python -u tools/bep_gantt_html_create` creates a file: `_pages/bids_timeline.html` that you can inspect in your browser.
This file depends on the `tools/timeline.csv` data, which you should keep up to date.
1. `python -u tools/bep_gantt_mermaid_insert` directly inserts code for a "mermaid" Gantt chart into the Get Involved page of the website.
You can inspect how that chart looks by building the website using Jekyll and serving locally.
This code depends on data from the files `beps_completed.yml` files in the `_data` directory.
You should keep that file up to date.